siesta_grid< GRID_CLASS > Class Template Reference

A radial siesta quantity. More...

#include <grid_quantity.hpp>

Public Member Functions
	siesta_grid (const std::vector< double > &buffer)
	Siesta radial quantity. More...
	siesta_grid (const GRID_CLASS &grid)
	Siesta 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 siesta_grid< GRID_CLASS >

A radial siesta quantity.

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

Constructor & Destructor Documentation

siesta_grid() [1/2]

template<class GRID_CLASS >

siesta_grid< GRID_CLASS >::siesta_grid ( const std::vector< double > &  buffer )

inline

Siesta radial quantity.

Parameters

[in]

buffer

Buffer containing the radial quantity.

siesta_grid() [2/2]

template<class GRID_CLASS >

siesta_grid< GRID_CLASS >::siesta_grid ( const GRID_CLASS &  grid )

inline

Siesta radial quantity.

Parameters

[in]

grid

A radial grid quantity.

Member Function Documentation

get()

template<class GRID_CLASS >

double siesta_grid< GRID_CLASS >::get ( const double  s ) const

inline

Get a value at a radial s position.

s_vmec = s_siesta^2

Parameters

[in]

s

Radial s position in the vmec grid.

Returns

The interpolated s position.

---

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

• SIESTA/Testing/test_utilities/grid_quantity.hpp