MagneticGeometryVmec Class Reference

Inheritance diagram for MagneticGeometryVmec:

Public Member Functions
	MagneticGeometryVmec (const ModelMetaData &md, const std::string &vmecFileName)
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
const GridFieldData &	getGridFieldData () const override
Public Member Functions inherited from MagneticGeometry
virtual	~MagneticGeometry ()=default

Detailed Description

A class to hold magnetic geometry of stellarators core from VMEC along with the construction of actual geometry (model).

Constructor & Destructor Documentation

MagneticGeometryVmec()

MagneticGeometryVmec::MagneticGeometryVmec	(	const ModelMetaData &	md,
		const std::string &	vmecFileName
	)

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

Parameters

md	metadata needed for geometry construction.
vmecFileName	vmec file name containing all the vmec data.

Member Function Documentation

getGridFieldData()

const GridFieldData & MagneticGeometryVmec::getGridFieldData ( ) const

overridevirtual

Function to return magnetic field data on the background grid.

Implements MagneticGeometry.

getModel()

const Model & MagneticGeometryVmec::getModel ( ) const

overridevirtual

Function to get model associated with stellarator geometry.

Implements MagneticGeometry.

getOPoints()

const std::map< int, std::vector< PhysicsPoint > > & MagneticGeometryVmec::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 > & MagneticGeometryVmec::getPlanes ( ) const

overridevirtual

Function to get all the geometric information on individual planes.

Implements MagneticGeometry.

getPsiAxis()

double MagneticGeometryVmec::getPsiAxis ( ) const

overridevirtual

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

Implements MagneticGeometry.

getPsiCoreBoundary()

double MagneticGeometryVmec::getPsiCoreBoundary ( ) const

overridevirtual

A function to return psi value of the last closed flux curve in the vmec domain.

Implements MagneticGeometry.

getReactorType()

ReactorType MagneticGeometryVmec::getReactorType ( ) const

overridevirtual

Return the reactor type(Stellarator for this class).

Implements MagneticGeometry.

getXPoints()

const std::map< int, std::vector< PhysicsPoint > > & MagneticGeometryVmec::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.