Stellarator-Tools
radial_quantity Class Referenceabstract

A radial quantity. More...

#include <grid_quantity.hpp>

Inheritance diagram for radial_quantity:
full_grid half_grid

Public Member Functions

 radial_quantity (const std::vector< double > &buffer)
 Construct a radial quantity. More...
 
virtual double get (const double s) const =0
 vitual interface to get a value at a radial s position. More...
 

Public Attributes

const std::vector< double > buffer
 Buffer containing radial quantity.
 
const double ds
 Grid spacing in s.
 

Detailed Description

A radial quantity.

Constructor & Destructor Documentation

◆ radial_quantity()

radial_quantity::radial_quantity ( const std::vector< double > &  buffer)

Construct a radial quantity.

radial_quantity

Parameters
[in]bufferBuffer containing the radial quantity.

Construct a radial quantity.

Parameters
[in]bufferBuffer containing the radial quantity.

Member Function Documentation

◆ get()

virtual double radial_quantity::get ( const double  s) const
pure virtual

vitual interface to get a value at a radial s position.

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

Implemented in half_grid, and full_grid.


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