background Module Reference

Different background distribution functions and their gradients. More...

Functions/Subroutines
subroutine, public	init_background
	Initialize background module.
subroutine	vcritic_slowingdown (psit, vc, vcgrad)
real(kind=r8) function, public	vf0 (isp, zvth2, nval, ze, zecor, b, pot_equil, pot_equil0, psit, chit, ut, mut, nsel_f0_override)
	Evaluate background distribution function.
real(kind=r8) function, public	vf0_local_maxwellian (vth2, nval, ze)
	Evaluate local maxwellian.
real(kind=r8) function, public	vf0_psi_prof (zf0, ngrad, epsilonhat, ze, b, kappa_str, zvth2_inv, tgrad, ut, psi0_inv, psit, isp, zvth2, nval, zecor, pot_equil, pot_equil0, mut, chit)
	Evaluate derivative of background distribution function with respect to psi_prof.
real(kind=r8) function, public	vf0_chi_prof (zf0, ngrad, epsilonhat, ze, b, kappa_str, zvth2_inv, tgrad, ut, psi0_inv, psit, isp, zvth2, nval, zecor, pot_equil, pot_equil0, mut, chit)
	Evaluate derivative of background distribution function with respect to psi_prof.
real(kind=r8) function, public	vf0dek (zf0, zvth2, ze, psit, isp, nval, zecor, b, pot_equil, pot_equil0, ut, mut, chit)
	Evaluate derivative of background distribution function with respect to Ek.
real(kind=r8) function, public	vf0du (zf0, ut, ze, zvth2, nval, psit, isp, ze1, zecor, pot_equil, pot_equil0, mut, chit)
	Evaluate derivative of background distribution function with respect to U.
real(kind=r8) function, public	num_vf0dek (isp, zvth2, nval, ze, zecor, pot_equil, pot_equil0, psit, ut, mut, chit, zf0, delta_ze)
	Numerical derivative in Ek for f_0(s,Ek,u).
real(kind=r8) function	num_vf0dek_fixedmu (isp, zvth2, nval, ze, zecor, pot_equil, pot_equil0, psit, ut, mut, chit, zf0, delta_ze)
	Numerical derivative in Ek for f_0(s,theta,Ek,mu).
real(kind=r8) function, public	vf0dchi (zf0, ut, zvth2, psit, chit, isp)
	Evaluate derivative of background distribution function with respect to chi.
real(kind=r8) function	num_vf0dek_centered (isp, zvth2, nval, ze, zecor, pot_equil, pot_equil0, psit, ut, mut, chit, zf0)
real(kind=r8) function, public	num_vf0_psi_prof (isp, zvth2, nval, ze, zecor, pot_equil, pot_equil0, psit, ut, mut, chit, zf0, delta_psi)
	Numerical derivative in s for f_0(s,Ek,u).
real(kind=r8) function	num_vf0_psi_prof_fixedmu (isp, zvth2, nval, ze, zecor, pot_equil, pot_equil0, psit, ut, mut, chit, zf0, delta_psi)
	Numerical derivative in psi=s^2 for f_0(s,theta,Ek,mu).
real(kind=r8) function	num_vf0_chi_prof_fixedmu (isp, zvth2, nval, ze, zecor, pot_equil, pot_equil0, psit, ut, mut, chit, zf0, delta_chi)
	Numerical derivative in psi=s^2 for f_0(s,theta,Ek,mu).
real(kind=r8) function, public	num_vf0du (isp, zvth2, nval, ze, zecor, pot_equil, pot_equil0, psit, ut, mut, chit, zf0, delta_u_)
	Numerical derivative in u for f_0(s,Ek,u).
subroutine	init_numerical_f0 (isp)
real(kind=r8) function	evaluate_numerical_f0 (isp, psit, ut, zet)
real(kind=r8) function, public	get_ke (ut, mu, b)
real(kind=r8) function, public	get_mu (ut, ze, b)
real(kind=r8) function, public	get_uabs (mut, ze, b)
subroutine	dump_f0
subroutine	dump_f0_sp (isp)

Detailed Description

Different background distribution functions and their gradients.

Note

zf0, when passed to subroutines does not contain pvol (changed 12/2014, mcmillan)

