MagneticGeometryForTokamak Class Reference

Inheritance diagram for MagneticGeometryForTokamak:

Public Member Functions
	MagneticGeometryForTokamak (const ModelMetaData &modelMetaData, const WallCurve &wall, const Inputs &input)
double	getPsiAxis () const override
double	getPsiCoreBoundary () const override
ReactorType	getReactorType () const override
const std::map< int, std::vector< PhysicsPoint > > &	getOPoints () const override
const std::map< int, std::vector< PhysicsPoint > > &	getXPoints () const override
const Model &	getModel () const override
const std::vector< Plane > &	getPlanes () const override
Public Member Functions inherited from MagneticGeometry
virtual	~MagneticGeometry ()=default

Detailed Description

A class to hold magnetic geometry of tokamaks along with the construction of actual geometry (model).

Constructor & Destructor Documentation

MagneticGeometryForTokamak()

MagneticGeometryForTokamak::MagneticGeometryForTokamak	(	const ModelMetaData &	modelMetaData,
		const WallCurve &	wall,
		const Inputs &	input
	)

Constructor to set magnetic geometry information from tokamak to class MagneticGeometry.

Parameters

wall	phsyical wall curve of the reactor. Needed for critical point search and flux curves (open and separatrix) generation.
input	class holding all the input data.

Member Function Documentation

getModel()

const Model & MagneticGeometryForTokamak::getModel ( ) const

overridevirtual

Function to get model associated with tokamak geometry.

Implements MagneticGeometry.

getOPoints()

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

overridevirtual

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.

Implements MagneticGeometry.

getPlanes()

const std::vector< Plane > & MagneticGeometryForTokamak::getPlanes ( ) const

overridevirtual

Function to get all the geometric information on individual planes. Only one plane for tokamaks.

Implements MagneticGeometry.

getPsiAxis()

double MagneticGeometryForTokamak::getPsiAxis ( ) const

overridevirtual

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

Returns

psi value of the axis.

Implements MagneticGeometry.

getPsiCoreBoundary()

double MagneticGeometryForTokamak::getPsiCoreBoundary ( ) const

overridevirtual

A function to return psi value at the boundary of core region.

Implements MagneticGeometry.

getReactorType()

ReactorType MagneticGeometryForTokamak::getReactorType ( ) const

inlineoverridevirtual

A fucntion to get the reactor type of geometry (stellarator/tokamak).

Implements MagneticGeometry.

getXPoints()

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

overridevirtual

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.

Implements MagneticGeometry.