XgcBackgroundGridData Class Reference

class XGCBackgroundGridData. More...

Public Member Functions
	XgcBackgroundGridData ()
	XgcBackgroundGridData (std::string adiosFileName)
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

Detailed Description

class XGCBackgroundGridData.

Constructor & Destructor Documentation

XgcBackgroundGridData() [1/2]

XgcBackgroundGridData::XgcBackgroundGridData ( )

inline

XgcBackgroundGridData() [2/2]

XgcBackgroundGridData::XgcBackgroundGridData

(

std::string

adiosFileName

)

Constructor for XGC Background Grid Data.

Parameters

adiosFileName

Adios2 file name containing mesh and related information.

Member Function Documentation

getBicubicSplineCoefficients()

const std::vector< double > & XgcBackgroundGridData::getBicubicSplineCoefficients

(

)

const

Function to return a vector of all the bicubic spline coefficients in all grid cell.
It contains 16 coefficients for each cell. vector.size() = nR*nZ*16.

getBicubicSplineCoefficientsInCell()

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

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

Parameters

rIndex	index of grid cell along R. Ranges from 0 to rGridPoints.size()-1
zIndex	index of grid cell along Z. Ranges from 0 to zGridPoints.size()-1

getDomainBox()

std::array< double, 4 > XgcBackgroundGridData::getDomainBox

(

)

const

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

getGridPointsR()

const std::vector< double > & XgcBackgroundGridData::getGridPointsR

(

)

const

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

getGridPointsZ()

const std::vector< double > & XgcBackgroundGridData::getGridPointsZ

(

)

const

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

getLimiterR()

const std::vector< double > & XgcBackgroundGridData::getLimiterR

(

)

const

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

getLimiterZ()

const std::vector< double > & XgcBackgroundGridData::getLimiterZ

(

)

const

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

getPoloidalCurrentArray()

const std::vector< double > & XgcBackgroundGridData::getPoloidalCurrentArray

(

)

const

Function to return a vector of poloidal current from Eqdsk.

getPsiArray()

const std::vector< double > & XgcBackgroundGridData::getPsiArray

(

)

const

Function to return a vector of psi flux from Eqdsk.

getPsiAtChebyshevPointsInCell()

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

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

Parameters

rIndex	index of grid cell along R. Ranges from 0 to rGridPoints.size()-1
zIndex	index of grid cell along Z. Ranges from 0 to zGridPoints.size()-1

getPsiFieldOnGrid()

const std::vector< double > & XgcBackgroundGridData::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 > XgcBackgroundGridData::getPsplineCurrentCoefficients

(

)

const

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

getPsplinePsiCoefficients()

const std::vector< double > & XgcBackgroundGridData::getPsplinePsiCoefficients

(

)

const

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