Module handling resonance condition for wave particle interactions. More...

Public Member Functions
subroutine	rf_wave_particles_resonance (time, time_previous_step, marker, resonanceMemory, RFglobal, nr_resonant_waves, list_resonant_waves, time_at_resonance, particle_overshot_resonance, MPI_nod_Id)
	This routine check if the marker is in resonance, or have crossed the resonance any of the wave in RFglobal. Independently of the marker being in resonance or not, the resonant related information is stored in resonanceMemory.
subroutine	wave_particles_resonance_function (marker, RFlocal, omega_res, nharm)
	The resonance function for wave particle interaction reads $\omega_{res} = \omega - n \Omega - k_\\| v_\\| - \bf{k}_\perp \cdot \bf{v}_D$ where $\omega =$ angular wave frequency, the harmonic resonance number, $\Omega =$ cyclotron frequency $k_\\| =$ the parallel wave number, $v_\\| =$ the parallel velocity, $\bf{k}_\perp =$ the perpendicular wave vector and $\bf{v}_\perp =$ the perpendicular velocity vector.
logical function	close_enough_to_resonance (t_res, R_res, z_res, time, time_previous_step, marker)
	Test if particle location is close enough to the resonance to give the marker an RF "kick".
real(8) function	width_of_resonance_in_R (marker)
	Returns the width of the resonance layer in major radius.
logical function	resonance_already_treated_in_previous_timestep (mem, time, Torbit, Dot_omega_res)
	Determines if the marker have already recieved an RF kick for the "new" resonance described by time and Dot_omega_res.

Detailed Description

Module handling resonance condition for wave particle interactions.

Author:: T. Johnson

Date:: 2010.05.26

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

Definition at line 10 of file RFOF_resonance_condition.F90.

Member Function/Subroutine Documentation

subroutine RFOF_resonance_condition::rf_wave_particles_resonance	(	real(8), intent(in)	time,
		real(8), intent(in)	time_previous_step,
		type(particle), intent(in)	marker,
		type(resonance_memory), dimension(:,:), intent(inout)	resonanceMemory,
		type(rf_wave_global), intent(inout)	RFglobal,
		integer, intent(out)	nr_resonant_waves,
		real(8), dimension(:,:), intent(out), pointer	list_resonant_waves,
		real(8), intent(out)	time_at_resonance,
		logical, intent(out)	particle_overshot_resonance,
		integer, intent(in)	MPI_nod_Id
	)

This routine check if the marker is in resonance, or have crossed the resonance any of the wave in RFglobal. Independently of the marker being in resonance or not, the resonant related information is stored in resonanceMemory.

If we are close enough to the resonance to consider it "at the resonance", then "particle_at_resonance=.TRUE." else "particle_at_resonance=.FALSE.". Furthmore, when the marker is at the resonance the variables "jSelectWave1, jSelectWave2" are returned such that "RFglobal(jSelectWave1, jSelectWave2)" is the wave which the marker is in resonance with.

If the particle is not in resonance, but it has crossed the resonance during the last timestep, then "particle_overshot_resonance=.TRUE." else "particle_overshot_resonance=.FALSE.".

INPUT:

Parameters:

time	Time of simulation [s].
time_previous_step	Time of the previous time step in the simulation [s].
marker	Single particle which may be accelerated by the RF wave field.
RFglobal	The collection RF wave fields.

INPUT/OUTPUT:

Parameters:

resonanceMemory Memory of previous evaluations of the resonance condition.

OUTPUT:

Parameters:

nr_resonant_waves	Number of wave modes with which the particle is in resonance.
list_resonant_waves	List including pointers to the wave modes which the particle is resonance with.
time_at_resonance	Time at the resonance [s].
particle_overshot_resonance	Is .TRUE. if and only if the marker is not at resonant, but has moved past the resonance.
MPI_nod_Id	Number identifying the MPI node.

Definition at line 66 of file RFOF_resonance_condition.F90.

