ORB5  v4.9.4
background Module Reference

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

Functions/Subroutines

subroutine, public init_background
 Initialize background module. More...
 
subroutine vcritic_slowingdown (psit, vc, vcgrad)
 
real function, public vf0 (isp, zvth2, nval, ze, zecor, b, pot_equil, pot_equil0, psit, ut, mut, nsel_f0_override)
 Evaluate background distribution function. More...
 
real function, public vf0_local_maxwellian (vth2, nval, ze)
 Evaluate local maxwellian. More...
 
real 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. More...
 
real 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. More...
 
real 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. More...
 
real 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. More...
 
real function 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) More...
 
real 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) More...
 
real function num_vf0dek_centered (isp, zvth2, nval, ze, zecor, pot_equil, pot_equil0, psit, ut, mut, chit, zf0)
 
real function 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) More...
 
real 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) More...
 
real 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) More...
 
real function 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) More...
 
subroutine init_numerical_f0 (isp)
 
real function evaluate_numerical_f0 (isp, psit, ut, zet)
 
real function, public get_ke (ut, mu, b)
 
real function, public get_mu (ut, ze, b)
 
real 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 function background::evaluate_numerical_f0 ( integer, intent(in)  isp,
real, intent(in)  psit,
real, intent(in)  ut,
real, intent(in)  zet 
)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ get_ke()

real function, public background::get_ke ( real, intent(in)  ut,
real, intent(in)  mu,
real, intent(in)  b 
)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ get_mu()

real function, public background::get_mu ( real, intent(in)  ut,
real, intent(in)  ze,
real, intent(in)  b 
)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ get_uabs()

real function, public background::get_uabs ( real, intent(in)  mut,
real, intent(in)  ze,
real, 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 function background::num_vf0_chi_prof_fixedmu ( integer, intent(in)  isp,
real, intent(in)  zvth2,
real, intent(in)  nval,
real, intent(in)  ze,
real, intent(in)  zecor,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  psit,
real, intent(in)  ut,
real, intent(in)  mut,
real, intent(in)  chit,
real, intent(in)  zf0,
real, 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 function background::num_vf0_psi_prof ( integer, intent(in)  isp,
real, intent(in)  zvth2,
real, intent(in)  nval,
real, intent(in)  ze,
real, intent(in)  zecor,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  psit,
real, intent(in)  ut,
real, intent(in)  mut,
real, intent(in)  chit,
real, intent(in)  zf0,
real, intent(inout)  delta_psi 
)
private

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 function background::num_vf0_psi_prof_fixedmu ( integer, intent(in)  isp,
real, intent(in)  zvth2,
real, intent(in)  nval,
real, intent(in)  ze,
real, intent(in)  zecor,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  psit,
real, intent(in)  ut,
real, intent(in)  mut,
real, intent(in)  chit,
real, intent(in)  zf0,
real, 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 function background::num_vf0dek ( integer, intent(in)  isp,
real, intent(in)  zvth2,
real, intent(in)  nval,
real, intent(in)  ze,
real, intent(in)  zecor,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  psit,
real, intent(in)  ut,
real, intent(in)  mut,
real, intent(in)  chit,
real, intent(in)  zf0,
real, 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 function background::num_vf0dek_centered ( integer, intent(in)  isp,
real, intent(in)  zvth2,
real, intent(in)  nval,
real, intent(in)  ze,
real, intent(in)  zecor,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  psit,
real, intent(in)  ut,
real, intent(in)  mut,
real, intent(in)  chit,
real, intent(in)  zf0 
)
private
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ num_vf0dek_fixedmu()

real function background::num_vf0dek_fixedmu ( integer, intent(in)  isp,
real, intent(in)  zvth2,
real, intent(in)  nval,
real, intent(in)  ze,
real, intent(in)  zecor,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  psit,
real, intent(in)  ut,
real, intent(in)  mut,
real, intent(in)  chit,
real, intent(in)  zf0,
real, 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 function background::num_vf0du ( integer, intent(in)  isp,
real, intent(in)  zvth2,
real, intent(in)  nval,
real, intent(in)  ze,
real, intent(in)  zecor,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  psit,
real, intent(in)  ut,
real, intent(in)  mut,
real, intent(in)  chit,
real, intent(in)  zf0,
real, intent(in), optional  delta_u_ 
)
private

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, intent(in)  psit,
real, intent(out)  vc,
real, intent(out)  vcgrad 
)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vf0()

real function, public background::vf0 ( integer, intent(in)  isp,
real, intent(in)  zvth2,
real, intent(in)  nval,
real, intent(in)  ze,
real, intent(in)  zecor,
real, intent(in)  b,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  psit,
real, intent(in)  ut,
real, 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 function, public background::vf0_chi_prof ( real, intent(in)  zf0,
real, intent(in)  ngrad,
real, intent(in)  epsilonhat,
real, intent(in)  ze,
real, intent(in)  b,
real, intent(in)  kappa_str,
real, intent(in)  zvth2_inv,
real, intent(in)  tgrad,
real, intent(in)  ut,
real, intent(in)  psi0_inv,
real, intent(in)  psit,
integer, intent(in)  isp,
real, intent(in)  zvth2,
real, intent(in)  nval,
real, intent(in)  zecor,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  mut,
real, 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 function, public background::vf0_local_maxwellian ( real, intent(in)  vth2,
real, intent(in)  nval,
real, 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 function, public background::vf0_psi_prof ( real, intent(in)  zf0,
real, intent(in)  ngrad,
real, intent(in)  epsilonhat,
real, intent(in)  ze,
real, intent(in)  b,
real, intent(in)  kappa_str,
real, intent(in)  zvth2_inv,
real, intent(in)  tgrad,
real, intent(in)  ut,
real, intent(in)  psi0_inv,
real, intent(in)  psit,
integer, intent(in)  isp,
real, intent(in)  zvth2,
real, intent(in)  nval,
real, intent(in)  zecor,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  mut,
real, 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:

◆ vf0dek()

real function, public background::vf0dek ( real, intent(in)  zf0,
real, intent(in)  zvth2,
real, intent(in)  ze,
real, intent(in)  psit,
integer, intent(in)  isp,
real, intent(in)  nval,
real, intent(in)  zecor,
real, intent(in)  b,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  ut,
real, intent(in)  mut,
real, 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 function, public background::vf0du ( real, intent(in)  zf0,
real, intent(in)  ut,
real, intent(in)  ze,
real, intent(in)  zvth2,
real, intent(in)  nval,
real, intent(in)  psit,
integer, intent(in)  isp,
real, intent(in)  ze1,
real, intent(in)  zecor,
real, intent(in)  pot_equil,
real, intent(in)  pot_equil0,
real, intent(in)  mut,
real, 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: