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

Public Member Functions

void setModelPlane (const Plane &p)
 
const std::vector< Face > & getModelFacesOnPlane ()
 
const std::vector< int > & getFaceMeshType ()
 
const std::vector< Flux > & getFluxCurvesOnPlane ()
 
const std::vector< FluxParametricPoints > & getMeshVerticesOnFlux () const
 
const VertexgetOPointOnPlane ()
 
const int & getPlaneNumber ()
 
const double & getUnstructuredMeshSizeOnPlane () const
 
double getMeshSizeOnModelFace (const Face &f)
 

Member Function Documentation

◆ getFaceMeshType()

const std::vector< int > & PlaneMeshMetaData::getFaceMeshType ( )

Function to get the vector holding the mesh type for each individual model face on the plane.

◆ getFluxCurvesOnPlane()

const std::vector< Flux > & PlaneMeshMetaData::getFluxCurvesOnPlane ( )

Function to get a vector of flux curves on the poloidal plane.

◆ getMeshSizeOnModelFace()

double PlaneMeshMetaData::getMeshSizeOnModelFace ( const Face f)

Function to get mesh size on the model face of the plane.

Parameters
fmodel face on which mesh size is desired.
Returns
mesh size desired on the model face.

◆ getMeshVerticesOnFlux()

const std::vector< FluxParametricPoints > & PlaneMeshMetaData::getMeshVerticesOnFlux ( ) const

Function to get a vector of set of the class FluxParametricPoints. This vector is equal to the number of the flux curves. Each member contains the details of the field following points parametric values.

◆ getModelFacesOnPlane()

const std::vector< Face > & PlaneMeshMetaData::getModelFacesOnPlane ( )

Function to return the vector of model faces on the particular poloidal plane.

◆ getOPointOnPlane()

const Vertex & PlaneMeshMetaData::getOPointOnPlane ( )

Function to get model vertex on oPoint of the poloidal plane.

◆ getPlaneNumber()

const int & PlaneMeshMetaData::getPlaneNumber ( )

Function to get poloidal plane number.

◆ getUnstructuredMeshSizeOnPlane()

const double & PlaneMeshMetaData::getUnstructuredMeshSizeOnPlane ( ) const

Function to get unstructured mesh size on the plane.

◆ setModelPlane()

void PlaneMeshMetaData::setModelPlane ( const Plane p)

Function to set the model plane in data.

Parameters
pInput plane information from StommsModel.