Data Types
type	pointer_ncmatrix
type	pointer_intnc

Functions/Subroutines
subroutine, public	init_sources
	Initialize the sources module.
subroutine, public	add_sources (step)
	Add various source terms to the RHS of Vlasov/Boltzmann equation.
subroutine	source_diagnostics (isp, spos, weightperb, ut, utob, av_ut, en, ithread, type)
	Diagnostic for the source terms.
subroutine	heating_init
	Initialize heating source.
subroutine	heating_disp (isp)
	Call the heating routines.
subroutine	fixed_heating_basic (isp)
	Heat the plasma using a fixed heat source with a defined radial profile and amplitude.
subroutine	fixed_heating_ecrh (pic1_loc, pic2_loc, isp)
	Heat the electrons using the ECRH heating scheme.
subroutine	edge_buffer_krook_conserving (pic1_loc, pic2_loc, npart_loc, isp)
	Add a Krook buffer at the outer radial edge to damp df. This Krook conserve density.
subroutine	edge_buffer_krook_non_conserving (pic1_loc, pic2_loc, npart_loc, isp)
	Add a naive Krook buffer at the outer radial edge to damp df.
subroutine	edge_buffer_collisional (pic1_loc, pic2_loc, isp)
	Add a collisional buffer at the outer radial edge to damp df.
real(kind=r8) function	get_radial_profile (species, s)
	Get source radial profile at particle's position by interpolation.
subroutine	heating (isp)
	Heating term: damp \delta f(\eps,\psi)->0 in order to control departure of temperature profile from initial state With nl_wdecay_gyro_switch=.true. designed to simulate GYRO heating source.
subroutine	bin_en_radius (en, sigmak, isp, bin_en, bin_r)
	Compute the bin index of a particle.
subroutine	noise_control_init
	Initialize the noise control.
subroutine	noise_control (isp, act)
	Add a decay term to the weights, while conserving various moments in spatial bins. Also 'splits' weight by collecting adiabatic distributions in bins.
subroutine	source_cons (moments, ut, ut_over_b, ut_over_b_ba, en, isp)
	Returns the moment M_i to be conserved.
subroutine	force_flow (pic1_loc, pic2_loc, npart_loc, isp)
subroutine	coarsen (isp)
	Routine to apply coarse graining.

Variables
integer, dimension(:,:,:), allocatable, save	nbin
integer, save	nbins_nc
type(pointer_ncmatrix), dimension(:), allocatable, save	ncmat
type(pointer_ncmatrix), dimension(:), allocatable, save	fhsmat
type(pointer_intnc), dimension(:), allocatable, save	ncint
type(pointer_intnc), dimension(:), allocatable, save	fhsint
integer, save	nbins_r
integer, save	nbins_en
real(kind=r8), dimension(:,:,:,:), allocatable, save	wtot
real(kind=r8), dimension(:,:,:,:), allocatable, save	wtot2
real(kind=r8), dimension(:,:,:,:), allocatable, save	ntot
real(kind=r8), dimension(:,:,:,:), allocatable, save	ftot
real(kind=r8), dimension(:,:,:,:), allocatable, save	v2ft
real(kind=r8), dimension(:,:,:), allocatable, save	source_part
real(kind=r8), dimension(:,:,:), allocatable, save	source_heat
real(kind=r8), dimension(:,:,:), allocatable, save	f0_bins
real(kind=r8), dimension(:,:,:), allocatable, save	v2ft2
real(kind=r8), dimension(:), allocatable, save	wtot_all_ff
real(kind=r8), dimension(:), allocatable, save	wtot_all_f0
real(kind=r8), dimension(:,:), allocatable, save	en_max
real(kind=r8), dimension(:,:), allocatable, save	radial_profile
real(kind=r8), dimension(:), allocatable, save	rpar
integer, parameter	momentcons =3
integer, parameter	maxmoments =4
integer, dimension(:,:), allocatable, save	wd_cons
integer, dimension(:), allocatable, save	nmoments

Function/Subroutine Documentation

◆ add_sources()

subroutine, public sources::add_sources ( integer, intent(in) step )

Add various source terms to the RHS of Vlasov/Boltzmann equation.

Adds heating, Krook, coarse graining and force flow terms

Parameters

[in] step Current step number

Here is the call graph for this function:

Here is the caller graph for this function:

◆ bin_en_radius()

subroutine sources::bin_en_radius	(	real(kind=r8), intent(in)	en,
		real(kind=r8), intent(in)	sigmak,
		integer, intent(in)	isp,
		integer, intent(out)	bin_en,
		integer, intent(out)	bin_r )

private

Compute the bin index of a particle.

Note: OpenACC version requires this routine to be out of heating "contains" section

Parameters

[in]	en	Particle's kinetic energy
[in]	sigmak	Radial position
[in]	isp	Current species
[out]	bin_en	Bins in energy space
[out]	bin_r	Bins in the redial direction

Here is the caller graph for this function:

