ryujin::ShallowWater::WaveSpeedEstimator< ScalarNumber > Class Template Reference

#include <source/shallow_water/wave_speed_estimator.h>

Inheritance diagram for ryujin::ShallowWater::WaveSpeedEstimator< ScalarNumber >:

Collaboration diagram for ryujin::ShallowWater::WaveSpeedEstimator< ScalarNumber >:

Public Types
Typedefs and constexpr constants
template<int dim, typename Number = double>
using	View = WaveSpeedEstimatorView< dim, Number >

Public Member Functions
Constructor and setup
	WaveSpeedEstimator (const HyperbolicSystem &hyperbolic_system, const std::string &subsection="/WaveSpeedEstimator")
Information and statistics
template<int dim, typename Number >
auto	view () const

Detailed Description

template<typename ScalarNumber = double>
class ryujin::ShallowWater::WaveSpeedEstimator< ScalarNumber >

A fast approximative solver for the associated 1D Riemann problem. The solver has to ensure that the estimate \(\lambda_{\text{max}}\) that is returned for the maximal wavespeed is a strict upper bound.

Definition at line 36 of file wave_speed_estimator.h.

Member Typedef Documentation

View

template<typename ScalarNumber = double>

template<int dim, typename Number = double>

using ryujin::ShallowWater::WaveSpeedEstimator< ScalarNumber >::View = WaveSpeedEstimatorView<dim, Number>

Alias for the view on the wave speed estimator for a given dimension dim and choice of number type Number.

Definition at line 49 of file wave_speed_estimator.h.

Constructor & Destructor Documentation

WaveSpeedEstimator()

template<typename ScalarNumber = double>

ryujin::ShallowWater::WaveSpeedEstimator< ScalarNumber >::WaveSpeedEstimator ( const HyperbolicSystem &  hyperbolic_system, const std::string &  subsection = "/WaveSpeedEstimator< ScalarNumber >"  )

inline

Constructor.

Definition at line 60 of file wave_speed_estimator.h.

Member Function Documentation

view()

template<typename ScalarNumber = double>

template<int dim, typename Number >

auto ryujin::ShallowWater::WaveSpeedEstimator< ScalarNumber >::view ( ) const

inline

Return a view on the WaveSpeedEstimator 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 79 of file wave_speed_estimator.h.

---

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

• source/shallow_water/wave_speed_estimator.h