dg::geo::MagneticFieldParameters Struct Reference

Meta-data about the magnetic field in particular the flux function. More...

Public Member Functions
	MagneticFieldParameters ()
	Default values are for a Toroidal field. More...
	MagneticFieldParameters (double a, double elongation, double triangularity, equilibrium equ, modifier mod, description des)
	Constructor. More...
double	a () const
	The minor radius. More...
double	elongation () const
	\( e := \frac{\max Z_{\mathrm{lcfs}} - \min Z_{\mathrm{lcfs}}}{2a}\) More...
double	triangularity () const
	\( \delta := \frac{R_0 - R_X}{a}\) More...
equilibrium	getEquilibrium () const
	the way the flux function is computed More...
modifier	getModifier () const
	the way the flux function is modified More...
description	getDescription () const
	how the flux function looks More...

Detailed Description

Meta-data about the magnetic field in particular the flux function.

The purpose of this is to give a unified set of parameters for all equilibria that can be used to stear program execution based on characteristics of the magnetic flux functions (for example double X-point vs single X-point vs no X-point)

Constructor & Destructor Documentation

MagneticFieldParameters() [1/2]

dg::geo::MagneticFieldParameters::MagneticFieldParameters ( )

inline

Default values are for a Toroidal field.

MagneticFieldParameters() [2/2]

dg::geo::MagneticFieldParameters::MagneticFieldParameters ( double  a, double  elongation, double  triangularity, equilibrium  equ, modifier  mod, description  des  )

inline

Constructor.

Parameters

a	The minor radius; the purpose of this parameter is not to be exact but to serve as a refernce of how to setup the size of a simulation box
elongation	(maximum Z - minimum Z of lcfs)/2a; 1 for a circle; the purpose of this parameter is not to be exact but more to be a reference of how to setup the aspect ratio of a simulation box
triangularity	(R_0 - R_X) /a; The purpose of this parameter is to find the approximate location of R_X (if an X-point is present, Z_X is given by elongation) the exact location can be computed by the findXpoint function
equ	the way the flux function is computed
mod	the way the flux function is modified
des	human readable descriptor of how the flux function looks

Member Function Documentation

a()

double dg::geo::MagneticFieldParameters::a ( ) const

inline

The minor radius.

the purpose of this parameter is not to be exact but to serve as a refernce of how to setup the size of a simulation box

elongation()

double dg::geo::MagneticFieldParameters::elongation ( ) const

inline

\( e := \frac{\max Z_{\mathrm{lcfs}} - \min Z_{\mathrm{lcfs}}}{2a}\)

(1 for a circle); the purpose of this parameter is not to be exact but more to be a reference of how to setup the aspect ratio of a simulation box

getDescription()

description dg::geo::MagneticFieldParameters::getDescription ( ) const

inline

how the flux function looks

getEquilibrium()

equilibrium dg::geo::MagneticFieldParameters::getEquilibrium ( ) const

inline

the way the flux function is computed

getModifier()

modifier dg::geo::MagneticFieldParameters::getModifier ( ) const

inline

the way the flux function is modified

triangularity()

double dg::geo::MagneticFieldParameters::triangularity ( ) const

inline

\( \delta := \frac{R_0 - R_X}{a}\)

The purpose of this parameter is to find the approximate location of R_X (if an X-point is present, Z_X is given by elongation) the exact location can be computed by the findXpoint function

---

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

• magnetic_field.h