Function/Subroutine Documentation

dump_f0()

subroutine background::dump_f0

private

Here is the call graph for this function:

Here is the caller graph for this function:

dump_f0_sp()

subroutine background::dump_f0_sp ( integer, intent(in) isp )

private

Here is the call graph for this function:

Here is the caller graph for this function:

evaluate_numerical_f0()

real(kind=r8) function background::evaluate_numerical_f0 ( integer, intent(in) isp, real(kind=r8), intent(in) psit, real(kind=r8), intent(in) ut, real(kind=r8), intent(in) zet )

private

Here is the call graph for this function:

Here is the caller graph for this function:

get_ke()

real(kind=r8) function, public background::get_ke	(	real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	mu,
		real(kind=r8), intent(in)	b )

Here is the call graph for this function:

Here is the caller graph for this function:

get_mu()

real(kind=r8) function, public background::get_mu	(	real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	ze,
		real(kind=r8), intent(in)	b )

Here is the call graph for this function:

Here is the caller graph for this function:

get_uabs()

real(kind=r8) function, public background::get_uabs	(	real(kind=r8), intent(in)	mut,
		real(kind=r8), intent(in)	ze,
		real(kind=r8), intent(in)	b )

Here is the call graph for this function:

Here is the caller graph for this function:

init_background()

subroutine, public background::init_background

Initialize background module.

Here is the call graph for this function:

Here is the caller graph for this function:

init_numerical_f0()

subroutine background::init_numerical_f0 ( integer, intent(in) isp )

private

Here is the call graph for this function:

Here is the caller graph for this function:

num_vf0_chi_prof_fixedmu()

real(kind=r8) function background::num_vf0_chi_prof_fixedmu ( integer, intent(in) isp, real(kind=r8), intent(in) zvth2, real(kind=r8), intent(in) nval, real(kind=r8), intent(in) ze, real(kind=r8), intent(in) zecor, real(kind=r8), intent(in) pot_equil, real(kind=r8), intent(in) pot_equil0, real(kind=r8), intent(in) psit, real(kind=r8), intent(in) ut, real(kind=r8), intent(in) mut, real(kind=r8), intent(in) chit, real(kind=r8), intent(in) zf0, real(kind=r8), intent(in) delta_chi )

private

Numerical derivative in psi=s^2 for f_0(s,theta,Ek,mu).

Here is the call graph for this function:

Here is the caller graph for this function:

num_vf0_psi_prof()

real(kind=r8) function, public background::num_vf0_psi_prof	(	integer, intent(in)	isp,
		real(kind=r8), intent(in)	zvth2,
		real(kind=r8), intent(in)	nval,
		real(kind=r8), intent(in)	ze,
		real(kind=r8), intent(in)	zecor,
		real(kind=r8), intent(in)	pot_equil,
		real(kind=r8), intent(in)	pot_equil0,
		real(kind=r8), intent(in)	psit,
		real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	mut,
		real(kind=r8), intent(in)	chit,
		real(kind=r8), intent(in)	zf0,
		real(kind=r8), intent(inout)	delta_psi )

Numerical derivative in s for f_0(s,Ek,u).

Here is the call graph for this function:

Here is the caller graph for this function:

num_vf0_psi_prof_fixedmu()

real(kind=r8) function background::num_vf0_psi_prof_fixedmu ( integer, intent(in) isp, real(kind=r8), intent(in) zvth2, real(kind=r8), intent(in) nval, real(kind=r8), intent(in) ze, real(kind=r8), intent(in) zecor, real(kind=r8), intent(in) pot_equil, real(kind=r8), intent(in) pot_equil0, real(kind=r8), intent(in) psit, real(kind=r8), intent(in) ut, real(kind=r8), intent(in) mut, real(kind=r8), intent(in) chit, real(kind=r8), intent(in) zf0, real(kind=r8), intent(inout) delta_psi )

private

Numerical derivative in psi=s^2 for f_0(s,theta,Ek,mu).

Here is the call graph for this function:

Here is the caller graph for this function:

num_vf0dek()

