ryujin 2.1.1 revision 436c52621c9dbc46753db5e4fc2b6342f1ed315a
Public Types | Public Member Functions | List of all members
ryujin::ShallowWaterInitialStates::TankExperiments< Description, dim, Number > Class Template Reference

#include <source/shallow_water/initial_state_transient.h>

Inheritance diagram for ryujin::ShallowWaterInitialStates::TankExperiments< Description, dim, Number >:
Inheritance graph
[legend]
Collaboration diagram for ryujin::ShallowWaterInitialStates::TankExperiments< Description, dim, Number >:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

 TankExperiments (const HyperbolicSystem &hyperbolic_system, const std::string subsection)
 
void parse_parameters_callback ()
 
state_type compute (const dealii::Point< dim > &point, Number) 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)
 
virtual state_type compute (const dealii::Point< dim > &point, Number t)=0
 
virtual initial_precomputed_type initial_precomputations (const dealii::Point< dim > &)
 
auto & name () const
 

Detailed Description

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

Various experiment configurations described in [14].

Definition at line 22 of file initial_state_transient.h.

Member Typedef Documentation

◆ HyperbolicSystem

template<typename Description , int dim, typename Number >
using ryujin::ShallowWaterInitialStates::TankExperiments< Description, dim, Number >::HyperbolicSystem = typename Description::HyperbolicSystem

Definition at line 25 of file initial_state_transient.h.

◆ View

template<typename Description , int dim, typename Number >
using ryujin::ShallowWaterInitialStates::TankExperiments< Description, dim, Number >::View = typename Description::template HyperbolicSystemView<dim, Number>

Definition at line 26 of file initial_state_transient.h.

◆ state_type

template<typename Description , int dim, typename Number >
using ryujin::ShallowWaterInitialStates::TankExperiments< Description, dim, Number >::state_type = typename View::state_type

Definition at line 28 of file initial_state_transient.h.

Constructor & Destructor Documentation

◆ TankExperiments()

template<typename Description , int dim, typename Number >
ryujin::ShallowWaterInitialStates::TankExperiments< Description, dim, Number >::TankExperiments ( const HyperbolicSystem hyperbolic_system,
const std::string  subsection 
)
inline

Member Function Documentation

◆ parse_parameters_callback()

template<typename Description , int dim, typename Number >
void ryujin::ShallowWaterInitialStates::TankExperiments< Description, dim, Number >::parse_parameters_callback ( )
inline

◆ compute()

template<typename Description , int dim, typename Number >
state_type ryujin::ShallowWaterInitialStates::TankExperiments< 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 66 of file initial_state_transient.h.

◆ initial_precomputations()

template<typename Description , int dim, typename Number >
auto ryujin::ShallowWaterInitialStates::TankExperiments< 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. In case of LinearTransport we precompute the advection field.

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

Definition at line 79 of file initial_state_transient.h.


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