oft_taylor_hmodes Type Reference

Detailed Description

Force-free, uniform \( \lambda \) eigenmode object.

Used to compute/store force-free solutions to the eigenproblem [$ \nabla \times \nabla \times A = \lambda \nabla \times A ]$.

Public Member Functions
procedure	delete (self, storage_only)
	Destory/reset object.
procedure	setup (self, ml_hcurl, ml_lagrange, minlev, htor_axis)
	Setup object before solution.

Public Attributes
type(oft_vector_ptr), dimension(:,:), pointer	hffa => NULL()
	Vector potential for each mode/level [nm,nlevels].
real(r8), dimension(:,:), pointer	hlam => NULL()
	Lambda values for each mode/level [nm,nlevels].
real(r8), dimension(:,:), pointer	htor => NULL()
	Toroidal flux for each mode/level [nm,nlevels].
integer(i4)	htor_axis = 3
	Index of coordinate to use as axis for toroidal flux calculation.
integer(i4)	minlev = -1
	Lowest FE level for multi-level solvers (-1 indicates single level solve)
type(oft_ml_fem_type), pointer	ml_hcurl => NULL()
	Multi-level H(Curl) FE object.
type(oft_ml_fem_type), pointer	ml_lagrange => NULL()
	Multi-level Lagrange FE object.
integer(i4)	nm = 0
	Number of force-free fields computed (see taylor_hmodes)
type(oft_hcurl_orthog), pointer	orthog => NULL()
	Orthogonalization operator.

Member Function/Subroutine Documentation

delete()

procedure delete	(	class(oft_taylor_hmodes), intent(inout)	self,
		logical, intent(in), optional	storage_only
	)

Destory/reset object.

Parameters

[in,out]	self	Force-free eigenmode object
[in]	storage_only	Only reset storage, but do not clear references

setup()

procedure setup	(	class(oft_taylor_hmodes), intent(inout)	self,
		type(oft_ml_fem_type), intent(in), optional, target	ml_hcurl,
		type(oft_ml_fem_type), intent(in), optional, target	ml_lagrange,
		integer(i4), intent(in), optional	minlev,
		integer(i4), intent(in), optional	htor_axis
	)

Setup object before solution.

Parameters

[in,out]	self	Force-free eigenmode object
[in]	ml_hcurl	Multi-level H(Curl) FE representation
[in]	ml_lagrange	Multi-level Lagrange FE representation

Member Data Documentation

hffa

type(oft_vector_ptr), dimension(:,:), pointer hffa => NULL()

Vector potential for each mode/level [nm,nlevels].

hlam

real(r8), dimension(:,:), pointer hlam => NULL()

Lambda values for each mode/level [nm,nlevels].

htor

real(r8), dimension(:,:), pointer htor => NULL()

Toroidal flux for each mode/level [nm,nlevels].

htor_axis

integer(i4) htor_axis = 3

Index of coordinate to use as axis for toroidal flux calculation.

minlev

integer(i4) minlev = -1

Lowest FE level for multi-level solvers (-1 indicates single level solve)

ml_hcurl

type(oft_ml_fem_type), pointer ml_hcurl => NULL()

Multi-level H(Curl) FE object.

ml_lagrange

type(oft_ml_fem_type), pointer ml_lagrange => NULL()

Multi-level Lagrange FE object.

nm

integer(i4) nm = 0

Number of force-free fields computed (see taylor_hmodes)

orthog

type(oft_hcurl_orthog), pointer orthog => NULL()

Orthogonalization operator.

---

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

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