MagneticGeometry Class Reference

Inheritance diagram for MagneticGeometry:

Public Member Functions
virtual	~MagneticGeometry ()=default
virtual double	getPsiAxis () const =0
virtual double	getPsiCoreBoundary () const =0
virtual ReactorType	getReactorType () const =0
virtual const std::map< int, std::vector< PhysicsPoint > > &	getOPoints () const =0
virtual const std::map< int, std::vector< PhysicsPoint > > &	getXPoints () const =0
virtual const Model &	getModel () const =0
virtual const std::vector< Plane > &	getPlanes () const =0
virtual const GridFieldData &	getGridFieldData () const =0

Constructor & Destructor Documentation

~MagneticGeometry()

virtual MagneticGeometry::~MagneticGeometry ( )

virtualdefault

Member Function Documentation

getGridFieldData()

virtual const GridFieldData & MagneticGeometry::getGridFieldData ( ) const

pure virtual

Function to return magnetic field data on the background grid.

Implemented in MagneticGeometryEqdsk, and MagneticGeometryVmec.

getModel()

virtual const Model & MagneticGeometry::getModel ( ) const

pure virtual

Function to get model associated with geometry.

Implemented in MagneticGeometryEqdsk, and MagneticGeometryVmec.

getOPoints()

virtual const std::map< int, std::vector< PhysicsPoint > > & MagneticGeometry::getOPoints ( ) const

pure virtual

Function to get a map between plane number and vector of OPoints. Key in map: plane number (id) Value in map: a vector of OPoints on the plane.

Implemented in MagneticGeometryEqdsk, and MagneticGeometryVmec.

getPlanes()

virtual const std::vector< Plane > & MagneticGeometry::getPlanes ( ) const

pure virtual

Function to get all the geometric information on individual planes.

Implemented in MagneticGeometryEqdsk, and MagneticGeometryVmec.

getPsiAxis()

virtual double MagneticGeometry::getPsiAxis ( ) const

pure virtual

A function to return psi value of the axis in the domain.

Implemented in MagneticGeometryEqdsk, and MagneticGeometryVmec.

getPsiCoreBoundary()

virtual double MagneticGeometry::getPsiCoreBoundary ( ) const

pure virtual

A function to return psi value of the xore region boundary in the domain. Mainly needed for normalization. In VMEC, its last flux curve psi. In the case of tokamaks, its innermost separatrix curve (x-point).

Implemented in MagneticGeometryEqdsk, and MagneticGeometryVmec.

getReactorType()

virtual ReactorType MagneticGeometry::getReactorType ( ) const

pure virtual

A function to return the reactor type.

Implemented in MagneticGeometryEqdsk, and MagneticGeometryVmec.

getXPoints()

virtual const std::map< int, std::vector< PhysicsPoint > > & MagneticGeometry::getXPoints ( ) const

pure virtual

Function to get a map between plane number and vector of XPoints. Key in map: plane number (id) Value in map: a vector of XPoints on the plane.

Implemented in MagneticGeometryEqdsk, and MagneticGeometryVmec.