real(kind=r8) function, public background::num_vf0dek	(	integer, intent(in)	isp,
		real(kind=r8), intent(in)	zvth2,
		real(kind=r8), intent(in)	nval,
		real(kind=r8), intent(in)	ze,
		real(kind=r8), intent(in)	zecor,
		real(kind=r8), intent(in)	pot_equil,
		real(kind=r8), intent(in)	pot_equil0,
		real(kind=r8), intent(in)	psit,
		real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	mut,
		real(kind=r8), intent(in)	chit,
		real(kind=r8), intent(in)	zf0,
		real(kind=r8), intent(in)	delta_ze )

Numerical derivative in Ek for f_0(s,Ek,u).

Here is the call graph for this function:

Here is the caller graph for this function:

num_vf0dek_centered()

real(kind=r8) function background::num_vf0dek_centered ( integer, intent(in) isp, real(kind=r8), intent(in) zvth2, real(kind=r8), intent(in) nval, real(kind=r8), intent(in) ze, real(kind=r8), intent(in) zecor, real(kind=r8), intent(in) pot_equil, real(kind=r8), intent(in) pot_equil0, real(kind=r8), intent(in) psit, real(kind=r8), intent(in) ut, real(kind=r8), intent(in) mut, real(kind=r8), intent(in) chit, real(kind=r8), intent(in) zf0 )

private

Here is the call graph for this function:

Here is the caller graph for this function:

num_vf0dek_fixedmu()

real(kind=r8) function background::num_vf0dek_fixedmu ( integer, intent(in) isp, real(kind=r8), intent(in) zvth2, real(kind=r8), intent(in) nval, real(kind=r8), intent(in) ze, real(kind=r8), intent(in) zecor, real(kind=r8), intent(in) pot_equil, real(kind=r8), intent(in) pot_equil0, real(kind=r8), intent(in) psit, real(kind=r8), intent(in) ut, real(kind=r8), intent(in) mut, real(kind=r8), intent(in) chit, real(kind=r8), intent(in) zf0, real(kind=r8), intent(in) delta_ze )

private

Numerical derivative in Ek for f_0(s,theta,Ek,mu).

Here is the call graph for this function:

Here is the caller graph for this function:

num_vf0du()

real(kind=r8) function, public background::num_vf0du	(	integer, intent(in)	isp,
		real(kind=r8), intent(in)	zvth2,
		real(kind=r8), intent(in)	nval,
		real(kind=r8), intent(in)	ze,
		real(kind=r8), intent(in)	zecor,
		real(kind=r8), intent(in)	pot_equil,
		real(kind=r8), intent(in)	pot_equil0,
		real(kind=r8), intent(in)	psit,
		real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	mut,
		real(kind=r8), intent(in)	chit,
		real(kind=r8), intent(in)	zf0,
		real(kind=r8), intent(in), optional	delta_u_ )

Numerical derivative in u for f_0(s,Ek,u).

Here is the call graph for this function:

Here is the caller graph for this function:

vcritic_slowingdown()

subroutine background::vcritic_slowingdown ( real(kind=r8), intent(in) psit, real(kind=r8), intent(out) vc, real(kind=r8), intent(out) vcgrad )

private

Here is the call graph for this function:

Here is the caller graph for this function:

vf0()

real(kind=r8) function, public background::vf0	(	integer, intent(in)	isp,
		real(kind=r8), intent(in)	zvth2,
		real(kind=r8), intent(in)	nval,
		real(kind=r8), intent(in)	ze,
		real(kind=r8), intent(in)	zecor,
		real(kind=r8), intent(in)	b,
		real(kind=r8), intent(in)	pot_equil,
		real(kind=r8), intent(in)	pot_equil0,
		real(kind=r8), intent(in)	psit,
		real(kind=r8), intent(in)	chit,
		real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	mut,
		integer, intent(in), optional	nsel_f0_override )

Evaluate background distribution function.

Here is the call graph for this function:

Here is the caller graph for this function:

vf0_chi_prof()