◆ coarsen()

subroutine sources::coarsen ( integer, intent(in) isp )

private

Routine to apply coarse graining.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edge_buffer_collisional()

subroutine sources::edge_buffer_collisional	(	real(kind=r8), dimension(:,:), intent(inout)	pic1_loc,
		real(kind=r8), dimension(:,:), intent(inout)	pic2_loc,
		integer, intent(in)	isp )

private

Add a collisional buffer at the outer radial edge to damp df.

Parameters

[in,out] pic1_loc pic array of a certain species.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edge_buffer_krook_conserving()

subroutine sources::edge_buffer_krook_conserving	(	real(kind=r8), dimension(:,:), intent(inout)	pic1_loc,
		real(kind=r8), dimension(:,:), intent(inout)	pic2_loc,
		integer, intent(in)	npart_loc,
		integer, intent(in)	isp )

private

Add a Krook buffer at the outer radial edge to damp df. This Krook conserve density.

Parameters

[in]	npart_loc	Local number of particles
[in,out]	pic1_loc	Array containing the non-static properties of the markers
[in,out]	pic2_loc	Array containing the static propoerties of the markers
[in]	isp	Species under consideration

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edge_buffer_krook_non_conserving()

subroutine sources::edge_buffer_krook_non_conserving	(	real(kind=r8), dimension(:,:), intent(inout)	pic1_loc,
		real(kind=r8), dimension(:,:), intent(inout)	pic2_loc,
		integer, intent(in)	npart_loc,
		integer, intent(in)	isp )

private

Add a naive Krook buffer at the outer radial edge to damp df.

Parameters

[in]	npart_loc	Local number of particles
[in,out]	pic1_loc	Array containing the non-static properties of the markers
[in,out]	pic2_loc	Array containing the static propoerties of the markers
[in]	isp	Species under consideration

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fixed_heating_basic()

subroutine sources::fixed_heating_basic ( integer, intent(in) isp )

private

Heat the plasma using a fixed heat source with a defined radial profile and amplitude.

The heat source is furthermore modified in a similar way as the Krook operator to ensure that the density, parallel momentum and zonal structure are conserved.

Parameters

[in] isp On which species to act on

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fixed_heating_ecrh()

subroutine sources::fixed_heating_ecrh	(	real(kind=r8), dimension(:,:), intent(inout)	pic1_loc,
		real(kind=r8), dimension(:,:), intent(inout)	pic2_loc,
		integer, intent(in)	isp )

private

Heat the electrons using the ECRH heating scheme.

Parameters

[in,out]	pic1_loc	pic array of a certain species.
[in,out]	pic2_loc	pic array of a certain species.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ force_flow()

subroutine sources::force_flow	(	real(kind=r8), dimension(:,:), intent(inout)	pic1_loc,
		real(kind=r8), dimension(:,:), intent(inout)	pic2_loc,
		integer, intent(in)	npart_loc,
		integer, intent(in)	isp )

private

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_radial_profile()

real(kind=r8) function sources::get_radial_profile	(	integer, intent(in)	species,
		real(kind=r8), intent(in)	s )

private

Get source radial profile at particle's position by interpolation.

Note: OpenACC version requires this routine to be out of fixed_heating_basic "contains" section

Parameters

[in]	species	Current species
[in]	s	Radial position of the particle

Returns: Value of the radial profile

Here is the call graph for this function:

Here is the caller graph for this function:

◆ heating()

subroutine sources::heating ( integer, intent(in) isp )

private

Heating term: damp \delta f(\eps,\psi)->0 in order to control departure of temperature profile from initial state With nl_wdecay_gyro_switch=.true. designed to simulate GYRO heating source.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ heating_disp()

subroutine sources::heating_disp ( integer, intent(in) isp )

private

Call the heating routines.

Parameters

[in] isp Current species (assumed to be kinetic)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ heating_init()

subroutine sources::heating_init

private

Initialize heating source.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init_sources()

subroutine, public sources::init_sources

Initialize the sources module.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ noise_control()

subroutine sources::noise_control	(	integer, intent(in)	isp,
		logical, intent(in)	act )

private

Add a decay term to the weights, while conserving various moments in spatial bins. Also 'splits' weight by collecting adiabatic distributions in bins.

Parameters

[in]	isp	On which species to act on
[in]	act	Whether to act on weights (otherwise just collect adiabatic distribution)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ noise_control_init()

subroutine sources::noise_control_init

private

Initialize the noise control.

Todo: Define binings and allocate necessary arrays. Bining for vpll_avg. Should be input parameters really.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ source_cons()

subroutine sources::source_cons	(	real(kind=r8), dimension(:), intent(out)	moments,
		real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	ut_over_b,
		real(kind=r8), intent(in)	ut_over_b_ba,
		real(kind=r8), intent(in)	en,
		integer, intent(in)	isp )

private

Returns the moment M_i to be conserved.

Note: OpenACC version requires this routine to be out of noise_control "contains" section

