korc_velocity_distribution Module

Note

Module containing subroutines to initialize the velocity distribution of the simulated particles.

Uses

Contents

Functions

fth_3V random_norm

Subroutines

thermal_distribution initial_energy_pitch_dist gyro_distribution initial_gyro_distribution

Functions

private function fth_3V(Vth, V)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=rp),	intent(in)			::	Vth	Thermal velocity of the background electrons $v_{T_e}$ .
real(kind=rp),	intent(in),		DIMENSION(3)	::	V	Velocity of the sampled electron $\mathbf{v}$ .

Return Value real(kind=rp)

Value of $f_{T_e}(v)$ .

private function random_norm(mu, sigma)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=rp),	intent(in)			::	mu	Mean value $\mu$ of the Gaussian distribution.
real(kind=rp),	intent(in)			::	sigma	Standard deviation $\sigma$ of the Gaussian distribution.

Return Value real(kind=rp)

Sampled number $x$ from the Gaussian distribution $f_G(x;\mu,\sigma)$ .

Subroutines

public subroutine thermal_distribution(params, spp)

Arguments

Type	Intent	Optional	Attributes		Name
type(KORC_PARAMS),	intent(in)			::	params	Core KORC simulation parameters.
type(SPECIES),	intent(inout)			::	spp	An instance of the derived type SPECIES containing all the parameters and simulation variables of the different species in the simulation.

public subroutine initial_energy_pitch_dist(params, spp)

Arguments

Type	Intent	Optional	Attributes		Name
type(KORC_PARAMS),	intent(in)			::	params	Core KORC simulation parameters.
type(SPECIES),	intent(inout),		DIMENSION(:), ALLOCATABLE	::	spp	An instance of the derived type SPECIES containing all the parameters and simulation variables of the different species in the simulation.

private subroutine gyro_distribution(params, F, spp)

Arguments

Type	Intent	Optional	Attributes		Name
type(KORC_PARAMS),	intent(in)			::	params	Core KORC simulation parameters.
type(FIELDS),	intent(in)			::	F	An instance of the KORC derived type FIELDS. This structure has the information of the magnetic field.
type(SPECIES),	intent(inout)			::	spp	An instance of the derived type SPECIES containing all the parameters and simulation variables of the different species in the simulation.

public subroutine initial_gyro_distribution(params, F, spp)

Arguments

Type	Intent	Optional	Attributes		Name
type(KORC_PARAMS),	intent(in)			::	params	Core KORC simulation parameters.
type(FIELDS),	intent(in)			::	F	An instance of the KORC derived type FIELDS. This structure has the information of the magnetic field.
type(SPECIES),	intent(inout),		DIMENSION(:), ALLOCATABLE	::	spp	An instance of the derived type SPECIES containing all the parameters and simulation variables of the different species in the simulation.