real(kind=r8) function, public background::vf0_chi_prof	(	real(kind=r8), intent(in)	zf0,
		real(kind=r8), intent(in)	ngrad,
		real(kind=r8), intent(in)	epsilonhat,
		real(kind=r8), intent(in)	ze,
		real(kind=r8), intent(in)	b,
		real(kind=r8), intent(in)	kappa_str,
		real(kind=r8), intent(in)	zvth2_inv,
		real(kind=r8), intent(in)	tgrad,
		real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	psi0_inv,
		real(kind=r8), intent(in)	psit,
		integer, intent(in)	isp,
		real(kind=r8), intent(in)	zvth2,
		real(kind=r8), intent(in)	nval,
		real(kind=r8), intent(in)	zecor,
		real(kind=r8), intent(in)	pot_equil,
		real(kind=r8), intent(in)	pot_equil0,
		real(kind=r8), intent(in)	mut,
		real(kind=r8), intent(in)	chit )

Evaluate derivative of background distribution function with respect to psi_prof.

Here is the call graph for this function:

Here is the caller graph for this function:

vf0_local_maxwellian()

real(kind=r8) function, public background::vf0_local_maxwellian	(	real(kind=r8), intent(in)	vth2,
		real(kind=r8), intent(in)	nval,
		real(kind=r8), intent(in)	ze )

Evaluate local maxwellian.

Here is the call graph for this function:

Here is the caller graph for this function:

vf0_psi_prof()

real(kind=r8) function, public background::vf0_psi_prof	(	real(kind=r8), intent(in)	zf0,
		real(kind=r8), intent(in)	ngrad,
		real(kind=r8), intent(in)	epsilonhat,
		real(kind=r8), intent(in)	ze,
		real(kind=r8), intent(in)	b,
		real(kind=r8), intent(in)	kappa_str,
		real(kind=r8), intent(in)	zvth2_inv,
		real(kind=r8), intent(in)	tgrad,
		real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	psi0_inv,
		real(kind=r8), intent(in)	psit,
		integer, intent(in)	isp,
		real(kind=r8), intent(in)	zvth2,
		real(kind=r8), intent(in)	nval,
		real(kind=r8), intent(in)	zecor,
		real(kind=r8), intent(in)	pot_equil,
		real(kind=r8), intent(in)	pot_equil0,
		real(kind=r8), intent(in)	mut,
		real(kind=r8), intent(in)	chit )

Evaluate derivative of background distribution function with respect to psi_prof.

Here is the call graph for this function:

Here is the caller graph for this function:

vf0dchi()

real(kind=r8) function, public background::vf0dchi	(	real(kind=r8), intent(in)	zf0,
		real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	zvth2,
		real(kind=r8), intent(in)	psit,
		real(kind=r8), intent(in)	chit,
		integer, intent(in)	isp )

Evaluate derivative of background distribution function with respect to chi.

Here is the call graph for this function:

Here is the caller graph for this function:

vf0dek()

real(kind=r8) function, public background::vf0dek	(	real(kind=r8), intent(in)	zf0,
		real(kind=r8), intent(in)	zvth2,
		real(kind=r8), intent(in)	ze,
		real(kind=r8), intent(in)	psit,
		integer, intent(in)	isp,
		real(kind=r8), intent(in)	nval,
		real(kind=r8), intent(in)	zecor,
		real(kind=r8), intent(in)	b,
		real(kind=r8), intent(in)	pot_equil,
		real(kind=r8), intent(in)	pot_equil0,
		real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	mut,
		real(kind=r8), intent(in)	chit )

Evaluate derivative of background distribution function with respect to Ek.

Here is the call graph for this function:

Here is the caller graph for this function:

vf0du()

real(kind=r8) function, public background::vf0du	(	real(kind=r8), intent(in)	zf0,
		real(kind=r8), intent(in)	ut,
		real(kind=r8), intent(in)	ze,
		real(kind=r8), intent(in)	zvth2,
		real(kind=r8), intent(in)	nval,
		real(kind=r8), intent(in)	psit,
		integer, intent(in)	isp,
		real(kind=r8), intent(in)	ze1,
		real(kind=r8), intent(in)	zecor,
		real(kind=r8), intent(in)	pot_equil,
		real(kind=r8), intent(in)	pot_equil0,
		real(kind=r8), intent(in)	mut,
		real(kind=r8), intent(in)	chit )

Evaluate derivative of background distribution function with respect to U.

Here is the call graph for this function:

Here is the caller graph for this function: