Module handling collection and storage of diagnostics in RFOF. More...

Data Types
type	RFOF_cumlative_diagnostics
	Structure including all parameter defining the state of the time-integrated diagnostics in RFOF. More...
Public Member Functions
subroutine	contructor_RFOF_cumlative_diagnostics (diagno, nfreq, nnphi)
subroutine	destructor_RFOF_cumlative_diagnostics (diagno)
	Deallocate memory for diagnostics.
subroutine	read_diagnostic_parameters_from_namelist_file ()
	Read diagnostic parameters from namelist file.
subroutine	reset_to_zero_RFOF_cumlative_diagnostics (diagno)
	Deallocate memory for diagnostics.
subroutine	add_kick_info_to_diagnostics (diagno, marker, mem, jfreq, jnphi, dE, dPphi, RFop1, RFop2, RFopType, MPI_node_Id)
	INPUT/OUTPUT:
subroutine	store2file_RFOF_cumlative_diagnostics (diagno, RFglobal)
	Store time accumulated diagnostics to file.
subroutine	store2file_RFOF_orbit_info (marker, time, timestep, MPI_node_Id)
	Deallocate memory for diagnostics.
subroutine	save2file_RFOF_efield_normalization (time, Pabs, wave, MPI_node_Id)
	Deallocate memory for diagnostics.
subroutine	save2file_resonace_predictions (time, R, phi, z, omega_res, nharm, time_at_resonance, R_at_resonance, phi_at_resonance, z_at_resonance, Dot_omega_res, DotDot_omega_res, MPI_node_Id)
	subroutine save2file_resonace_predictions
subroutine	save2file_rf_kicks (marker, mem, jfreq, jnphi, dE, dPphi, RFop1, RFop2, RFopType, MPI_node_Id)
	subroutine save2file_rf_kicks
subroutine	store2file_orbit_event (no_points, MAX_no_points, filename, calling_routine_name, data_description, list_variable_names, data, io_channel)
	subroutine store2file_orbit_event(diagno)

Detailed Description

Module handling collection and storage of diagnostics in RFOF.

Author:: T. Johnson

Date:: 2010.09.02

Version:: "$Id: RFOF_diagnostics.F90 211 2011-09-26 16:48:30Z tjohnson $"

Todo:: Separate the estimate of the total power absorption used in the E-field normalisation, which should be set to zero at every renormalisation of the E-field, and the time-cumlative diagnostics.

Todo:: What should the bounding bosx be used for, only checking if points are realistic, or should it also be used for the diagnostic grid.

Todo:: Add 2D grid as part of input-namelist

Todo:: Rebuild input to be come in one single structure, e.g. RFOF_struct

Todo:: Write alternative resonance condition routines that old checks if the particle has crossed the resonance (no extrapolation to the upcoming resonace)

Todo:: Test if the available techniques are quick enough?

Todo:: Feed suggested

Todo:: Read namelist in contructor_RFOF_cumlative_diagnostics

Definition at line 32 of file RFOF_diagnostics.F90.

Member Function/Subroutine Documentation

subroutine RFOF_diagnostics::contructor_RFOF_cumlative_diagnostics	(	type(RFOF_cumlative_diagnostics), intent(inout)	diagno,
		integer, intent(in)	nfreq,
		integer, intent(in)	nnphi
	)

Todo:

RZ-boundaing box as input

rho-theta diagnostics - box interpolation for speed

rho diagnostics - take grid from ASCOT

INPUT:

Parameters:

nfreq	Number of frequencies; space should be allocated for storing diagnostics output each frequency separately.
nnphi	Number of toroidal modes; space should be allocated for storing diagnostics output each toroidal mode separately.

INPUT/OUTPUT:

Parameters:

diagno Diagnostics structure

Definition at line 109 of file RFOF_diagnostics.F90.

subroutine RFOF_diagnostics::destructor_RFOF_cumlative_diagnostics ( type(RFOF_cumlative_diagnostics), intent(inout) diagno )

Deallocate memory for diagnostics.

INPUT/OUTPUT:

Parameters:

diagno Diagnostics structure

Definition at line 172 of file RFOF_diagnostics.F90.

subroutine RFOF_diagnostics::read_diagnostic_parameters_from_namelist_file ( )

Read diagnostic parameters from namelist file.

Definition at line 217 of file RFOF_diagnostics.F90.

subroutine RFOF_diagnostics::reset_to_zero_RFOF_cumlative_diagnostics ( type(RFOF_cumlative_diagnostics), intent(inout) diagno )

Deallocate memory for diagnostics.

INPUT/OUTPUT:

Parameters:

diagno Diagnostics structure

Definition at line 244 of file RFOF_diagnostics.F90.

subroutine RFOF_diagnostics::add_kick_info_to_diagnostics	(	type(RFOF_cumlative_diagnostics), intent(inout)	diagno,
		type(particle), intent(inout)	marker,
		type(resonance_memory), intent(in)	mem,
		integer, intent(in)	jfreq,
		integer, intent(in)	jnphi,
		real(8), intent(in)	dE,
		real(8), intent(in)	dPphi,
		real(8), intent(in)	RFop1,
		real(8), intent(in)	RFop2,
		character(128), intent(in)	RFopType,
		integer, intent(in)	MPI_node_Id
	)

INPUT/OUTPUT:

Parameters:

diagno Diagnostics structure

INPUT:

Parameters:

marker	Monte Carlo test particle marker
mem	The resonance memory
jfreq	Wave mode index determining the frequency of the mode.
jnphi	Wave mode index determining the toroidal mode number of the mode.
dE	Kick in $P_\phi$ .
dPphi	Kick in $P_\phi$ .
RFop1	First RF coefficient; definition depend on RFopType.
RFop2	Second RF coefficient; definition depend on RFopType.
RFopType	Type of RF operator used (time-accelerated/single_pass)
MPI_node_Id	Id number for the MPI nod (used for printing to unique files)

Definition at line 289 of file RFOF_diagnostics.F90.

subroutine RFOF_diagnostics::store2file_RFOF_cumlative_diagnostics	(	type(RFOF_cumlative_diagnostics), intent(in)	diagno,
		type(rf_wave_global), intent(in)	RFglobal
	)

Store time accumulated diagnostics to file.

INPUT/OUTPUT:

Parameters:

diagno	Diagnostics structure
RFglobal	Global RF waves field

Definition at line 381 of file RFOF_diagnostics.F90.

subroutine RFOF_diagnostics::store2file_RFOF_orbit_info	(	type(particle), intent(in)	marker,
		real(8), intent(in)	time,
		real(8), intent(in)	timestep,
		integer, intent(in)	MPI_node_Id
	)

Deallocate memory for diagnostics.

INPUT:

Parameters:

marker	(in) Monte Carlo test particle marker
time	(in) Simulation time at which the orbit-info is stored
timestep	(in) Length of time step
MPI_node_Id	(in) Number used to identify MPI nods during parallel execusion.

Definition at line 493 of file RFOF_diagnostics.F90.

subroutine RFOF_diagnostics::save2file_RFOF_efield_normalization	(	real(8), intent(in)	time,
		real(8), dimension(:,:), intent(in)	Pabs,
		type(rf_wave_global), intent(in)	wave,
		integer, intent(in)	MPI_node_Id
	)

Deallocate memory for diagnostics.

INPUT:

Parameters:

marker	(in) Monte Carlo test particle marker
time	(in) Simulation time at which the orbit-info is stored
timestep	(in) Length of time step
MPI_node_Id	(in) Number used to identify MPI nods during parallel execusion.

Definition at line 574 of file RFOF_diagnostics.F90.

subroutine RFOF_diagnostics::save2file_resonace_predictions	(	real(8), intent(in)	time,
		real(8), intent(in)	R,
		real(8), intent(in)	phi,
		real(8), intent(in)	z,
		real(8), intent(in)	omega_res,
		integer, intent(in)	nharm,
		real(8), intent(in)	time_at_resonance,
		real(8), intent(in)	R_at_resonance,
		real(8), intent(in)	phi_at_resonance,
		real(8), intent(in)	z_at_resonance,
		real(8), intent(in)	Dot_omega_res,
		real(8), intent(in)	DotDot_omega_res,
		integer, intent(in)	MPI_node_Id
	)

subroutine save2file_resonace_predictions

Store resonance predictions for each point along the orbit. Output stored in file out.resonance_memory. The maximum number of point that can be stored is limited not to exceed MAX_number_of_points_stored_in_the_resonance_memory, in order to avoid filling the up the disc by mistake. This number can be modified in the file RFOF_resonance_memory.f90.

INPUT

Parameters:

time	(in) Simulation time when the resonance prediciton was made
R	(in) Major radius when the resonance prediciton was made
phi	(in) Toroidal angle when the resonance prediciton was made
z	(in) Vertical coordinante when the resonance prediciton was made
omega_res	(in) Resonance function when the resonance prediciton was made
nharm	(in) Harmonic number of the resonance
MPI_node_Id	(in) Number used to identify MPI nods during parallel execusion.

OUTPUT

Parameters:

time_at_resonance	(out) Predicted time at the resonance.
R_at_resonance	(out) Predicted major radius at the resonance.
phi_at_resonance	(out) Predicted toroidal angle at the resonance.
z_at_resonance	(out) Predicted vertical coordinate at the resonance.
Dot_omega_res	(out) Predicted time derivative of the resonance function at the resonance.
DotDot_omega_res	(out) Predicted second time derivative of the resonance function at the resonance.

Definition at line 674 of file RFOF_diagnostics.F90.

subroutine RFOF_diagnostics::save2file_rf_kicks	(	type(particle), intent(inout)	marker,
		type(resonance_memory), intent(in)	mem,
		integer, intent(in)	jfreq,
		integer, intent(in)	jnphi,
		real(8), intent(in)	dE,
		real(8), intent(in)	dPphi,
		real(8), intent(in)	RFop1,
		real(8), intent(in)	RFop2,
		character(128), intent(in)	RFopType,
		integer, intent(in)	MPI_node_Id
	)

subroutine save2file_rf_kicks

Store the resonance positions and the $(E,P_\phi)$ kick.

Definition at line 745 of file RFOF_diagnostics.F90.

subroutine RFOF_diagnostics::store2file_orbit_event	(	integer, intent(inout)	no_points,
		integer, intent(in)	MAX_no_points,
		character(128), intent(in)	filename,
		character(128), intent(in)	calling_routine_name,
		character(128), intent(in)	data_description,
		character(128), intent(in)	list_variable_names,
		real(8), dimension(:), intent(in)	data,
		integer, intent(in)	io_channel
	)

subroutine store2file_orbit_event(diagno)

Store the time-instant information in the vector data to a file

Definition at line 833 of file RFOF_diagnostics.F90.

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

RFOF_diagnostics.F90

Data Types

Public Member Functions

Detailed Description

Member Function/Subroutine Documentation