Parameters

[in]	ut	parallel velocity, v_par
[in]	ut_over_b	v_par/b
[in]	ut_over_b_ba	v_par/b bounce averaged
[in]	en	Kinetic energy
[in]	isp	Species under consideration
[out]	moments	Array containing the moments to be conserved

Here is the caller graph for this function:

◆ source_diagnostics()

subroutine sources::source_diagnostics	(	integer, intent(in)	isp,
		real(kind=r8), intent(in)	spos,
		real(kind=r8), intent(in)	weightperb,
		real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	utob,
		real(kind=r8), intent(in)	av_ut,
		real(kind=r8), intent(in)	en,
		integer, intent(in)	ithread,
		integer, intent(in)	type )

private

Diagnostic for the source terms.

This diagnostic computes the radial profile of the density, energy, and ZF injected by the source terms on a s grid defined by nc_bin_s.

Parameters

[in]	isp	Current species
[in]	spos	Particle's radial s position
[in]	weightperb	Contribution of the NC/heating to the weight
[in]	ut	Parallel velocity
[in]	utob	Parallel velocity over B
[in]	av_ut	Mean parallel velocity
[in]	en	Kinetic energy
[in]	ithread	OpenMP thread
[in]	type	Type of diagnostic (NSEL_NC for noise control of NSEL_HEATING for heating)

Here is the caller graph for this function:

Variable Documentation

◆ en_max

real(kind=r8), dimension(:,:), allocatable, save sources::en_max

private

◆ f0_bins

real(kind=r8), dimension(:,:,:), allocatable, save sources::f0_bins

private

◆ fhsint

type(pointer_intnc), dimension(:), allocatable, save sources::fhsint

private

◆ fhsmat

type(pointer_ncmatrix), dimension(:), allocatable, save sources::fhsmat

private

◆ ftot

real(kind=r8), dimension(:,:,:,:), allocatable, save sources::ftot

private

◆ maxmoments

integer, parameter sources::maxmoments =4

private

◆ momentcons

integer, parameter sources::momentcons =3

private

◆ nbin

integer, dimension(:,:,:), allocatable, save sources::nbin

private

◆ nbins_en

integer, save sources::nbins_en

private

◆ nbins_nc

integer, save sources::nbins_nc

private

◆ nbins_r

integer, save sources::nbins_r

private

◆ ncint

type(pointer_intnc), dimension(:), allocatable, save sources::ncint

◆ ncmat

type(pointer_ncmatrix), dimension(:), allocatable, save sources::ncmat

◆ nmoments

integer, dimension(:), allocatable, save sources::nmoments

private

◆ ntot

real(kind=r8), dimension(:,:,:,:), allocatable, save sources::ntot

private

◆ radial_profile

real(kind=r8), dimension(:,:), allocatable, save sources::radial_profile

private

◆ rpar

real(kind=r8), dimension(:), allocatable, save sources::rpar

private

◆ source_heat

real(kind=r8), dimension(:,:,:), allocatable, save sources::source_heat

private

◆ source_part

real(kind=r8), dimension(:,:,:), allocatable, save sources::source_part

private

◆ v2ft

real(kind=r8), dimension(:,:,:,:), allocatable, save sources::v2ft

private

◆ v2ft2

real(kind=r8), dimension(:,:,:), allocatable, save sources::v2ft2

private

◆ wd_cons

integer, dimension(:,:), allocatable, save sources::wd_cons

private

◆ wtot

real(kind=r8), dimension(:,:,:,:), allocatable, save sources::wtot

private

◆ wtot2

real(kind=r8), dimension(:,:,:,:), allocatable, save sources::wtot2

private

◆ wtot_all_f0

real(kind=r8), dimension(:), allocatable, save sources::wtot_all_f0

private

◆ wtot_all_ff

real(kind=r8), dimension(:), allocatable, save sources::wtot_all_ff

private

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ add_sources()

◆ bin_en_radius()

◆ coarsen()

◆ edge_buffer_collisional()

◆ edge_buffer_krook_conserving()

◆ edge_buffer_krook_non_conserving()

◆ fixed_heating_basic()

◆ fixed_heating_ecrh()

◆ force_flow()

◆ get_radial_profile()

◆ heating()

◆ heating_disp()

◆ heating_init()

◆ init_sources()

◆ noise_control()

◆ noise_control_init()

◆ source_cons()

◆ source_diagnostics()

Variable Documentation

◆ en_max

◆ f0_bins

◆ fhsint

◆ fhsmat

◆ ftot

◆ maxmoments

◆ momentcons

◆ nbin

◆ nbins_en

◆ nbins_nc

◆ nbins_r

◆ ncint

◆ ncmat

◆ nmoments

◆ ntot

◆ radial_profile

◆ rpar

◆ source_heat

◆ source_part

◆ v2ft

◆ v2ft2

◆ wd_cons

◆ wtot

◆ wtot2

◆ wtot_all_f0

◆ wtot_all_ff