subroutine RFOF_resonance_condition::wave_particles_resonance_function	(	type(particle), intent(in)	marker,
		type(rf_wave_local), intent(in)	RFlocal,
		real(8), intent(out)	omega_res,
		integer, intent(out)	nharm
	)

The resonance function for wave particle interaction reads $\omega_{res} = \omega - n \Omega - k_\| v_\| - \bf{k}_\perp \cdot \bf{v}_D$ where $\omega =$ angular wave frequency, $ n = $ the harmonic resonance number, $\Omega =$ cyclotron frequency $k_\| =$ the parallel wave number, $v_\| =$ the parallel velocity, $\bf{k}_\perp =$ the perpendicular wave vector and $\bf{v}_\perp =$ the perpendicular velocity vector.

Input:

Parameters:

marker	(in) Properties of the marker
RFlocal	(in) Local properties of the RF wave field

Output

Parameters:

omega_res	(out) The resonance function for wave particle interaction
nharm	(out) Cyclotron harmonic closest to to resonance

Definition at line 221 of file RFOF_resonance_condition.F90.

logical function RFOF_resonance_condition::close_enough_to_resonance	(	real(8), intent(in)	t_res,
		real(8), intent(in)	R_res,
		real(8), intent(in)	z_res,
		real(8), intent(in)	time,
		real(8), intent(in)	time_previous_step,
		type(particle), intent(in)	marker
	)

Test if particle location is close enough to the resonance to give the marker an RF "kick".

Todo:: Improve condition for what particle is "resonant". At the moment the condition measures the distance to the resonance and compares it to an number which has to be specified; there is still no physical justification for why this number has been choosen.

Input:

Parameters:

t_res	Time at resonance
R_res	Major radius at resonance
time	Present simulation time
time_previous_step	Simulation time at previous time step
marker	Properties of the marker

Output

Returns:: close_enough Is .TRUE. if the particle close enough to the resonance to be "resonant", i.e. to recieve an RF kick.

Definition at line 279 of file RFOF_resonance_condition.F90.

real(8) function RFOF_resonance_condition::width_of_resonance_in_R ( type(particle), intent(in) marker )

Returns the width of the resonance layer in major radius.

INPUT

Parameters:

marker The properties of the marker

OUTPUT

Returns:: width The width of the resonance layer in major radius

Definition at line 329 of file RFOF_resonance_condition.F90.

logical function RFOF_resonance_condition::resonance_already_treated_in_previous_timestep	(	type(resonance_memory), intent(in)	mem,
		real(8), intent(in)	time,
		real(8), intent(in)	Torbit,
		real(8), intent(in)	Dot_omega_res
	)

Determines if the marker have already recieved an RF kick for the "new" resonance described by time and Dot_omega_res.

There are two measures to determine if the particle is in resonance or not. (A) we compare the sign of the time derivative of the resonance condition $S := sgn [ \partial_t \omega_{res}(\mathbf{r}(t)) ]$ . (B) we compare the time elapsed from the previous resonance crossing to the estimated bounce time; note that the time between resonances should be of the order of the bounce time-scale unless the particle is close to a stagnation orbit. The condition for not being in resonance is that both the $ S $ has not changed sign and that it is less than half a bounce time since the previous resonance.

INPUT

Parameters:

mem	datatype defined in the module RFOF_resonance_memory. Includes time histories of marker parameter of which we need time derivaties.
time	Time at new resonance
Torbit	Estimate of the orbit bounce time
Dot_omega_res	Time derivative of the resonance condition at the new resonance

OUTPUT

Returns:: alreadyTreated Is .TRUE. if the new resonance have already been treated, i.e. if marker have already recieved an RF kick for this resonance.

Definition at line 380 of file RFOF_resonance_condition.F90.

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

RFOF_resonance_condition.F90

Public Member Functions

Detailed Description

Member Function/Subroutine Documentation