Stellarator and Tokamak Modeling and Meshing Software (STOMMS)
Loading...
Searching...
No Matches
Classes | Functions
fieldPointsOnFlux.h File Reference

Classes

class  FluxParametricPoints
 

Functions

std::vector< std::vector< double > > setVerticesParValuesOnFlux (const Flux &f, int type)
 
std::vector< std::vector< double > > setVerticesParValuesUsingDistance (const Flux &f)
 
std::vector< std::vector< double > > setVerticesParValuesUsingPoints (const Flux &f)
 
std::vector< std::vector< double > > setParOnClosedFluxUsingDistance (const Flux &f)
 
std::vector< std::vector< double > > setParOnFluxUsingPoints (const Flux &f)
 
double getNextParamPointForDist (const Edge &ge, double parStart, double parEnd, double targetLength)
 

Function Documentation

◆ getNextParamPointForDist()

double getNextParamPointForDist ( const Edge ge,
double  parStart,
double  parEnd,
double  targetLength 
)

Gets the next parametric value on a flux curve based on starting point on the model edge and target length.

Parameters
geedge on which parametric value is being calculated.
parStartstarting point on the model edge. Need to walk targetLength along the edge from this point.
parEndparametric value of end point on the model edge. Need this to make sure we move towards right direction.
targetLengthdistance to be moved.
Returns
parametric value of new point on the modele edge.

◆ setParOnClosedFluxUsingDistance()

std::vector< std::vector< double > > setParOnClosedFluxUsingDistance ( const Flux f)

Function to set parametric values on a closd flux based on a given fixed distance (spacing between points). Low level function for the actual implementation.

Parameters
fluxinput flux curve.
Returns
a double vector where dimension 1 is equal to the number of model edges, and with a vector of corresponding parametric values.

◆ setParOnFluxUsingPoints()

std::vector< std::vector< double > > setParOnFluxUsingPoints ( const Flux f)

Function to set parametric values on a flux based on a set of points. Low level function for the actual implementation.

Parameters
fluxinput flux curve.
Returns
a double vector where dimension 1 is equal to the number of model edges, and with a vector of corresponding parametric values.

◆ setVerticesParValuesOnFlux()

std::vector< std::vector< double > > setVerticesParValuesOnFlux ( const Flux f,
int  type 
)

Top level function to set the parametric values on a flux curve.

Parameters
fluxinput flux curve (contains all the information for points placement).
pointPlacementTypetype of points placement. 0 = based on fixed distance (spcaing), = 1 based on already found field following points on flux.
Returns
a double vector where dimension 1 is equal to the number of model edges, and with a vector of corresponding parametric values.

◆ setVerticesParValuesUsingDistance()

std::vector< std::vector< double > > setVerticesParValuesUsingDistance ( const Flux f)

Function to set parametric values on a flux based on a given fixed distance (spacing between points). Used when pointPlacementType == 0.

Parameters
fluxinput flux curve.
Returns
a double vector where dimension 1 is equal to the number of model edges, and with a vector of corresponding parametric values.

◆ setVerticesParValuesUsingPoints()

std::vector< std::vector< double > > setVerticesParValuesUsingPoints ( const Flux f)

Function to set parametric values on a flux based on a set of points(coordinates) already in the flux. Used when pointPlacementType == 1.

Parameters
fluxinput flux curve.
Returns
a double vector where dimension 1 is equal to the number of model edges, and with a vector of corresponding parametric values.