wesson_flux_func Type Reference

Detailed Description

Needs docs.

Inheritance diagram for wesson_flux_func:

Public Member Functions
procedure(flux_func_eval), deferred	f (self, psi)
	Evaluate function.
procedure	f (self, psi)
	Needs docs.
procedure(flux_func_eval), deferred	fp (self, psi)
	Evaluate first derivative of function.
procedure	fp (self, psi)
	Needs docs.
procedure	fpp (self, psi)
	Evaluate second derivative of function.
procedure(flux_cofs_get), deferred	get_cofs (self, c)
	Get current function parameterization.
procedure	get_cofs (self, c)
	Needs docs.
procedure(flux_cofs_set), deferred	set_cofs (self, c)
	Update function with new parameterization.
procedure	set_cofs (self, c)
	Needs docs.
procedure(flux_func_update), deferred	update (self, gseq)
	Update function to match new equilibrium solution.
procedure	update (self, gseq)
	Needs docs.

Public Attributes
real(r8)	f_offset = 0.d0
	Offset value.
real(8)	gamma = 0.d0
integer(i4)	ncofs = 0
	Number of free coefficients.
real(r8), dimension(2)	plasma_bounds = [-1.d99,1.d99]
	Current plasma bounds (for normalization)

Member Function/Subroutine Documentation

f() [1/2]

procedure(flux_func_eval), deferred f ( class(flux_func), intent(inout)  self, real(r8), intent(in)  psi  )

pure virtualinherited

Evaluate function.

f() [2/2]

procedure f	(	class(wesson_flux_func), intent(inout)	self,
		real(8), intent(in)	psi
	)

Needs docs.

fp() [1/2]

procedure(flux_func_eval), deferred fp ( class(flux_func), intent(inout)  self, real(r8), intent(in)  psi  )

pure virtualinherited

Evaluate first derivative of function.

fp() [2/2]

procedure fp	(	class(wesson_flux_func), intent(inout)	self,
		real(8), intent(in)	psi
	)

Needs docs.

fpp()

procedure fpp ( class(flux_func), intent(inout)  self, real(r8), intent(in)  psi  )

inherited

Evaluate second derivative of function.

get_cofs() [1/2]

procedure(flux_cofs_get), deferred get_cofs ( class(flux_func), intent(inout)  self, real(r8), dimension(:), intent(out)  c  )

pure virtualinherited

Get current function parameterization.

get_cofs() [2/2]

procedure get_cofs	(	class(wesson_flux_func), intent(inout)	self,
		real(8), dimension(:), intent(out)	c
	)

Needs docs.

set_cofs() [1/2]

procedure(flux_cofs_set), deferred set_cofs ( class(flux_func), intent(inout)  self, real(r8), dimension(:), intent(in)  c  )

pure virtualinherited

Update function with new parameterization.

set_cofs() [2/2]

procedure set_cofs	(	class(wesson_flux_func), intent(inout)	self,
		real(8), dimension(:), intent(in)	c
	)

Needs docs.

update() [1/2]

procedure(flux_func_update), deferred update ( class(flux_func), intent(inout)  self, class(gs_eq), intent(inout)  gseq  )

pure virtualinherited

Update function to match new equilibrium solution.

update() [2/2]

procedure update	(	class(wesson_flux_func), intent(inout)	self,
		class(gs_eq), intent(inout)	gseq
	)

Needs docs.

Member Data Documentation

f_offset

real(r8) f_offset = 0.d0

inherited

Offset value.

gamma

real(8) gamma = 0.d0

ncofs

integer(i4) ncofs = 0

inherited

Number of free coefficients.

plasma_bounds

real(r8), dimension(2) plasma_bounds = [-1.d99,1.d99]

inherited

Current plasma bounds (for normalization)

---

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

• /home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/physics/grad_shaf_profiles.F90