physicsAttributes.h File Reference

Functions
bool	isModelFaceOnCore (pGFace gf)
int	getNumPeriodicEdgesOnModelFace (pGFace gf)
std::vector< pGVertex >	getCriticalPointsOnModelFace (pGFace gf, PhysicsPointType pointType)
void	tagModelFacesAdjacentToXPoint (pGVertex gv, int index)
void	setFaceTagsOnInnerSeparatrix (pGVertex gv, int index)
void	setFaceTagsOnOuterSeparatrix (pGVertex gv, int index)
bool	isFaceBoundedByTwoFluxCurves (pGFace gf)
bool	compareVertexPsi (pGVertex gv1, pGVertex gv2)
std::vector< pGVertex >	getCriticalPointsOnModel (pGModel model, PhysicsPointType pointType)

Function Documentation

compareVertexPsi()

bool compareVertexPsi	(	pGVertex	gv1,
		pGVertex	gv2
	)

Function to compare psi values of two model vertices.

Parameters

gv1	model vertex 1.
gv2	model vertex 2.

Returns

true if psi value of 1 is less or equal to psi value of 2.

getCriticalPointsOnModel()

std::vector< pGVertex > getCriticalPointsOnModel	(	pGModel	model,
		PhysicsPointType	pointType
	)

Functon to return model vertices of critical points on the model.

Parameters

model	simmetrix model.
pointType	type of critical point (OPoint, XPoint).

Returns

a vector of model vertices of type pointType.

getCriticalPointsOnModelFace()

std::vector< pGVertex > getCriticalPointsOnModelFace	(	pGFace	gf,
		PhysicsPointType	pointType
	)

Function to get a vector of model vertices classified on the model face.

Parameters

gf	model face.
pointType	type of critical point (OPoint, XPoint).

Returns

a vector of model vertices of type pointType. Empty vector if finds no such point.

getNumPeriodicEdgesOnModelFace()

int getNumPeriodicEdgesOnModelFace

(

pGFace

gf

)

Function to get number of periodic model edges bounding the model face.

Parameters

gf	model face.

Returns

number of periodic edges bounding the face gf.

isFaceBoundedByTwoFluxCurves()

bool isFaceBoundedByTwoFluxCurves

(

pGFace

gf

)

Function to check if a model face is bounded by edges with two different psi values.

Parameters

gf	model face.

Returns

true if model face is bounded by edges with two different psi values, false otherwise.

isModelFaceOnCore()

bool isModelFaceOnCore

(

pGFace

gf

)

Function to check if a model face is on the core region or not.

Parameters

gf	model face.

Returns

true if model face is on the core, false otherwise.

setFaceTagsOnInnerSeparatrix()

void setFaceTagsOnInnerSeparatrix	(	pGVertex	gv,
		int	index
	)

Function to set classification on model faces adjacent to Inner X-point (primary).

Parameters

gv	x-point model vertex.
index	index of the X-point (to figure out if its primary x-point or not).

setFaceTagsOnOuterSeparatrix()

void setFaceTagsOnOuterSeparatrix	(	pGVertex	gv,
		int	index
	)

Function to set classification on model faces adjacent to outer separatrix.

Parameters

gv	x-point model vertex.
index	index of the X-point (to figure out if its primary x-point or not).

tagModelFacesAdjacentToXPoint()

void tagModelFacesAdjacentToXPoint	(	pGVertex	gv,
		int	index
	)

Function to set classification on model faces adjacent to X-point. Its top level function. Next two functions are implementation functions.

Parameters

gv	x-point model vertex.
index	index of the X-point (to figure out if its primary x-point or not).