ryujin::ShallowWater::Limiter< dim, Number > Class Template Reference

#include <source/shallow_water/limiter.h>

Public Types
using	View = HyperbolicSystemView< dim, Number >
using	state_type = typename View::state_type
using	flux_contribution_type = typename View::flux_contribution_type
using	ScalarNumber = typename get_value_type< Number >::type
using	Parameters = LimiterParameters< ScalarNumber >

Public Member Functions
Convex limiter
std::tuple< Number, bool >	limit (const Bounds &bounds, const state_type &U, const state_type &P, const Number t_min=Number(0.), const Number t_max=Number(1.))

Static Public Member Functions
Verify invariant domain property
static bool	is_in_invariant_domain (const HyperbolicSystem &, const Bounds &, const state_type &)

Static Public Attributes
static constexpr unsigned int	n_precomputed_values

Stencil-based computation of bounds
Intended usage: Limiter<dim, Number> limiter; for (unsigned int i = n_internal; i < n_owned; ++i) { // ... limiter.reset(i, U_i, flux_i); for (unsigned int col_idx = 1; col_idx < row_length; ++col_idx) { // ... limiter.accumulate( js, U_j, flux_j, scaled_c_ij, beta_ij, affine_shift); } limiter.bounds(hd_i); }
using	Bounds = std::array< Number, n_bounds >
static constexpr unsigned int	n_bounds = 5
	Limiter (const HyperbolicSystem &hyperbolic_system, const Parameters &parameters, const MultiComponentVector< ScalarNumber, n_precomputed_values > &precomputed_values)
void	reset (const unsigned int i, const state_type &U_i, const flux_contribution_type &flux_i)
void	accumulate (const state_type &U_j, const state_type &U_star_ij, const state_type &U_star_ji, const dealii::Tensor< 1, dim, Number > &scaled_c_ij, const Number &beta_ij, const state_type &affine_shift)
Bounds	bounds (const Number hd_i) const

Detailed Description

template<int dim, typename Number = double>
class ryujin::ShallowWater::Limiter< dim, Number >

The convex limiter.

Definition at line 87 of file limiter.h.

Member Typedef Documentation

View

template<int dim, typename Number = double>

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

A view of the HyperbolicSystem that makes methods 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.

Intended usage:

HyperbolicSystem hyperbolic_system;
const auto view = hyperbolic_system.template view<dim, Number>();
const auto flux_i = view.flux_contribution(...);
const auto flux_j = view.flux_contribution(...);
const auto flux_ij = view.flux_divergence(flux_i, flux_j, c_ij);
// etc.

Definition at line 93 of file limiter.h.

state_type

template<int dim, typename Number = double>

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

The storage type used for a (conserved) state vector \(\boldsymbol U\).

Definition at line 98 of file limiter.h.

flux_contribution_type

template<int dim, typename Number = double>

using ryujin::ShallowWater::Limiter< dim, Number >::flux_contribution_type = typename View::flux_contribution_type

The storage type used for flux contributions.

Definition at line 109 of file limiter.h.

ScalarNumber

template<int dim, typename Number = double>

using ryujin::ShallowWater::Limiter< dim, Number >::ScalarNumber = typename get_value_type<Number>::type

The underlying scalar number type.

Definition at line 114 of file limiter.h.

Parameters

template<int dim, typename Number = double>

using ryujin::ShallowWater::Limiter< dim, Number >::Parameters = LimiterParameters<ScalarNumber>

Definition at line 119 of file limiter.h.

Bounds

template<int dim, typename Number = double>

using ryujin::ShallowWater::Limiter< dim, Number >::Bounds = std::array<Number, n_bounds>

Array type used to store accumulated bounds.

Definition at line 149 of file limiter.h.

Constructor & Destructor Documentation

Limiter()

template<int dim, typename Number = double>

ryujin::ShallowWater::Limiter< dim, Number >::Limiter ( const HyperbolicSystem &  hyperbolic_system, const Parameters &  parameters, const MultiComponentVector< ScalarNumber, n_precomputed_values > &  precomputed_values  )

inline

Constructor taking a HyperbolicSystem instance as argument

Definition at line 154 of file limiter.h.

Member Function Documentation

reset()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE void ryujin::ShallowWater::Limiter< dim, Number >::reset ( const unsigned int  i, const state_type &  U_i, const flux_contribution_type &  flux_i  )

inline

Reset temporary storage

Definition at line 255 of file limiter.h.

accumulate()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE void ryujin::ShallowWater::Limiter< dim, Number >::accumulate ( const state_type &  U_j, const state_type &  U_star_ij, const state_type &  U_star_ji, const dealii::Tensor< 1, dim, Number > &  scaled_c_ij, const Number &  beta_ij, const state_type &  affine_shift  )

inline

When looping over the sparsity row, add the contribution associated with the neighboring state U_j.

Definition at line 277 of file limiter.h.

References ryujin::add(), and ryujin::contract().

bounds()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::ShallowWater::Limiter< dim, Number >::bounds ( const Number  hd_i ) const

inline

Return the computed bounds (with relaxation applied).

Definition at line 337 of file limiter.h.

limit()

template<int dim, typename Number >

std::tuple< Number, bool > ryujin::ShallowWater::Limiter< dim, Number >::limit	(	const Bounds &	bounds,
		const state_type &	U,
		const state_type &	P,
		const Number	t_min = Number(0.),
		const Number	t_max = Number(1.)
	)

Given a state \(\mathbf U\) and an update \(\mathbf P\) this function computes and returns the maximal coefficient \(t\), obeying \(t_{\text{min}} < t < t_{\text{max}}\), such that the selected local minimum principles are obeyed.

Definition at line 18 of file limiter.template.h.

References ryujin::min, ryujin::negative_part(), ryujin::positive_part(), ryujin::quadratic_newton_step(), and RYUJIN_UNLIKELY.

is_in_invariant_domain()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE bool ryujin::ShallowWater::Limiter< dim, Number >::is_in_invariant_domain ( const HyperbolicSystem &  , const Bounds &  , const state_type &    )

inlinestatic

Returns whether the state U is located in the invariant domain described by bounds. If U is a vectorized state then the function returns true if all vectorized values are located in the invariant domain.

Definition at line 389 of file limiter.h.

Member Data Documentation

n_precomputed_values

template<int dim, typename Number = double>

constexpr unsigned int ryujin::ShallowWater::Limiter< dim, Number >::n_precomputed_values

staticconstexpr

Initial value:

=
          View::n_precomputed_values

The number of precomputed values.

Definition at line 103 of file limiter.h.

n_bounds

template<int dim, typename Number = double>

constexpr unsigned int ryujin::ShallowWater::Limiter< dim, Number >::n_bounds = 5

staticconstexpr

The number of stored entries in the bounds array.

Definition at line 144 of file limiter.h.

---

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

• source/shallow_water/limiter.h
• source/shallow_water/limiter.template.h