CurveContainer Class Reference

Public Member Functions
	CurveContainer ()
	CurveContainer (std::vector< Flux > &closedCurves, std::vector< Flux > &separatrices, WallCurve &wall)
void	setCriticalPoints (const std::vector< PhysicsPoint > &oPts, const std::vector< PhysicsPoint > &xPts)
void	setOpenCurves (const std::vector< Flux > &openFluxCurves)
void	setWallEdges (const std::vector< Edge > &edgesOnWall)
std::vector< Flux > &	getCurvesClosed ()
std::vector< Flux > &	getCurvesSeparatrix ()
std::vector< Flux > &	getCurvesOpen ()
WallCurve &	getWallCurve ()
const std::vector< Edge > &	getWallEdges ()
const std::vector< PhysicsPoint > &	getOPoints () const
const std::vector< PhysicsPoint > &	getXPoints () const

Constructor & Destructor Documentation

CurveContainer() [1/2]

CurveContainer::CurveContainer ( )

inline

Default constructor.

CurveContainer() [2/2]

CurveContainer::CurveContainer	(	std::vector< Flux > &	closedCurves,
		std::vector< Flux > &	separatrices,
		WallCurve &	wall
	)

Constructor to set flux curves already been generated. Takes in set of closed flux curves, separatrices and wall curve.

Parameters

closedCurves	a vector of closed flux curves.
separatrices	a vector of separatrix curves.
wall	wall curve.

Member Function Documentation

getCurvesClosed()

std::vector< Flux > & CurveContainer::getCurvesClosed

(

)

Returns

a vector of closed flux curves in the container.

getCurvesOpen()

std::vector< Flux > & CurveContainer::getCurvesOpen

(

)

Returns

a vector of open curves in the container.

getCurvesSeparatrix()

std::vector< Flux > & CurveContainer::getCurvesSeparatrix

(

)

Returns

a vector of separatrix curves in the container.

getOPoints()

const std::vector< PhysicsPoint > & CurveContainer::getOPoints

(

)

const

Returns

a vector of O-points.

getWallCurve()

WallCurve & CurveContainer::getWallCurve

(

)

Returns

wall curve.

getWallEdges()

const std::vector< Edge > & CurveContainer::getWallEdges

(

)

Returns

a vector of model edges on the wall curve.

getXPoints()

const std::vector< PhysicsPoint > & CurveContainer::getXPoints

(

)

const

Returns

a vector of X-points.

setCriticalPoints()

void CurveContainer::setCriticalPoints	(	const std::vector< PhysicsPoint > &	oPts,
		const std::vector< PhysicsPoint > &	xPts
	)

Function to set critical points in the container.

Parameters

oPts	vector of O-points.
xPts	vector of X-points.

setOpenCurves()

void CurveContainer::setOpenCurves

(

const std::vector< Flux > &

openFluxCurves

)

Function to set open flux curves in the container.

Parameters

openFluxCurves

a vector of open flux curves.

setWallEdges()

void CurveContainer::setWallEdges

(

const std::vector< Edge > &

edgesOnWall

)

Function to set wall curve edges in the container.

Parameters

edgesOnWall

model edges on the wall curve.