ModelVmec Class Reference

Public Member Functions
	ModelVmec ()
	ModelVmec (const ModelMetaData &md, 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 VmecData &	vm
	)

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

Parameters

md	model metadata information to setup geometry.
vm	struct 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.