Module handling the normalisation of the electric wave field. More...

Public Member Functions
subroutine	destructor_RFOF_Efield_update
	Destructor for allocated variables in the module.
subroutine	update_efield_normalisation (dt, wave, MPI_node_Id, ierr, RFpower, diagno)
	Update normalisation of the amplitude of the RF wave fields: waveEnormalisationFactor.
subroutine	RFOF_merge_absorption_diagno_from_mpi_nodes (diagno, ierr)
	If running with MPI: merge power absorption information from all MPI nodes. If not running with MPI: do nothing.
subroutine	RFOF_merge_power_absorption_diagno_from_mpi_nodes (pabs, pabs2, count, ierr)
	If running with MPI: merge power absorption information from all MPI nodes. If not running with MPI: do nothing.
subroutine	RFOF_mpi_reduce_and_bcast_2d_wp (data, rfof_mpi_root, ier)
	Merges data from all mpi nodes using first an mpi_reduce and then an mpi_bcast.
subroutine	RFOF_mpi_reduce_and_bcast_0d_wp (data, rfof_mpi_root, ier)
	Merges data from all mpi nodes using first an mpi_reduce and then an mpi_bcast.
subroutine	RFOF_mpi_reduce_and_bcast_0d_int (data, rfof_mpi_root, ier)
	Merges data from all mpi nodes using first an mpi_reduce and then an mpi_bcast.
subroutine	RFOF_mpi_reduce_and_bcast_2d_int (data, rfof_mpi_root, ier)
	Merges data from all mpi nodes using first an mpi_reduce and then an mpi_bcast.
subroutine	enorm_stats_test
Public Attributes
real(8), dimension(:,:), allocatable	recvbuf
integer, dimension(:,:), allocatable	recvbuf_int2d

Detailed Description

Module handling the normalisation of the electric wave field.

Author:: T. Johnson

Date:: 2011.04.20

Todo:: output E-field normalisation to file

Version:: "$Id: RFOF_Efield_update.F90 188 2011-09-12 11:50:22Z tjohnson $"

Definition at line 14 of file RFOF_Efield_update.F90.

Member Function/Subroutine Documentation

subroutine RFOF_Efield_update::destructor_RFOF_Efield_update ( )

Destructor for allocated variables in the module.

Definition at line 30 of file RFOF_Efield_update.F90.

subroutine RFOF_Efield_update::update_efield_normalisation	(	real(8), intent(in)	dt,
		type(rf_wave_global), intent(inout)	wave,
		integer, intent(in)	MPI_node_Id,
		integer, intent(out)	ierr,
		real(8), dimension(:,:), intent(in), optional	RFpower,
		type(RFOF_cumlative_diagnostics), intent(inout), optional	diagno
	)

Update normalisation of the amplitude of the RF wave fields: waveEnormalisationFactor.

Input:

Parameters:

RFpower - RF power obtained with present (at time of input) E-field normalisation

Input/Output:

Parameters:

wave	- RF wave field structure, including the E-field normalisation

Definition at line 54 of file RFOF_Efield_update.F90.

subroutine RFOF_Efield_update::RFOF_merge_absorption_diagno_from_mpi_nodes	(	type(RFOF_cumlative_diagnostics), intent(inout)	diagno,
		integer, intent(out)	ierr
	)

If running with MPI: merge power absorption information from all MPI nodes. If not running with MPI: do nothing.

Input/Output:

Parameters:

diagno Diagnostic information; including power absorption

Input:

Parameters:

mpi_id MPI node index/identifier

Output:

Parameters:

ierr	Error flag

Todo:: Handle errors!!

Definition at line 225 of file RFOF_Efield_update.F90.

subroutine RFOF_Efield_update::RFOF_merge_power_absorption_diagno_from_mpi_nodes	(	real(8), dimension(:,:), intent(inout)	pabs,
		real(8), dimension(:,:), intent(inout)	pabs2,
		integer, dimension(:,:), intent(inout)	count,
		integer, intent(out)	ierr
	)

If running with MPI: merge power absorption information from all MPI nodes. If not running with MPI: do nothing.

Input/Output:

Parameters:

pabs	Absorbed power summed over all markers
pabs	Square of the absorbed energy summed over all markers, and then divided by the integration time

Output:

Parameters:

ierr	Error flag

Todo:: Handle errors!!

Definition at line 272 of file RFOF_Efield_update.F90.

subroutine RFOF_Efield_update::RFOF_mpi_reduce_and_bcast_2d_wp	(	real(8), dimension(:,:), intent(inout)	data,
		integer, intent(in)	rfof_mpi_root,
		integer, intent(out)	ier
	)

Merges data from all mpi nodes using first an mpi_reduce and then an mpi_bcast.

Parameters:

data	Matrix of real elements
rfof_mpi_root	The MPI node which acts like a root; to which the data is collected during mpi_reduce and to which the data is broadcasted during mpi_bcast
ier	Interger error flag

Definition at line 307 of file RFOF_Efield_update.F90.

subroutine RFOF_Efield_update::RFOF_mpi_reduce_and_bcast_0d_wp	(	real(8), intent(inout)	data,
		integer, intent(in)	rfof_mpi_root,
		integer, intent(out)	ier
	)

Merges data from all mpi nodes using first an mpi_reduce and then an mpi_bcast.

Parameters:

data	Scalar real elements
rfof_mpi_root	The MPI node which acts like a root; to which the data is collected during mpi_reduce and to which the data is broadcasted during mpi_bcast
ier	Interger error flag

Definition at line 349 of file RFOF_Efield_update.F90.

subroutine RFOF_Efield_update::RFOF_mpi_reduce_and_bcast_0d_int	(	integer, intent(inout)	data,
		integer, intent(in)	rfof_mpi_root,
		integer, intent(out)	ier
	)

Merges data from all mpi nodes using first an mpi_reduce and then an mpi_bcast.

Parameters:

data	Scalar integer elements
rfof_mpi_root	The MPI node which acts like a root; to which the data is collected during mpi_reduce and to which the data is broadcasted during mpi_bcast
ier	Interger error flag

Definition at line 388 of file RFOF_Efield_update.F90.

subroutine RFOF_Efield_update::RFOF_mpi_reduce_and_bcast_2d_int	(	integer, dimension(:,:), intent(inout)	data,
		integer, intent(in)	rfof_mpi_root,
		integer, intent(out)	ier
	)

Merges data from all mpi nodes using first an mpi_reduce and then an mpi_bcast.

Parameters:

data	Scalar integer elements
rfof_mpi_root	The MPI node which acts like a root; to which the data is collected during mpi_reduce and to which the data is broadcasted during mpi_bcast
ier	Interger error flag

Definition at line 426 of file RFOF_Efield_update.F90.

subroutine RFOF_Efield_update::enorm_stats_test ( )

Definition at line 462 of file RFOF_Efield_update.F90.

Member Data Documentation

real(8), dimension(:,:), allocatable RFOF_Efield_update::recvbuf

Definition at line 22 of file RFOF_Efield_update.F90.

integer, dimension(:,:), allocatable RFOF_Efield_update::recvbuf_int2d

Definition at line 23 of file RFOF_Efield_update.F90.

The documentation for this module was generated from the following file:

RFOF_Efield_update.F90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

Member Data Documentation