FluxParametricPoints Class Reference

Public Member Functions
	FluxParametricPoints ()
	FluxParametricPoints (const Flux &flux, int pointPlacementType)
	FluxParametricPoints (const Flux &flux, const std::vector< std::vector< double > > &parValuesOnEdges)
const std::vector< Edge > &	getFluxEdges () const
const std::vector< std::vector< double > > &	getParametricValuesOnFlux () const
const std::vector< double > &	getParametricValuesAtFluxEdge (const Edge &ge) const

Detailed Description

A class to hold flux parametric points properties.

Constructor & Destructor Documentation

FluxParametricPoints() [1/3]

FluxParametricPoints::FluxParametricPoints ( )

inline

Default constructor.

FluxParametricPoints() [2/3]

FluxParametricPoints::FluxParametricPoints	(	const Flux &	flux,
		int	pointPlacementType
	)

Constructor to set parametric points on flux based on the point placement type.

Parameters

flux	input flux curve (contains all the information for points placement).
pointPlacementType	type of points placement. 0 = based on fixed distance (spcaing), = 1 based on already found field following points on flux.

FluxParametricPoints() [3/3]

FluxParametricPoints::FluxParametricPoints	(	const Flux &	flux,
		const std::vector< std::vector< double > > &	parValuesOnEdges
	)

Constructor to set parametric points on flux based on fixed parametric values one edges. No calculation is done here. We just set data to the relative model edges. Needed in stellarator case where we have parametric values on plane 0, and we need to maintain same parametric values on all the planes.

Parameters

flux	input flux curve (contains all the information for points placement).
parValuesOnEdges	parametric values on edges that need to be set on the corresponding edges on different planes.

Member Function Documentation

getFluxEdges()

const std::vector< Edge > & FluxParametricPoints::getFluxEdges

(

)

const

getParametricValuesAtFluxEdge()

const std::vector< double > & FluxParametricPoints::getParametricValuesAtFluxEdge

(

const Edge &

ge

)

const

Function to get the parametric value on a single edge.

Returns

a vector of parametric values.

getParametricValuesOnFlux()

const std::vector< std::vector< double > > & FluxParametricPoints::getParametricValuesOnFlux

(

)

const

Function to get the set of parametrix values on a flux curve.

Returns

a double vector where dimension 1 is equal to the number of model edges.