Stellarator-Tools
vmec_grid< GRID_CLASS > Class Template Reference

A radial vmec quantity. More...

#include <grid_quantity.hpp>

Public Member Functions

 vmec_grid (const std::vector< double > &buffer)
 Vmec radial quantity. More...
 
 vmec_grid (const GRID_CLASS &grid)
 Vmec radial quantity. More...
 
double get (const double s) const
 Get a value at a radial s position. More...
 

Public Attributes

const GRID_CLASS grid
 Radial grid buffer.
 

Detailed Description

template<class GRID_CLASS>
class vmec_grid< GRID_CLASS >

A radial vmec quantity.

Half grid quantities lay between the full grid points. For half grid quantities the first index is invalid.

Constructor & Destructor Documentation

◆ vmec_grid() [1/2]

template<class GRID_CLASS >
vmec_grid< GRID_CLASS >::vmec_grid ( const std::vector< double > &  buffer)
inline

Vmec radial quantity.

Parameters
[in]bufferBuffer containing the radial quantity.

◆ vmec_grid() [2/2]

template<class GRID_CLASS >
vmec_grid< GRID_CLASS >::vmec_grid ( const GRID_CLASS &  grid)
inline

Vmec radial quantity.

Parameters
[in]gridA radial grid quantity.

Member Function Documentation

◆ get()

template<class GRID_CLASS >
double vmec_grid< GRID_CLASS >::get ( const double  s) const
inline

Get a value at a radial s position.

Parameters
[in]sRadial s position.
Returns
The interpolated s position.

The documentation for this class was generated from the following file: