ryujin::ShallowWaterInitialStates::Function< Description, dim, Number > Class Template Reference

#include <include/ryujin/shallow_water/initial_state_function.h>

Inheritance diagram for ryujin::ShallowWaterInitialStates::Function< Description, dim, Number >:

Collaboration diagram for ryujin::ShallowWaterInitialStates::Function< Description, dim, Number >:

Public Types
using	HyperbolicSystem = typename Description::HyperbolicSystem
using	View = typename HyperbolicSystem::template View< dim, Number >
using	state_type = typename View::state_type
Public Types inherited from ryujin::InitialState< Description, dim, Number >
using	HyperbolicSystem = typename HyperbolicDescription::HyperbolicSystem
using	View = typename HyperbolicSystem::template View< dim, Number >
using	state_type = typename View::state_type
using	initial_precomputed_type = typename View::initial_precomputed_type

Public Member Functions
	Function (const HyperbolicSystem &hyperbolic_system, const std::string subsection)
state_type	compute (const dealii::Point< dim > &point, Number t) final
auto	initial_precomputations (const dealii::Point< dim > &point) -> typename InitialState< Description, dim, Number >::initial_precomputed_type final
Public Member Functions inherited from ryujin::InitialState< Description, dim, Number >
	InitialState (const std::string &name, const std::string &subsection)

Detailed Description

template<typename Description, int dim, typename Number>
class ryujin::ShallowWaterInitialStates::Function< Description, dim, Number >

Returns an initial state defined by a set of user specified functions based on the primitive variables and the bathymetry.

Definition at line 26 of file initial_state_function.h.

Member Typedef Documentation

HyperbolicSystem

template<typename Description , int dim, typename Number >

using ryujin::ShallowWaterInitialStates::Function< Description, dim, Number >::HyperbolicSystem = typename Description::HyperbolicSystem

Definition at line 29 of file initial_state_function.h.

View

template<typename Description , int dim, typename Number >

using ryujin::ShallowWaterInitialStates::Function< Description, dim, Number >::View = typename HyperbolicSystem::template View<dim, Number>

Definition at line 30 of file initial_state_function.h.

state_type

template<typename Description , int dim, typename Number >

using ryujin::ShallowWaterInitialStates::Function< Description, dim, Number >::state_type = typename View::state_type

Definition at line 31 of file initial_state_function.h.

Constructor & Destructor Documentation

Function()

template<typename Description , int dim, typename Number >

ryujin::ShallowWaterInitialStates::Function< Description, dim, Number >::Function ( const HyperbolicSystem &  hyperbolic_system, const std::string  subsection  )

inline

Definition at line 33 of file initial_state_function.h.

Member Function Documentation

compute()

template<typename Description , int dim, typename Number >

state_type ryujin::ShallowWaterInitialStates::Function< Description, dim, Number >::compute ( const dealii::Point< dim > &  point, Number  t  )

inlinefinalvirtual

Given a position point returns the corresponding (conserved) initial state. The function is used to interpolate initial values and enforce Dirichlet boundary conditions. For the latter, the function signature has an additional parameter t denoting the current time to allow for time-dependent (in-flow) Dirichlet data.

Implements ryujin::InitialState< Description, dim, Number >.

Definition at line 88 of file initial_state_function.h.

initial_precomputations()

template<typename Description , int dim, typename Number >

auto ryujin::ShallowWaterInitialStates::Function< Description, dim, Number >::initial_precomputations ( const dealii::Point< dim > &  ) -> typename InitialState<Description, dim, Number>:: initial_precomputed_type

inlinefinalvirtual

Given a position point returns a precomputed value used for the flux computation via HyperbolicSystem::flux_contribution().

The default implementation of this function simply returns a zero value. In case of the The Shallow Water Equations we pre-compute the bathymetry.

Reimplemented from ryujin::InitialState< Description, dim, Number >.

Definition at line 111 of file initial_state_function.h.

---

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

• include/ryujin/shallow_water/initial_state_function.h