Inputs Class Reference

Public Member Functions
	Inputs ()
const std::string &	getLimiterFile () const
const std::string &	getVmecFile () const
const InputData &	getInputData () const
const ReactorType &	getReactorType () const
const bool &	useReversePsi () const
const int &	getNumTokamakPlanes () const
const bool &	useInboardStart () const
const bool &	useFluxRandomStart () const
const double &	getStepRadians () const
const double &	getPsiTolerance () const
const double &	getSpacingToleranceOptimal () const
const double &	getSpacingToleranceAbsolute () const
const bool &	useIntraCurveSpacingSmallVariation () const
const bool &	useZeroXptWall () const
const int &	getIntraCurveSpacingOption () const
const double &	getIntraCurveMinLengthLastEdge () const
const double &	getMeshSizeUnstructured () const
const double &	getIntraCurveSpacingPropFacMax () const
const double &	getIntraCurveSpacingPropFacMin () const
const double &	getLastClosedPsi () const
const bool &	useWallCurve () const

Constructor & Destructor Documentation

Inputs()

Inputs::Inputs

(

)

Member Function Documentation

getInputData()

const InputData & Inputs::getInputData

(

)

const

getIntraCurveMinLengthLastEdge()

const double & Inputs::getIntraCurveMinLengthLastEdge

(

)

const

Function to get length of smallest last mesh edge on a curve.

getIntraCurveSpacingOption()

const int & Inputs::getIntraCurveSpacingOption

(

)

const

Function to get intra curve spacing options.

getIntraCurveSpacingPropFacMax()

const double & Inputs::getIntraCurveSpacingPropFacMax

(

)

const

Function to get intra curve spacing proportional factor (max)

getIntraCurveSpacingPropFacMin()

const double & Inputs::getIntraCurveSpacingPropFacMin

(

)

const

Function to get intra curve spacing proportional factor (min)

getLastClosedPsi()

const double & Inputs::getLastClosedPsi

(

)

const

Function to get last closed psi value for zero x-point case.

getLimiterFile()

const std::string & Inputs::getLimiterFile

(

)

const

getMeshSizeUnstructured()

const double & Inputs::getMeshSizeUnstructured

(

)

const

Function to get mesh size on unstructured mesh faces.

getNumTokamakPlanes()

const int & Inputs::getNumTokamakPlanes

(

)

const

Returns the number of tokamak planes for magnetic field line tracing.

getPsiTolerance()

const double & Inputs::getPsiTolerance

(

)

const

Function to get psi tolerance.

getReactorType()

const ReactorType & Inputs::getReactorType

(

)

const

getSpacingToleranceAbsolute()

const double & Inputs::getSpacingToleranceAbsolute

(

)

const

Function to psi spacing tolerance absolute.

getSpacingToleranceOptimal()

const double & Inputs::getSpacingToleranceOptimal

(

)

const

Function to psi spacing tolerance optimal.

getStepRadians()

const double & Inputs::getStepRadians

(

)

const

Function to get step size in radians.

getVmecFile()

const std::string & Inputs::getVmecFile

(

)

const

useFluxRandomStart()

const bool & Inputs::useFluxRandomStart

(

)

const

Function to check if to use random flux start or not. Default is random for closed flux curves.

useInboardStart()

const bool & Inputs::useInboardStart

(

)

const

Function to check if to use inboard flux start or not. Default is outboard plane.

useIntraCurveSpacingSmallVariation()

const bool & Inputs::useIntraCurveSpacingSmallVariation

(

)

const

Function to check if to use small variation intra curve spacing or not.

useReversePsi()

const bool & Inputs::useReversePsi

(

)

const

useWallCurve()

const bool & Inputs::useWallCurve

(

)

const

Function to check if model needs to be bounded by wall curve or last closed flux curve. Default is to use the wall curve. Only valid for zero Xpt cases.

useZeroXptWall()

const bool & Inputs::useZeroXptWall

(

)

const

Function to check if to use wall curve in zero Xpt cases or not.