ryujin::ShallowWater::HyperbolicSystem Class Reference

#include <source/shallow_water/hyperbolic_system.h>

Inheritance diagram for ryujin::ShallowWater::HyperbolicSystem:

Collaboration diagram for ryujin::ShallowWater::HyperbolicSystem:

Public Member Functions
	HyperbolicSystem (const std::string &subsection="/HyperbolicSystem")
template<int dim, typename Number >
auto	view () const

Static Public Attributes
static const std::string	problem_name = "Shallow water equations"

Runtime parameters, internal fields, methods, and friends
template<int dim, typename Number >
class	HyperbolicSystemView

Detailed Description

Description of a dim dimensional hyperbolic conservation law modeling the shallow water equations.

We have a (1 + dim) dimensional state space \([h, \textbf m]\), where \(h\) denotes the water depth, abd \(\textbf m\) is the momentum.

Definition at line 40 of file hyperbolic_system.h.

Constructor & Destructor Documentation

HyperbolicSystem()

ryujin::ShallowWater::HyperbolicSystem::HyperbolicSystem ( const std::string &  subsection = "/HyperbolicSystem" )

inline

Constructor.

Definition at line 636 of file hyperbolic_system.h.

Member Function Documentation

view()

template<int dim, typename Number >

auto ryujin::ShallowWater::HyperbolicSystem::view ( ) const

inline

Return a view on the Hyperbolic System for a given dimension dim and choice of number type Number (which can be a scalar float, or double, as well as a VectorizedArray holding packed scalars.

Definition at line 60 of file hyperbolic_system.h.

Friends And Related Function Documentation

HyperbolicSystemView

template<int dim, typename Number >

friend class HyperbolicSystemView

friend

Definition at line 78 of file hyperbolic_system.h.

Member Data Documentation

problem_name

const std::string ryujin::ShallowWater::HyperbolicSystem::problem_name = "Shallow water equations"

inlinestatic

The name of the hyperbolic system as a string.

Definition at line 46 of file hyperbolic_system.h.

---

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

• source/shallow_water/hyperbolic_system.h