ryujin::ShallowWater::Description Struct Reference

#include <source/shallow_water/description.h>

Public Types
using	HyperbolicSystem = ShallowWater::HyperbolicSystem
template<int dim, typename Number = double>
using	Indicator = ShallowWater::Indicator< dim, Number >
using	InitialStateLibrary = ShallowWater::InitialStateLibrary
template<int dim, typename Number = double>
using	Limiter = ShallowWater::Limiter< dim, Number >
template<int dim, typename Number = double>
using	RiemannSolver = ShallowWater::RiemannSolver< dim, Number >

Detailed Description

A struct that contains all equation specific classes describing the chosen hyperbolic system, the indicator, the limiter and (approximate) Riemann solver.

We group all of these templates together in this struct so that we only need to add a single template parameter to the all the algorithm classes, such as HyperbolicModule.

Definition at line 29 of file description.h.

Member Typedef Documentation

HyperbolicSystem

using ryujin::ShallowWater::Description::HyperbolicSystem = ShallowWater::HyperbolicSystem

Definition at line 30 of file description.h.

Indicator

template<int dim, typename Number = double>

using ryujin::ShallowWater::Description::Indicator = ShallowWater::Indicator<dim, Number>

Definition at line 33 of file description.h.

InitialStateLibrary

using ryujin::ShallowWater::Description::InitialStateLibrary = ShallowWater::InitialStateLibrary

Definition at line 35 of file description.h.

Limiter

template<int dim, typename Number = double>

using ryujin::ShallowWater::Description::Limiter = ShallowWater::Limiter<dim, Number>

Definition at line 38 of file description.h.

RiemannSolver

template<int dim, typename Number = double>

using ryujin::ShallowWater::Description::RiemannSolver = ShallowWater::RiemannSolver<dim, Number>

Definition at line 41 of file description.h.

---

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

• source/shallow_water/description.h