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

Public Member Functions

 ModelVmec ()
 
 ModelVmec (const ModelMetaData &md, const PhysicalGeometry &pg, const VmecData &vm)
 
const Model & getModel () const
 
const std::vector< Plane > & getPlanes () const
 

Detailed Description

Class to create a geometry based on model meta data, and vmec info. Also, properties specific to vmec, and stellarators are set in this class.

Constructor & Destructor Documentation

◆ ModelVmec() [1/2]

ModelVmec::ModelVmec ( )
inline

Constructor to create an object of ModelVmec.

◆ ModelVmec() [2/2]

ModelVmec::ModelVmec ( const ModelMetaData &  md,
const PhysicalGeometry &  pg,
const VmecData &  vm 
)

Constructor to create model based on metadata and magnetic field information.

Parameters
mdmodel metadata information to setup geometry.
physicalGeometryInformation related to phsyical geometry (wall curve for now).
vmstruct containing all the necessary vmec information for modeling.

Member Function Documentation

◆ getModel()

const Model & ModelVmec::getModel ( ) const

Function to get model associated with vmec geometry.

◆ getPlanes()

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

Function to get all the geometric information on individual planes.