saddle_constraint Type Reference

Detailed Description

Saddle loop constraint.

Inheritance diagram for saddle_constraint:

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.
procedure	setup_comp (self)
	Setup 3D error field compensation information.

Public Attributes
integer(4), dimension(2)	cells = 0
	Needs docs.
real(8), dimension(:,:), pointer	comp_n => NULL()
	Compensation unit normal.
real(8), dimension(:,:), pointer	comp_r => NULL()
	Compensation location.
real(8), dimension(3, 2)	f = 0.d0
	Needs docs.
real(8), dimension(:), pointer	nax_corr => NULL()
	Non-axisymmetric compensations.
integer(4)	ncomp = 0
	Number of non-axisymmetric compensations.
integer(4)	nr = 10
	Needs docs.
integer(4)	nt = 10
	Needs docs.
real(8), dimension(3, 2)	r = 0.d0
	Needs docs.
real(8)	val = 0.d0
	Constraint value.
real(8)	width = 0.d0
	Needs docs.
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]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

error() [2/2]

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

Compute error.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs 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]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

eval() [2/2]

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

Evaluate constraint value.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs 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]	self	Needs docs
[in,out]	gs	Needs 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]

self

Needs docs

Returns

Needs docs

setup_comp() [1/2]

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

inherited

Setup 3D error field compensation information.

Parameters

[in,out]

self

Needs docs

setup_comp() [2/2]

procedure setup_comp

(

class(saddle_constraint), intent(inout)

self

)

Setup 3D error field compensation information.

Parameters

[in,out]

self

Needs docs

Member Data Documentation

cells

integer(4), dimension(2) cells = 0

Needs docs.

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,2) f = 0.d0

Needs docs.

nax_corr

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

inherited

Non-axisymmetric compensations.

ncomp

integer(4) ncomp = 0

inherited

Number of non-axisymmetric compensations.

nr

integer(4) nr = 10

Needs docs.

nt

integer(4) nt = 10

Needs docs.

r

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

Needs docs.

val

real(8) val = 0.d0

inherited

Constraint value.

width

real(8) width = 0.d0

Needs docs.

wt

real(8) wt = 1.d0

inherited

Constraint weight.

---

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

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