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

#include <source/shallow_water/initial_state_soliton.h>

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

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

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
	Soliton (const HyperbolicSystem &hyperbolic_system, const std::string subsection)
state_type	compute (const dealii::Point< dim > &point, Number t) 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::Soliton< Description, dim, Number >

Solitary wave over flat bottom.

Definition at line 22 of file initial_state_soliton.h.

Member Typedef Documentation

HyperbolicSystem

template<typename Description , int dim, typename Number >

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

Definition at line 25 of file initial_state_soliton.h.

View

template<typename Description , int dim, typename Number >

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

Definition at line 26 of file initial_state_soliton.h.

state_type

template<typename Description , int dim, typename Number >

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

Definition at line 28 of file initial_state_soliton.h.

Constructor & Destructor Documentation

Soliton()

template<typename Description , int dim, typename Number >

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

inline

Definition at line 30 of file initial_state_soliton.h.

Member Function Documentation

compute()

template<typename Description , int dim, typename Number >

state_type ryujin::ShallowWaterInitialStates::Soliton< 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 43 of file initial_state_soliton.h.

References ryujin::pow().

---

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

• source/shallow_water/initial_state_soliton.h