Stellarator and Tokamak Modeling and Meshing Software (STOMMS)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
StommsModel Class Reference

Public Member Functions

 StommsModel (std::shared_ptr< MagneticGeometry > mg)
 
const std::vector< Plane > & getPlanes ()
 
const ModelgetModel ()
 

Constructor & Destructor Documentation

◆ StommsModel()

StommsModel::StommsModel ( std::shared_ptr< MagneticGeometry mg)

Constructor gets the model meta data and uses it to setup StommsModel.

Parameters
mgmagnetic geometry (vmec, eqdsk, bmw etc.) with underlying model information.

Member Function Documentation

◆ getModel()

const Model & StommsModel::getModel ( )

Function to return the underlying model in StommsModel.

◆ getPlanes()

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

Function to return the vector containing all the planes with their geometric data.