The Open FUSION Toolkit 1.0.0-8905cc5
Modeling tools for plasma and fusion research and engineering
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
press_constraint Type Reference

Detailed Description

Plasma pressure constraint.

Inheritance diagram for press_constraint:
Inheritance graph
[legend]

Public Member Functions

procedure error (self, gs)
 Compute error.
 
procedure error (self, gs)
 Compute error.
 
procedure eval (self, gs)
 Evaluate constraint value.
 
procedure eval (self, gs)
 Evaluate constraint value.
 
procedure get_nax (self, gs)
 Get non-axisymmetric correction.
 
procedure is_parallel (self)
 Does constraint use parallelism in calculation?
 
procedure setup_comp (self)
 Setup 3D error field compensation information.
 

Public Attributes

integer(4) cell = 0
 Cell containing point.
 
real(8), dimension(:,:), pointer comp_n => NULL()
 Compensation unit normal.
 
real(8), dimension(:,:), pointer comp_r => NULL()
 Compensation location.
 
real(8), dimension(3) f = 0.d0
 Logical coordinate of point in cell.
 
real(8), dimension(:), pointer nax_corr => NULL()
 Non-axisymmetric compensations.
 
integer(4) ncomp = 0
 Number of non-axisymmetric compensations.
 
real(8), dimension(3) r = [0.d0,0.d0,0.d0]
 Constraint location.
 
real(8) val = 0.d0
 Constraint value.
 
real(8) wt = 1.d0
 Constraint weight.
 

Member Function/Subroutine Documentation

◆ error() [1/2]

procedure error ( class(fit_constraint), intent(inout)  self,
type(gs_eq), intent(inout)  gs 
)
inherited

Compute error.

Parameters
[in,out]selfNeeds docs
[in,out]gsNeeds docs
Returns
Needs docs

◆ error() [2/2]

procedure error ( class(press_constraint), intent(inout)  self,
type(gs_eq), intent(inout)  gs 
)

Compute error.

Parameters
[in,out]selfNeeds docs
[in,out]gsNeeds docs
Returns
Needs docs

◆ eval() [1/2]

procedure eval ( class(fit_constraint), intent(inout)  self,
type(gs_eq), intent(inout)  gs 
)
inherited

Evaluate constraint value.

Parameters
[in,out]selfNeeds docs
[in,out]gsNeeds docs
Returns
Needs docs

◆ eval() [2/2]

procedure eval ( class(press_constraint), intent(inout)  self,
type(gs_eq), intent(inout)  gs 
)

Evaluate constraint value.

Parameters
[in,out]selfNeeds docs
[in,out]gsNeeds docs
Returns
Needs docs

◆ get_nax()

procedure get_nax ( class(fit_constraint), intent(inout)  self,
type(gs_eq), intent(inout)  gs 
)
inherited

Get non-axisymmetric correction.

Parameters
[in,out]selfNeeds docs
[in,out]gsNeeds docs
Returns
Needs docs

◆ is_parallel()

procedure is_parallel ( class(fit_constraint), intent(inout)  self)
inherited

Does constraint use parallelism in calculation?

Parameters
[in,out]selfNeeds docs
Returns
Needs docs

◆ setup_comp()

procedure setup_comp ( class(fit_constraint), intent(inout)  self)
inherited

Setup 3D error field compensation information.

Parameters
[in,out]selfNeeds docs

Member Data Documentation

◆ cell

integer(4) cell = 0

Cell containing point.

◆ comp_n

real(8), dimension(:,:), pointer comp_n => NULL()
inherited

Compensation unit normal.

◆ comp_r

real(8), dimension(:,:), pointer comp_r => NULL()
inherited

Compensation location.

◆ f

real(8), dimension(3) f = 0.d0

Logical coordinate of point in cell.

◆ nax_corr

real(8), dimension(:), pointer nax_corr => NULL()
inherited

Non-axisymmetric compensations.

◆ ncomp

integer(4) ncomp = 0
inherited

Number of non-axisymmetric compensations.

◆ r

real(8), dimension(3) r = [0.d0,0.d0,0.d0]

Constraint location.

◆ val

real(8) val = 0.d0
inherited

Constraint value.

◆ wt

real(8) wt = 1.d0
inherited

Constraint weight.


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