PlaneMetaData Class Reference

Public Member Functions
	PlaneMetaData ()
	PlaneMetaData (const FluxData &f, double angle)
void	setSizeForUnstructuredMesh (double meshSize)
const std::vector< double > &	getPlaneFluxValues () const
const double &	getPlaneToroidalAngle () const
const std::vector< double > &	getPlaneFluxSizes () const
double	getNodeSpacingAtFlux (double psiNorm)
const std::vector< double > &	getNodeSpacingVector () const
const double &	getSizeForUnstructuredMesh () const

Detailed Description

The class PlaneMetaData contains the informtion on the magnetic geometry (mg), desired flux curves, and desired planes.

Constructor & Destructor Documentation

PlaneMetaData() [1/2]

PlaneMetaData::PlaneMetaData ( )

inline

PlaneMetaData() [2/2]

PlaneMetaData::PlaneMetaData	(	const FluxData &	f,
		double	angle
	)

Constructor gets the flux data (f)plane toroidal angle to setup metadata on the plane.

Parameters

f	the struct FluxData that constains the list of desired flux curves amd corresponding mesh sizes (number of desired vertices) on the flux curves.
angle	toroidal angle of the poloidal plane.

Member Function Documentation

getNodeSpacingAtFlux()

double PlaneMetaData::getNodeSpacingAtFlux

(

double

psiNorm

)

Function to get the mesh size spacing on a flux given the psi normalized value of the flux.

Parameters

psiNorm

Input psi normalized value.

Returns

mesh spacing on the flux curve with psi normalized value.

getNodeSpacingVector()

const std::vector< double > & PlaneMetaData::getNodeSpacingVector

(

)

const

Function to get full vector of spacings for all the flux curves.

getPlaneFluxSizes()

const std::vector< double > & PlaneMetaData::getPlaneFluxSizes

(

)

const

Function to return a vector of desired node spacing on each flux curve on the poloidal plane.

getPlaneFluxValues()

const std::vector< double > & PlaneMetaData::getPlaneFluxValues

(

)

const

Function to return the psi values of the desired flux curves on the poloidal plane.

getPlaneToroidalAngle()

const double & PlaneMetaData::getPlaneToroidalAngle

(

)

const

Function to return the toroidal angle of the poloidal plane.

getSizeForUnstructuredMesh()

const double & PlaneMetaData::getSizeForUnstructuredMesh

(

)

const

Get mesh size on the model faces with unstructured mesh.

setSizeForUnstructuredMesh()

void PlaneMetaData::setSizeForUnstructuredMesh

(

double

meshSize

)

Function to set mesh size on the model faces with unstructured mesh.

Parameters

meshSize

desired mesh size.