The Open FUSION Toolkit 1.0.0-6f445ef
An open-source framework for fusion and plasma science and engineering
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
dipole_ani_press Type Referenceabstract

Detailed Description

Needs docs.

Inheritance diagram for dipole_ani_press:
Inheritance graph
[legend]

Public Member Functions

procedure(ani_press_copy), deferred copy (self, new, new_gs)
 Copy object.
 
procedure copy (self, new, new_gs)
 Needs docs.
 
procedure delete (self)
 Delete reconstruction object.
 
procedure delete (self)
 Needs docs.
 
procedure(oft_bfem_interp), deferred interp (self, cell, f, gop, val)
 Reconstruct field.
 
procedure interp (self, cell, f, gop, val)
 Evaluate field.
 
procedure setup (self, gs)
 Needs docs.
 
procedure(ani_press_update), deferred update (self, gseq)
 Needs docs.
 
procedure update (self, gseq)
 Needs Docs.
 

Public Attributes

real(r8a_exp = 0.d0
 Anisotropy exponent for mirror pressure profiles.
 
class(flux_func), pointer b0_prof => NULL()
 Dipole minimum B profile.
 
integer(i4dim = 0
 Dimension of field.
 
type(gs_equil), pointer gs => NULL()
 Equilibrium object.
 
class(oft_bmesh), pointer mesh => NULL()
 Mesh for interpolation.
 
class(bfem_interp), pointer parent => NULL()
 Parent interpolator.
 
type(oft_lag_brinterp), pointer psi_eval => NULL()
 Needs docs.
 
type(oft_lag_bginterp), pointer psi_geval => NULL()
 Needs docs.
 

Member Function/Subroutine Documentation

◆ copy() [1/2]

procedure(ani_press_copy), deferred copy ( class(gs_ani_press), intent(inout)  self,
class(gs_ani_press), intent(inout), pointer  new,
class(gs_equil), intent(inout), target  new_gs 
)
pure virtualinherited

Copy object.

◆ copy() [2/2]

procedure copy ( class(dipole_ani_press), intent(inout)  self,
class(gs_ani_press), intent(inout), pointer  new,
class(gs_equil), intent(inout), target  new_gs 
)

Needs docs.

◆ delete() [1/2]

procedure delete ( class(bfem_interp), intent(inout)  self)
inherited

Delete reconstruction object.

◆ delete() [2/2]

procedure delete ( class(dipole_ani_press), intent(inout)  self)

Needs docs.

◆ interp() [1/2]

procedure(oft_bfem_interp), deferred interp ( class(bfem_interp), intent(inout)  self,
integer(i4), intent(in)  cell,
real(r8), dimension(:), intent(in)  f,
real(r8), dimension(3,3), intent(in)  gop,
real(r8), dimension(:), intent(out)  val 
)
pure virtualinherited

Reconstruct field.

◆ interp() [2/2]

procedure interp ( class(dipole_ani_press), intent(inout)  self,
integer(4), intent(in)  cell,
real(8), dimension(:), intent(in)  f,
real(8), dimension(3,3), intent(in)  gop,
real(8), dimension(:), intent(out)  val 
)

Evaluate field.

Parameters
[in,out]selfInterpolation object
[in]cellCell for interpolation
[in]fPosition in cell in logical coord [3]
[in]gopLogical gradient vectors at f [3,3]
[out]valReconstructed [p_par, p_perp] factors [2]

◆ setup()

procedure setup ( class(dipole_ani_press), intent(inout)  self,
class(gs_equil), intent(inout), target  gs 
)

Needs docs.

◆ update() [1/2]

procedure(ani_press_update), deferred update ( class(gs_ani_press), intent(inout)  self,
class(gs_equil), intent(inout)  gseq 
)
pure virtualinherited

Needs docs.

◆ update() [2/2]

procedure update ( class(dipole_ani_press), intent(inout)  self,
class(gs_equil), intent(inout)  gseq 
)

Needs Docs.

Member Data Documentation

◆ a_exp

real(r8) a_exp = 0.d0

Anisotropy exponent for mirror pressure profiles.

◆ b0_prof

class(flux_func), pointer b0_prof => NULL()

Dipole minimum B profile.

◆ dim

integer(i4) dim = 0
inherited

Dimension of field.

◆ gs

type(gs_equil), pointer gs => NULL()
inherited

Equilibrium object.

◆ mesh

class(oft_bmesh), pointer mesh => NULL()
inherited

Mesh for interpolation.

◆ parent

class(bfem_interp), pointer parent => NULL()
inherited

Parent interpolator.

◆ psi_eval

type(oft_lag_brinterp), pointer psi_eval => NULL()

Needs docs.

◆ psi_geval

type(oft_lag_bginterp), pointer psi_geval => NULL()

Needs docs.


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