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

Public Member Functions

 EqdskGridData ()
 
 EqdskGridData (const adios2::IO &io, const adios2::Engine &reader, std::string name)
 
const std::vector< double > & getGridPointsR () const
 
const std::vector< double > & getGridPointsZ () const
 
const std::vector< double > & getPsiFieldOnGrid () const
 
const std::vector< double > & getPsiArray () const
 
const std::vector< double > & getPoloidalCurrentArray () const
 
const std::vector< double > & getLimiterR () const
 
const std::vector< double > & getLimiterZ () const
 
std::array< double, 4 > getDomainBox () const
 
const std::vector< double > & getPsplinePsiCoefficients () const
 
const std::vector< double > & getPsplineCurrentCoefficients () const
 
const std::vector< double > & getBicubicSplineCoefficients () const
 
std::array< double, 16 > getBicubicSplineCoefficientsInCell (int rIndex, int zIndex) const
 
std::array< double, 16 > getPsiAtChebyshevPointsInCell (int rIndex, int zIndex) const
 

Constructor & Destructor Documentation

◆ EqdskGridData() [1/2]

EqdskGridData::EqdskGridData ( )
inline

◆ EqdskGridData() [2/2]

EqdskGridData::EqdskGridData ( const adios2::IO &  io,
const adios2::Engine &  reader,
std::string  name 
)

Member Function Documentation

◆ getBicubicSplineCoefficients()

const std::vector< double > & EqdskGridData::getBicubicSplineCoefficients ( ) const

Function to return a vector of all the bicubic spline coefficients in each grid cell.
It contains 16 coefficients for each cell.

◆ getBicubicSplineCoefficientsInCell()

std::array< double, 16 > EqdskGridData::getBicubicSplineCoefficientsInCell ( int  rIndex,
int  zIndex 
) const

Function to return an array of bicubic spline coefficients for a grid cell.

Parameters
rIndexindex of grid cell along R. Ranges from 0 to rGridPoints.size()-1
zIndexindex of grid cell along Z. Ranges from 0 to zGridPoints.size()-1

◆ getDomainBox()

std::array< double, 4 > EqdskGridData::getDomainBox ( ) const

Function to return eqdsk domain box. An array of size 4. Contains rMin, zMin, rMax, zMax.

◆ getGridPointsR()

const std::vector< double > & EqdskGridData::getGridPointsR ( ) const

Function to return a vector of R coordinates of the grid.

◆ getGridPointsZ()

const std::vector< double > & EqdskGridData::getGridPointsZ ( ) const

Function to return a vector of Z coordinates of the grid.

◆ getLimiterR()

const std::vector< double > & EqdskGridData::getLimiterR ( ) const

Function to return a vector of R coordinates of the limiter.

◆ getLimiterZ()

const std::vector< double > & EqdskGridData::getLimiterZ ( ) const

Function to return a vector of Z coordinates of the limiter.

◆ getPoloidalCurrentArray()

const std::vector< double > & EqdskGridData::getPoloidalCurrentArray ( ) const

Function to return a vector of poloidal current from Eqdsk.

◆ getPsiArray()

const std::vector< double > & EqdskGridData::getPsiArray ( ) const

Function to return a vector of psi flux from Eqdsk.

◆ getPsiAtChebyshevPointsInCell()

std::array< double, 16 > EqdskGridData::getPsiAtChebyshevPointsInCell ( int  rIndex,
int  zIndex 
) const

Function to return an array of psi values at Chebyshev points for a grid cell.

Parameters
rIndexindex of grid cell along R. Ranges from 0 to rGridPoints.size()-1
zIndexindex of grid cell along Z. Ranges from 0 to zGridPoints.size()-1

◆ getPsiFieldOnGrid()

const std::vector< double > & EqdskGridData::getPsiFieldOnGrid ( ) const

Function to return a vector of psi field on grid points. Size of psi vector = size of R vector* size of Z vector.

◆ getPsplineCurrentCoefficients()

const std::vector< double > & EqdskGridData::getPsplineCurrentCoefficients ( ) const

Function to return PSPLINE poloidal current spline coefficients.
Number of coefficients = 2*psi.size()

◆ getPsplinePsiCoefficients()

const std::vector< double > & EqdskGridData::getPsplinePsiCoefficients ( ) const

Function to return global PSPLINE psi spline coefficients.
Number of coefficients = 4*rGridPoints.size()*zGridPoints.size()