stencil::BaseTransitionFunction Class Reference

Base class for transition functions that disables advanced features. More...

#include <BaseTransitionFunction.hpp>

Public Types
using	TimeDependentValue = std::monostate

Public Member Functions
std::monostate	get_time_dependent_value (uindex_t i_iteration) const

Static Public Attributes
static constexpr uindex_t	stencil_radius = 1
static constexpr uindex_t	n_subiterations = 1

Detailed Description

Base class for transition functions that disables advanced features.

Users who want to start implementing a transition function should let it inherit this class. It provides default definitions that disable certain advanced StencilStream features, for example the time-dependent value feature or sub-iterations.

For the time-dependent value system, this class uses the std::monostate type. This type has only one value, which is "computed" for every iteration.

Member Typedef Documentation

TimeDependentValue

using stencil::BaseTransitionFunction::TimeDependentValue = std::monostate

Member Function Documentation

get_time_dependent_value()

std::monostate stencil::BaseTransitionFunction::get_time_dependent_value ( uindex_t  i_iteration ) const

inline

Member Data Documentation

n_subiterations

constexpr uindex_t stencil::BaseTransitionFunction::n_subiterations = 1

staticconstexpr

stencil_radius

constexpr uindex_t stencil::BaseTransitionFunction::stencil_radius = 1

staticconstexpr

---

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

• StencilStream/BaseTransitionFunction.hpp