#include <source/shallow_water/wave_speed_estimator.h>

Public Member Functions
Compute wavespeed estimates
	WaveSpeedEstimatorView (const View &view, const WaveSpeedEstimator< ScalarNumber > &wave_speed_estimator)

Number	compute (const primitive_type &riemann_data_i, const primitive_type &riemann_data_j) const

Number	compute (const PrecomputedVectorView &pv, const state_type &U_i, const state_type &U_j, const unsigned int i, const unsigned int *js, const dealii::Tensor< 1, dim, Number > &n_ij) const

Typedefs and constexpr constants
using	View = HyperbolicSystemView< dim, Number >

using	ScalarNumber = typename View::ScalarNumber

using	state_type = typename View::state_type

using	primitive_type = typename std::array< Number, riemann_data_size >

using	precomputed_type = typename View::precomputed_type

using	PrecomputedVectorView = typename View::PrecomputedVectorView

static constexpr auto	problem_dimension = View::problem_dimension

static constexpr unsigned int	riemann_data_size = 3

Internal methods
Number	compute_h_star (const primitive_type &riemann_data_i, const primitive_type &riemann_data_j) const

Number	f (const primitive_type &primitive_state, const Number &h_star) const

Number	phi (const primitive_type &riemann_data_i, const primitive_type &riemann_data_j, const Number &h) const

Number	lambda1_minus (const primitive_type &riemann_data, const Number h_star) const

Number	lambda3_plus (const primitive_type &riemann_data, const Number h_star) const

Number	compute_lambda (const primitive_type &riemann_data_i, const primitive_type &riemann_data_j, const Number h_star) const

primitive_type	riemann_data_from_state (const state_type &U, const dealii::Tensor< 1, dim, Number > &n_ij) const

Detailed Description

template<int dim, typename Number>
class ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >

A view of the WaveSpeedEstimator that makes the interface available 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 107 of file wave_speed_estimator.h.

Member Typedef Documentation

◆ View

template<int dim, typename Number >

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

Definition at line 115 of file wave_speed_estimator.h.

◆ ScalarNumber

template<int dim, typename Number >

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

Definition at line 117 of file wave_speed_estimator.h.

◆ state_type

template<int dim, typename Number >

using ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::state_type = typename View::state_type

Definition at line 121 of file wave_speed_estimator.h.

◆ primitive_type

template<int dim, typename Number >

using ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::primitive_type = typename std::array<Number, riemann_data_size>

The array type to store the expanded primitive state for the Riemann solver \([\rho, v, p, a]\)

Definition at line 133 of file wave_speed_estimator.h.

◆ precomputed_type

template<int dim, typename Number >

using ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::precomputed_type = typename View::precomputed_type

Definition at line 135 of file wave_speed_estimator.h.

◆ PrecomputedVectorView

template<int dim, typename Number >

using ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::PrecomputedVectorView = typename View::PrecomputedVectorView

Definition at line 137 of file wave_speed_estimator.h.

Constructor & Destructor Documentation

◆ WaveSpeedEstimatorView()

template<int dim, typename Number >

ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::WaveSpeedEstimatorView	(	const View &	view,
		const WaveSpeedEstimator< ScalarNumber > &	wave_speed_estimator
	)

inline

Constructor taking a HyperbolicSystemView and a WaveSpeedEstimator object as arguments

Definition at line 149 of file wave_speed_estimator.h.

Member Function Documentation

◆ compute() [1/2]

template<int dim, typename Number >

Number ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::compute	(	const primitive_type &	riemann_data_i,
		const primitive_type &	riemann_data_j
	)		const

inline

For two given 1D primitive states riemann_data_i and riemann_data_j, compute an estimation of an upper bound for the maximum wavespeed lambda.

Definition at line 27 of file wave_speed_estimator.template.h.

◆ compute() [2/2]

template<int dim, typename Number >

Number ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::compute	(	const PrecomputedVectorView &	pv,
		const state_type &	U_i,
		const state_type &	U_j,
		const unsigned int	i,
		const unsigned int *	js,
		const dealii::Tensor< 1, dim, Number > &	n_ij
	)		const

For two given states U_i a U_j and a (normalized) "direction" n_ij compute an estimation of an upper bound for lambda.

Definition at line 41 of file wave_speed_estimator.template.h.

◆ f()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::f	(	const primitive_type &	primitive_state,
		const Number &	h_star
	)		const

inlineprotected

Definition at line 57 of file wave_speed_estimator.template.h.

◆ phi()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::phi	(	const primitive_type &	riemann_data_i,
		const primitive_type &	riemann_data_j,
		const Number &	h
	)		const

inlineprotected

Definition at line 78 of file wave_speed_estimator.template.h.

◆ lambda1_minus()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::lambda1_minus	(	const primitive_type &	riemann_data,
		const Number	h_star
	)		const

inlineprotected

Definition at line 96 of file wave_speed_estimator.template.h.

References ryujin::positive_part().

◆ lambda3_plus()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::lambda3_plus	(	const primitive_type &	riemann_data,
		const Number	h_star
	)		const

inlineprotected

Definition at line 111 of file wave_speed_estimator.template.h.

References ryujin::positive_part().

◆ compute_lambda()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::compute_lambda	(	const primitive_type &	riemann_data_i,
		const primitive_type &	riemann_data_j,
		const Number	h_star
	)		const

inlineprotected

Definition at line 126 of file wave_speed_estimator.template.h.

References ryujin::negative_part(), and ryujin::positive_part().

◆ compute_h_star()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::compute_h_star	(	const primitive_type &	riemann_data_i,
		const primitive_type &	riemann_data_j
	)		const

inline

Definition at line 140 of file wave_speed_estimator.template.h.

References ryujin::positive_part().

◆ riemann_data_from_state()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::riemann_data_from_state	(	const state_type &	U,
		const dealii::Tensor< 1, dim, Number > &	n_ij
	)		const

inlineprotected

Definition at line 238 of file wave_speed_estimator.template.h.

Member Data Documentation

◆ problem_dimension

template<int dim, typename Number >

constexpr auto ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::problem_dimension = View::problem_dimension

staticconstexpr

Definition at line 119 of file wave_speed_estimator.h.

◆ riemann_data_size

template<int dim, typename Number >

constexpr unsigned int ryujin::ShallowWater::WaveSpeedEstimatorView< dim, Number >::riemann_data_size = 3

staticconstexpr

Number of components in a primitive state, we store \([\rho, v, p, a]\), thus, 4.

Definition at line 127 of file wave_speed_estimator.h.

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

source/shallow_water/wave_speed_estimator.h
source/shallow_water/wave_speed_estimator.template.h

Public Member Functions

Typedefs and constexpr constants

Internal methods

Detailed Description

Member Typedef Documentation

◆ View

◆ ScalarNumber

◆ state_type

◆ primitive_type

◆ precomputed_type

◆ PrecomputedVectorView

Constructor & Destructor Documentation

◆ WaveSpeedEstimatorView()

Member Function Documentation

◆ compute() [1/2]

◆ compute() [2/2]

◆ f()

◆ phi()

◆ lambda1_minus()

◆ lambda3_plus()

◆ compute_lambda()

◆ compute_h_star()

◆ riemann_data_from_state()

Member Data Documentation

◆ problem_dimension

◆ riemann_data_size