DiFfRG::Config::GridAxis Class Reference

#include <configuration_mesh.hh>

Public Member Functions
	GridAxis ()=delete
	GridAxis (double min_, double step_, double max_)
	GridAxis (std::string json_string)
std::vector< double >	get_stepwiths (const bool origin_cell_centered=false, const uint refinement=0) const

Static Public Member Functions
static std::string	get_default_range ()

Public Attributes
double	min
double	max
double	step

Private Member Functions
void	validate ()

Constructor & Destructor Documentation

GridAxis() [1/3]

DiFfRG::Config::GridAxis::GridAxis ( )

delete

GridAxis() [2/3]

DiFfRG::Config::GridAxis::GridAxis ( double min_, double step_, double max_ )

inline

GridAxis() [3/3]

DiFfRG::Config::GridAxis::GridAxis ( std::string json_string )

inline

Member Function Documentation

get_default_range()

static std::string DiFfRG::Config::GridAxis::get_default_range ( )

inlinestatic

get_stepwiths()

std::vector< double > DiFfRG::Config::GridAxis::get_stepwiths ( const bool origin_cell_centered = false, const uint refinement = 0 ) const

inline

Return a vector of uniform step widths covering [min, max]. If the configured step fits the interval (within is_close) it is used; otherwise the count is increased by one and the width is adjusted.

If origin_cell_centered is true, choose the smallest cell count whose adjusted width is less than the configured width and which permits the first final cell to be centered on the origin after refinement levels of global refinement. The range must start at zero in that case.

validate()

void DiFfRG::Config::GridAxis::validate ( )

inlineprivate

Member Data Documentation

max

double DiFfRG::Config::GridAxis::max

min

double DiFfRG::Config::GridAxis::min

step

double DiFfRG::Config::GridAxis::step

---

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

• /home/runner/work/DiFfRG_current/DiFfRG_current/DiFfRG/include/DiFfRG/discretization/mesh/configuration_mesh.hh