siesta_fourier< GRID_CLASS, PARITY > Class Template Reference

A cosine parity vmec quantity. More...

#include <grid_quantity.hpp>

Public Member Functions
	siesta_fourier (const siesta_quantity< GRID_CLASS > &buffer, const size_t mpol, const size_t ntor, const std::vector< int > &tor_modes, const size_t nfp)
	Siesta radial quantity. More...
double	get (const double s, const double u, const double v) const
	Get a value at a radial s position. More...
double	get_du (const double s, const double u, const double v) const
	Get a poloidal derivative at a radial s position. More...
double	get_dv (const double s, const double u, const double v) const
	Get a toroidal derivative at a radial s position. More...

Public Attributes
const size_t	mpol
	M modes.
const size_t	ntor
	N modes.
const std::vector< int >	tor_modes
	Toroidal modes.
const size_t	nfp
	Number of field periods.
const siesta_quantity< GRID_CLASS >	quantity
	Mode amplitudes.
const PARITY	func
	Parity function.

Detailed Description

template<class GRID_CLASS, class PARITY>
class siesta_fourier< GRID_CLASS, PARITY >

A cosine parity vmec quantity.

Constructor & Destructor Documentation

siesta_fourier()

template<class GRID_CLASS , class PARITY >

siesta_fourier< GRID_CLASS, PARITY >::siesta_fourier ( const siesta_quantity< GRID_CLASS > &  buffer, const size_t  mpol, const size_t  ntor, const std::vector< int > &  tor_modes, const size_t  nfp  )

inline

Siesta radial quantity.

Parameters

[in]	buffer	Buffer containing the radial quantity.
[in]	mpol	Number of poloidal modes.
[in]	ntor	Number of toroidal modes.
[in]	tor_modes	Toroidal modes.
[in]	nfp	Number of field periods.

Member Function Documentation

get()

template<class GRID_CLASS , class PARITY >

double siesta_fourier< GRID_CLASS, PARITY >::get ( const double  s, const double  u, const double  v  ) const

inline

Get a value at a radial s position.

s_vmec = s_siesta^2

Parameters

[in]	s	Radial s position.
[in]	u	Poloidal u position.
[in]	v	Toroidal v position.

Returns

The interpolated s position.

get_du()

template<class GRID_CLASS , class PARITY >

double siesta_fourier< GRID_CLASS, PARITY >::get_du ( const double  s, const double  u, const double  v  ) const

inline

Get a poloidal derivative at a radial s position.

s_vmec = s_siesta^2

Parameters

[in]	s	Radial s position.
[in]	u	Poloidal u position.
[in]	v	Toroidal v position.

Returns

The interpolated s position.

get_dv()

template<class GRID_CLASS , class PARITY >

double siesta_fourier< GRID_CLASS, PARITY >::get_dv ( const double  s, const double  u, const double  v  ) const

inline

Get a toroidal derivative at a radial s position.

s_vmec = s_siesta^2

Parameters

[in]	s	Radial s position.
[in]	u	Poloidal u position.
[in]	v	Toroidal v position.

Returns

The interpolated s position.

---

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

• SIESTA/Testing/test_utilities/grid_quantity.hpp