full_grid Class Reference

A full grid quantity. More...

#include <grid_quantity.hpp>

Inheritance diagram for full_grid:

Public Member Functions
	full_grid (const std::vector< double > &buffer)
	Construct a full grid quantity.
double	get (const double s) const final
	Get a value at a radial s position.
half_grid	get_prime () 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 full grid quantity.

Full grid quantities are defined from the magnetic axis to the last closed flux surface.

Constructor & Destructor Documentation

full_grid()

full_grid::full_grid

(

const std::vector< double > &

buffer

)

Construct a full grid quantity.

full_grid

Parameters

[in]

buffer

Buffer containing the radial quantity.

Construct a full grid quantity.

Parameters

[in]

buffer

Buffer containing the radial quantity.

Member Function Documentation

get()

double full_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()

half_grid full_grid::get_prime

(

)

const

Get a radial derivative at a s position.

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