Plane Class Reference

Public Member Functions
void	setFieldPointsOnFlux (const std::vector< FluxParametricPoints > &fieldPoints)
void	setModelEntitiesFromModelFaces (const std::vector< Face > &modelFaces)
void	setXPoint (const pGVertex &gv)
void	setXPoint (const Vertex &v)
void	setUnstructuredMeshSizeOnPlane (double meshSize)
void	setMeshSizeOnModelFaces (const std::unordered_map< int, double > &meshSizeOnF)
const std::vector< FluxParametricPoints > &	getFieldPointsOnFluxCurves () const
const std::vector< Edge > &	getModelEdgesOnPlane () const
const std::vector< Vertex > &	getModelVerticesOnPlane () const
const std::vector< Vertex > &	getXPointsOnPlane () const
const double &	getUnstructuredMeshSizeOnPlane () const
const std::unordered_map< int, double > &	getMeshSizesOnModelFaces ()

Public Attributes
std::vector< Face >	modelFaces
std::vector< Flux >	fluxCurves
std::vector< Edge >	wallEdges
Vertex	oPoint
int	planeNumber

Detailed Description

A class to define geometric model on a plane.

Member Function Documentation

getFieldPointsOnFluxCurves()

const std::vector< FluxParametricPoints > & Plane::getFieldPointsOnFluxCurves

(

)

const

Function to get a vector of class that holds field following points info.

Returns

a vector of class FluxParametricPoints.

getMeshSizesOnModelFaces()

const std::unordered_map< int, double > & Plane::getMeshSizesOnModelFaces

(

)

Function to get unstructured mesh size on each model face.

Returns

a map between model face tag (int) and mesh sizes.

getModelEdgesOnPlane()

const std::vector< Edge > & Plane::getModelEdgesOnPlane

(

)

const

Function to get a vector of model edges on the plane.

Returns

a vector of model edges on the plane

getModelVerticesOnPlane()

const std::vector< Vertex > & Plane::getModelVerticesOnPlane

(

)

const

Function to get a vector of model vertices on the plane.

Returns

a vector of model vertices on the plane

getUnstructuredMeshSizeOnPlane()

const double & Plane::getUnstructuredMeshSizeOnPlane

(

)

const

Function to return desired mesh size of unstructured mesh faces.

getXPointsOnPlane()

const std::vector< Vertex > & Plane::getXPointsOnPlane

(

)

const

Function to get a vector of model vertices classified as xpoints.

Returns

a vector of model vertices on the plane classified as xpoints.

setFieldPointsOnFlux()

void Plane::setFieldPointsOnFlux

(

const std::vector< FluxParametricPoints > &

fieldPoints

)

Function to set field following points on all the flux curves of the plane.

Parameters

fieldPoints

a vector of the class that holds field following points info.

setMeshSizeOnModelFaces()

void Plane::setMeshSizeOnModelFaces

(

const std::unordered_map< int, double > &

meshSizeOnF

)

Function to set model sizes on the model faces of the plane.

Parameters

meshSizeOnF

a map between model face tag (int) and mesh sizes.

setModelEntitiesFromModelFaces()

void Plane::setModelEntitiesFromModelFaces

(

const std::vector< Face > &

modelFaces

)

Function to set model vertices and edges from the set of model faces. Uses downward adjacencies functions from Simmetrix.

Parameters

modelFaces

a vector of model faces on the poloidal plane.

setUnstructuredMeshSizeOnPlane()

void Plane::setUnstructuredMeshSizeOnPlane

(

double

meshSize

)

Function to set desired mesh size on unstructured mesh faces.

Parameters

meshSize

desired mesh size on the model faces.

setXPoint() [1/2]

void Plane::setXPoint

(

const pGVertex &

gv

)

Function to set x-point (push back to xpoint vector in the class).

Parameters

gv	Simmetrix mesh vertex.

setXPoint() [2/2]

void Plane::setXPoint

(

const Vertex &

v

)

Function to set x-point (push back to xpoint vector in the class).

Parameters

v	STOMMS local mesh vertex.

Member Data Documentation

fluxCurves

std::vector<Flux> Plane::fluxCurves

modelFaces

std::vector<Face> Plane::modelFaces

oPoint

Vertex Plane::oPoint

planeNumber

int Plane::planeNumber

wallEdges

std::vector<Edge> Plane::wallEdges