ryujin::ScalarConservation::Function< dim, Number > Class Template Reference

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

Inheritance diagram for ryujin::ScalarConservation::Function< dim, Number >:

Collaboration diagram for ryujin::ScalarConservation::Function< dim, Number >:

Public Types
using	View = HyperbolicSystemView< dim, Number >
using	state_type = typename View::state_type
Public Types inherited from ryujin::InitialState< HyperbolicDescription, 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
Public Member Functions inherited from ryujin::InitialState< HyperbolicDescription, dim, Number >
	InitialState (const std::string &name, const std::string &subsection)
virtual initial_precomputed_type	initial_precomputations (const dealii::Point< dim > &)

Detailed Description

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

Initial state defined by a user provided function

Definition at line 26 of file initial_state_function.h.

Member Typedef Documentation

View

template<int dim, typename Number >

using ryujin::ScalarConservation::Function< dim, Number >::View = HyperbolicSystemView<dim, Number>

Definition at line 29 of file initial_state_function.h.

state_type

template<int dim, typename Number >

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

Definition at line 30 of file initial_state_function.h.

Constructor & Destructor Documentation

Function()

template<int dim, typename Number >

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

inline

Definition at line 32 of file initial_state_function.h.

Member Function Documentation

compute()

template<int dim, typename Number >

state_type ryujin::ScalarConservation::Function< 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< HyperbolicDescription, dim, Number >.

Definition at line 61 of file initial_state_function.h.

---

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

• include/ryujin/scalar_conservation/initial_state_function.h