dg::geo::TokamakMagneticField Struct Reference

A tokamak field as given by R0, Psi and Ipol plus Meta-data like shape and equilibrium. More...

Public Member Functions
	TokamakMagneticField ()
	as long as the field stays empty the access functions are undefined
	TokamakMagneticField (double R0, const CylindricalFunctorsLvl2 &psip, const CylindricalFunctorsLvl1 &ipol, MagneticFieldParameters gp)
void	set (double R0, const CylindricalFunctorsLvl2 &psip, const CylindricalFunctorsLvl1 &ipol, MagneticFieldParameters gp)
double	R0 () const
	\( R_0 \)
const CylindricalFunctor &	psip () const
	\( \psi_p(R,Z)\), where R, Z are cylindrical coordinates
const CylindricalFunctor &	psipR () const
	\( \partial_R \psi_p(R,Z)\), where R, Z are cylindrical coordinates
const CylindricalFunctor &	psipZ () const
	\( \partial_Z \psi_p(R,Z)\), where R, Z are cylindrical coordinates
const CylindricalFunctor &	psipRR () const
	\( \partial_R\partial_R \psi_p(R,Z)\), where R, Z are cylindrical coordinates
const CylindricalFunctor &	psipRZ () const
	\( \partial_R\partial_Z \psi_p(R,Z)\), where R, Z are cylindrical coordinates
const CylindricalFunctor &	psipZZ () const
	\( \partial_Z\partial_Z \psi_p(R,Z)\), where R, Z are cylindrical coordinates
const CylindricalFunctor &	ipol () const
	\( I(\psi_p) \) the current
const CylindricalFunctor &	ipolR () const
	\( \partial_R I(\psi_p) \)
const CylindricalFunctor &	ipolZ () const
	\( \partial_Z I(\psi_p) \)
const CylindricalFunctorsLvl2 &	get_psip () const
const CylindricalFunctorsLvl1 &	get_ipol () const
const MagneticFieldParameters &	params () const
	Access Meta-data of the field.

Detailed Description

A tokamak field as given by R0, Psi and Ipol plus Meta-data like shape and equilibrium.

This is the representation of toroidally axisymmetric magnetic fields that can be modeled in the description \( \vec B(R,Z,\varphi) = \frac{R_0}{R} \left( I(\psi_p) \hat e_\varphi + \nabla \psi_p \times \hat e_\varphi\right) \) where \( R_0\) is a normalization constant, \( I\) the poloidal current and \( \psi_p\) the poloidal flux function.

    const dg::x::CylindricalGrid3d g3d( R_0-a, R_0+a, -a, a, 0, 2.*M_PI, n, Nx, Ny, Nz, dg::NEU, dg::NEU, dg::PER
#ifdef WITH_MPI
    , comm
#endif
    );
    //create magnetic field
    const dg::geo::TokamakMagneticField mag = dg::geo::createCircularField( R_0, I_0);
    auto bhat = dg::geo::createBHat(mag);
    //create Fieldaligned object and construct DS from it
    dg::geo::Fieldaligned<dg::x::aProductGeometry3d,dg::x::IDMatrix,dg::x::DVec>  dsFA(
            bhat, g3d, dg::NEU, dg::NEU, dg::geo::NoLimiter(), 1e-8, mx[0], mx[1],
            -1, method);
    dg::geo::DS<dg::x::aProductGeometry3d, dg::x::IDMatrix, dg::x::DVec>
        ds( dsFA );

Constructor & Destructor Documentation

TokamakMagneticField() [1/2]

dg::geo::TokamakMagneticField::TokamakMagneticField ( )

inline

as long as the field stays empty the access functions are undefined

TokamakMagneticField() [2/2]

dg::geo::TokamakMagneticField::TokamakMagneticField ( double R0, const CylindricalFunctorsLvl2 & psip, const CylindricalFunctorsLvl1 & ipol, MagneticFieldParameters gp )

inline

Member Function Documentation

get_ipol()

const CylindricalFunctorsLvl1 & dg::geo::TokamakMagneticField::get_ipol ( ) const

inline

get_psip()

const CylindricalFunctorsLvl2 & dg::geo::TokamakMagneticField::get_psip ( ) const

inline

ipol()

const CylindricalFunctor & dg::geo::TokamakMagneticField::ipol ( ) const

inline

\( I(\psi_p) \) the current

ipolR()

const CylindricalFunctor & dg::geo::TokamakMagneticField::ipolR ( ) const

inline

\( \partial_R I(\psi_p) \)

ipolZ()

const CylindricalFunctor & dg::geo::TokamakMagneticField::ipolZ ( ) const

inline

\( \partial_Z I(\psi_p) \)

params()

const MagneticFieldParameters & dg::geo::TokamakMagneticField::params ( ) const

inline

Access Meta-data of the field.

Returns

Meta-data

psip()

const CylindricalFunctor & dg::geo::TokamakMagneticField::psip ( ) const

inline

\( \psi_p(R,Z)\), where R, Z are cylindrical coordinates

psipR()

const CylindricalFunctor & dg::geo::TokamakMagneticField::psipR ( ) const

inline

\( \partial_R \psi_p(R,Z)\), where R, Z are cylindrical coordinates

psipRR()

const CylindricalFunctor & dg::geo::TokamakMagneticField::psipRR ( ) const

inline

\( \partial_R\partial_R \psi_p(R,Z)\), where R, Z are cylindrical coordinates

psipRZ()

const CylindricalFunctor & dg::geo::TokamakMagneticField::psipRZ ( ) const

inline

\( \partial_R\partial_Z \psi_p(R,Z)\), where R, Z are cylindrical coordinates

psipZ()

const CylindricalFunctor & dg::geo::TokamakMagneticField::psipZ ( ) const

inline

\( \partial_Z \psi_p(R,Z)\), where R, Z are cylindrical coordinates

psipZZ()

const CylindricalFunctor & dg::geo::TokamakMagneticField::psipZZ ( ) const

inline

\( \partial_Z\partial_Z \psi_p(R,Z)\), where R, Z are cylindrical coordinates

R0()

double dg::geo::TokamakMagneticField::R0 ( ) const

inline

\( R_0 \)

set()

void dg::geo::TokamakMagneticField::set ( double R0, const CylindricalFunctorsLvl2 & psip, const CylindricalFunctorsLvl1 & ipol, MagneticFieldParameters gp )

inline

---

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

• magnetic_field.h