equilibrium Namespace Reference

Name space for equilibrium models. More...

Classes
class	efit
	2D EFIT equilibrium. More...
class	generic
	Class representing a generic equilibrium. More...
class	guassian_density
	Guassian density with uniform magnetic field equilibrium. More...
class	no_magnetic_field
	Uniform density with no magnetic field equilibrium. More...
class	slab
	Uniform density with varying magnetic field equilibrium. More...
class	slab_density
	Vary density with uniform magnetic field equilibrium. More...
class	slab_field
	Vary density with uniform magnetic field equilibrium. More...
class	vmec
	3D VMEC equilibrium. More...

Typedefs
template<jit::float_scalar T, bool SAFE_MATH = false>
using	shared = std::shared_ptr< generic< T, SAFE_MATH > >
	Convenience type alias for shared equilibria.

Functions
template<jit::float_scalar T, bool SAFE_MATH = false>
shared< T, SAFE_MATH >	make_no_magnetic_field ()
	Convenience function to build a no magnetic field equilibrium.
template<jit::float_scalar T, bool SAFE_MATH = false>
shared< T, SAFE_MATH >	make_slab ()
	Convenience function to build a slab equilibrium.
template<jit::float_scalar T, bool SAFE_MATH = false>
shared< T, SAFE_MATH >	make_slab_density ()
	Convenience function to build a slab density equilibrium.
template<jit::float_scalar T, bool SAFE_MATH = false>
shared< T, SAFE_MATH >	make_slab_field ()
	Convenience function to build a slab density equilibrium.
template<jit::float_scalar T, bool SAFE_MATH = false>
shared< T, SAFE_MATH >	make_guassian_density ()
	Convenience function to build a guassian density equilibrium.
template<jit::float_scalar T, bool SAFE_MATH = false>
graph::shared_leaf< T, SAFE_MATH >	build_1D_spline (graph::output_nodes< T, SAFE_MATH > c, graph::shared_leaf< T, SAFE_MATH > x, const T scale, const T offset)
	Build a 1D spline.
template<jit::float_scalar T, bool SAFE_MATH = false>
shared< T, SAFE_MATH >	make_efit (const std::string &spline_file)
	Convenience function to build an EFIT equilibrium.
template<jit::float_scalar T, bool SAFE_MATH = false>
shared< T, SAFE_MATH >	make_vmec (const std::string &spline_file)
	Convenience function to build an VMEC equilibrium.

Detailed Description

Name space for equilibrium models.

Function Documentation

build_1D_spline()

template<jit::float_scalar T, bool SAFE_MATH = false>

graph::shared_leaf< T, SAFE_MATH > equilibrium::build_1D_spline	(	graph::output_nodes< T, SAFE_MATH >	c,
		graph::shared_leaf< T, SAFE_MATH >	x,
		const T	scale,
		const T	offset
	)

Build a 1D spline.

Template Parameters

T	Base type of the calculation.
SAFE_MATH	Use Safe Math operations.

Parameters

[in]	c	Array of spline coeffiecents.
[in]	x	Spline argument.
[in]	scale	Scale factor for argument.
[in]	offset	Offset value for argument.

Returns

The graph expression for a 1D spline.

make_efit()

template<jit::float_scalar T, bool SAFE_MATH = false>

shared< T, SAFE_MATH > equilibrium::make_efit

(

const std::string &

spline_file

)

Convenience function to build an EFIT equilibrium.

Template Parameters

T	Base type of the calculation.
SAFE_MATH	Use Safe Math operations.

Parameters

[in]

spline_file

File name of contains the spline functions.

Returns

A constructed EFIT equilibrium.

make_guassian_density()

template<jit::float_scalar T, bool SAFE_MATH = false>

shared< T, SAFE_MATH > equilibrium::make_guassian_density

(

)

Convenience function to build a guassian density equilibrium.

Template Parameters

T	Base type of the calculation.
SAFE_MATH	Use Safe Math operations.

Returns

A constructed guassian density equilibrium.

make_no_magnetic_field()

template<jit::float_scalar T, bool SAFE_MATH = false>

shared< T, SAFE_MATH > equilibrium::make_no_magnetic_field

(

)

Convenience function to build a no magnetic field equilibrium.

Template Parameters

T	Base type of the calculation.
SAFE_MATH	Use Safe Math operations.

Returns

A constructed no magnetic field equilibrium.

make_slab()

template<jit::float_scalar T, bool SAFE_MATH = false>

shared< T, SAFE_MATH > equilibrium::make_slab

(

)

Convenience function to build a slab equilibrium.

Template Parameters

T	Base type of the calculation.
SAFE_MATH	Use Safe Math operations.

Returns

A constructed slab equilibrium.

make_slab_density()

template<jit::float_scalar T, bool SAFE_MATH = false>

shared< T, SAFE_MATH > equilibrium::make_slab_density

(

)

Convenience function to build a slab density equilibrium.

Template Parameters

T	Base type of the calculation.
SAFE_MATH	Use Safe Math operations.

Returns

A constructed slab density equilibrium.

make_slab_field()

template<jit::float_scalar T, bool SAFE_MATH = false>

shared< T, SAFE_MATH > equilibrium::make_slab_field

(

)

Convenience function to build a slab density equilibrium.

Template Parameters

T	Base type of the calculation.
SAFE_MATH	Use Safe Math operations.

Returns

A constructed slab density equilibrium.

make_vmec()

template<jit::float_scalar T, bool SAFE_MATH = false>

shared< T, SAFE_MATH > equilibrium::make_vmec

(

const std::string &

spline_file

)

Convenience function to build an VMEC equilibrium.

Template Parameters

T	Base type of the calculation.
SAFE_MATH	Use Safe Math operations.

Parameters

[in]

spline_file

File name of contains the spline functions.

Returns

A constructed VMEC equilibrium.