half_grid Class Reference

A half grid quantity. More...

#include <grid_quantity.hpp>

Inheritance diagram for half_grid:

Public Member Functions
	half_grid (const std::vector< double > &buffer)
	Construct a half grid quantity.
double	get (const double s) const final
	Get a value at a radial s position.
full_grid	get_prime (const double m) const
	Get a radial derivative at a s position.
Public Member Functions inherited from radial_quantity
	radial_quantity (const std::vector< double > &buffer)
	Construct a radial quantity.

Additional Inherited Members
Public Attributes inherited from radial_quantity
const std::vector< double >	buffer
	Buffer containing radial quantity.
const double	ds
	Grid spacing in s.

Detailed Description

A half grid quantity.

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

Constructor & Destructor Documentation

half_grid()

half_grid::half_grid

(

const std::vector< double > &

buffer

)

Construct a half grid quantity.

half_grid

Parameters

[in]

buffer

Buffer containing the radial quantity.

Construct a half grid quantity.

Parameters

[in]

buffer

Buffer containing the radial quantity.

Member Function Documentation

get()

double half_grid::get ( const double  s ) const

finalvirtual

Get a value at a radial s position.

Parameters

[in]

s

Radial s position.

Returns

The interpolated s position.

Implements radial_quantity.

get_prime()

full_grid half_grid::get_prime

(

const double

m

)

const

Get a radial derivative at a s position.

Parameters

[in]

m

Poloidal mode number.

Returns

The radial derivative on the half grid.

---

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

• SIESTA/Testing/test_utilities/grid_quantity.hpp
• SIESTA/Testing/test_utilities/grid_quantity.cpp