ryujin::InitialState< Description, dim, Number > Class Template Reference

#include <source/initial_state_library.h>

Inheritance diagram for ryujin::InitialState< Description, dim, Number >:

Collaboration diagram for ryujin::InitialState< Description, dim, Number >:

Public Types
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
	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 > &)
const auto &	name () const

Detailed Description

template<typename Description, int dim, typename Number = double>
class ryujin::InitialState< Description, dim, Number >

A small abstract base class to group configuration options for a number of initial flow configurations.

Note

By convention all initial state configurations described by this class shall be centered at the origin (0, 0) and facing in positive x direction. The InitialValues wrapper class already allows to apply an affine translation to the coordinate system; so additional configuration options for location and direction are not needed.

Definition at line 33 of file initial_state_library.h.

Member Typedef Documentation

View

template<typename Description , int dim, typename Number = double>

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

Definition at line 36 of file initial_state_library.h.

state_type

template<typename Description , int dim, typename Number = double>

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

Definition at line 39 of file initial_state_library.h.

initial_precomputed_type

template<typename Description , int dim, typename Number = double>

using ryujin::InitialState< Description, dim, Number >::initial_precomputed_type = typename View::initial_precomputed_type

Definition at line 41 of file initial_state_library.h.

Constructor & Destructor Documentation

InitialState()

template<typename Description , int dim, typename Number = double>

ryujin::InitialState< Description, dim, Number >::InitialState ( const std::string &  name, const std::string &  subsection  )

inline

Constructor taking initial state name name and a subsection subsection as an argument. The dealii::ParameterAcceptor is initialized with the subsubsection subsection + "/" + name.

Definition at line 48 of file initial_state_library.h.

Member Function Documentation

compute()

template<typename Description , int dim, typename Number = double>

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

pure virtual

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.

Implemented in ryujin::EulerInitialStates::RampUp< Description, dim, Number >, ryujin::EulerInitialStates::Uniform< Description, dim, Number >, ryujin::ScalarConservation::Uniform< dim, Number >, ryujin::ShallowWaterInitialStates::SlopingFriction< Description, dim, Number >, ryujin::ShallowWaterInitialStates::Uniform< Description, dim, Number >, ryujin::Skeleton::Uniform< dim, Number >, ryujin::EulerInitialStates::Rarefaction< Description, dim, Number >, ryujin::EulerInitialStates::Noh< Description, dim, Number >, ryujin::EulerInitialStates::BeckerSolution< Description, dim, Number >, ryujin::EulerInitialStates::Function< Description, dim, Number >, ryujin::EulerInitialStates::IsentropicVortex< Description, dim, Number >, ryujin::EulerInitialStates::LeBlanc< Description, dim, Number >, ryujin::EulerInitialStates::ShockFront< Description, dim, Number >, ryujin::EulerInitialStates::SmoothWave< Description, dim, Number >, ryujin::ScalarConservation::Function< dim, Number >, ryujin::ShallowWaterInitialStates::FlowOverBump< Description, dim, Number >, ryujin::ShallowWaterInitialStates::Function< Description, dim, Number >, ryujin::ShallowWaterInitialStates::GeoTIFF< Description, dim, Number >, ryujin::ShallowWaterInitialStates::Paraboloid< Description, dim, Number >, ryujin::ShallowWaterInitialStates::RitterDamBreak< Description, dim, Number >, ryujin::ShallowWaterInitialStates::SmoothVortex< Description, dim, Number >, ryujin::ShallowWaterInitialStates::Soliton< Description, dim, Number >, ryujin::ShallowWaterInitialStates::ThreeBumpsDamBreak< Description, dim, Number >, ryujin::EulerInitialStates::RadialContrast< Description, dim, Number >, ryujin::EulerInitialStates::AstroJet< Description, dim, Number >, ryujin::EulerInitialStates::Contrast< Description, dim, Number >, ryujin::EulerInitialStates::FourStateContrast< Description, dim, Number >, ryujin::EulerInitialStates::ICFLike< Description, dim, Number >, ryujin::EulerInitialStates::ThreeStateContrast< Description, dim, Number >, ryujin::ShallowWater::CircularDamBreak< dim, Number >, ryujin::ShallowWaterInitialStates::Contrast< Description, dim, Number >, ryujin::ShallowWaterInitialStates::HouTest< Description, dim, Number >, and ryujin::ShallowWaterInitialStates::TankExperiments< Description, dim, Number >.

initial_precomputations()

template<typename Description , int dim, typename Number = double>

virtual initial_precomputed_type ryujin::InitialState< Description, dim, Number >::initial_precomputations ( const dealii::Point< dim > &  )

inlinevirtual

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 in ryujin::ShallowWaterInitialStates::FlowOverBump< Description, dim, Number >, ryujin::ShallowWaterInitialStates::Function< Description, dim, Number >, ryujin::ShallowWaterInitialStates::GeoTIFF< Description, dim, Number >, ryujin::ShallowWaterInitialStates::HouTest< Description, dim, Number >, ryujin::ShallowWaterInitialStates::Paraboloid< Description, dim, Number >, ryujin::ShallowWaterInitialStates::SlopingFriction< Description, dim, Number >, ryujin::ShallowWaterInitialStates::SmoothVortex< Description, dim, Number >, ryujin::ShallowWaterInitialStates::ThreeBumpsDamBreak< Description, dim, Number >, and ryujin::ShallowWaterInitialStates::TankExperiments< Description, dim, Number >.

Definition at line 73 of file initial_state_library.h.

name()

template<typename Description , int dim, typename Number = double>

const auto & ryujin::InitialState< Description, dim, Number >::name ( ) const

inline

Return the name of the initial state as (const reference) std::string

Definition at line 81 of file initial_state_library.h.

---

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

• source/initial_state_library.h