stepslant_flux_func Type Reference

Detailed Description

Needs docs.

Inheritance diagram for stepslant_flux_func:

Public Member Functions
procedure(flux_func_eval), deferred	f (self, psi)
	Evaluate function.
procedure	f (self, psi)
	Needs docs.
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	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	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	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.
procedure	update (self, gseq)
	Needs docs.

Public Attributes
real(8)	alpha = 0.d0
	Jump height.
real(8)	beta = 0.d0
real(r8)	f_offset = 0.d0
	Offset value.
integer(i4)	ncofs = 0
	Number of free coefficients.
real(r8), dimension(2)	plasma_bounds = [-1.d99,1.d99]
	Current plasma bounds (for normalization)
real(8)	sep = .5d0
	Jump location (poloidal flux)
real(8)	width = 200.d0
	Width factor for TANH.

Member Function/Subroutine Documentation

f() [1/3]

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

pure virtualinherited

Evaluate function.

f() [2/3]

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

inherited

Needs docs.

f() [3/3]

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

Needs docs.

fp() [1/3]

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/3]

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

inherited

Needs docs.

fp() [3/3]

procedure fp	(	class(stepslant_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/3]

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/3]

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

inherited

Needs docs.

get_cofs() [3/3]

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

Needs docs.

set_cofs() [1/3]

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/3]

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

inherited

Needs docs.

set_cofs() [3/3]

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

Needs docs.

update() [1/3]

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/3]

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

inherited

Needs docs.

update() [3/3]

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

Needs docs.

Member Data Documentation

alpha

real(8) alpha = 0.d0

inherited

Jump height.

beta

real(8) beta = 0.d0

f_offset

real(r8) f_offset = 0.d0

inherited

Offset value.

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)

sep

real(8) sep = .5d0

inherited

Jump location (poloidal flux)

width

real(8) width = 200.d0

inherited

Width factor for TANH.

---

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

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