#include <source/shallow_water/limiter.h>

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

using	ScalarNumber = typename View::ScalarNumber

using	state_type = typename View::state_type

using	flux_contribution_type = typename View::flux_contribution_type

using	PrecomputedVectorView = typename View::PrecomputedVectorView

Public Member Functions
Stencil-based computation of bounds
Intended usage: LimiterView<dim, Number> limiter_view; for (unsigned int i = n_internal; i < n_owned; ++i) { // ... limiter_view.reset(pv, i, U_i, flux_i); for (unsigned int col_idx = 1; col_idx < row_length; ++col_idx) { // ... limiter_view.accumulate(pv, js, U_j, flux_j, scaled_c_ij, affine_shift); } limiter_view.bounds(hd_i); } ryujin::ShallowWater::LimiterView Definition limiter.h:155 ryujin::ShallowWater::LimiterView::accumulate DEAL_II_HOST_DEVICE void accumulate(const PrecomputedVectorView &pv, 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 state_type &affine_shift) Definition limiter.h:438 ryujin::ShallowWater::LimiterView::reset DEAL_II_HOST_DEVICE void reset(const PrecomputedVectorView &pv, const unsigned int i, const state_type &U_i, const flux_contribution_type &flux_i) Definition limiter.h:416 ryujin::ShallowWater::LimiterView::bounds DEAL_II_HOST_DEVICE Bounds bounds(const Number hd_i) const Definition limiter.h:493
DEAL_II_HOST_DEVICE void	reset (const PrecomputedVectorView &pv, const unsigned int i, const state_type &U_i, const flux_contribution_type &flux_i)

DEAL_II_HOST_DEVICE void	accumulate (const PrecomputedVectorView &pv, 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 state_type &affine_shift)

DEAL_II_HOST_DEVICE Bounds	bounds (const Number hd_i) const

Convex limiter
DEAL_II_HOST_DEVICE 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.)) const

Computation and manipulation of bounds
using	Bounds = std::array< Number, n_bounds >

static constexpr unsigned int	n_bounds = 3

	LimiterView (const View &view, const Limiter< ScalarNumber > &limiter)

DEAL_II_HOST_DEVICE_ALWAYS_INLINE unsigned int	iterations () const

DEAL_II_HOST_DEVICE_ALWAYS_INLINE ScalarNumber	newton_tolerance () const

DEAL_II_HOST_DEVICE_ALWAYS_INLINE unsigned int	newton_max_iterations () const

DEAL_II_HOST_DEVICE_ALWAYS_INLINE ScalarNumber	relaxation_factor () const

DEAL_II_HOST_DEVICE Bounds	projection_bounds_from_state (const PrecomputedVectorView &pv, const unsigned int i, const state_type &U_i) const

DEAL_II_HOST_DEVICE Bounds	combine_bounds (const Bounds &bounds_left, const Bounds &bounds_right) const

DEAL_II_HOST_DEVICE Bounds	fully_relax_bounds (const Bounds &bounds, const Number &hd) const

Detailed Description

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

A view of the Limiter 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 154 of file limiter.h.

Member Typedef Documentation

◆ View

template<int dim, typename Number , typename MemorySpace >

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

Definition at line 167 of file limiter.h.

◆ ScalarNumber

template<int dim, typename Number , typename MemorySpace >

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

Definition at line 169 of file limiter.h.

◆ state_type

template<int dim, typename Number , typename MemorySpace >

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

Definition at line 171 of file limiter.h.

◆ flux_contribution_type

template<int dim, typename Number , typename MemorySpace >

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

Definition at line 173 of file limiter.h.

◆ PrecomputedVectorView

template<int dim, typename Number , typename MemorySpace >

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

Definition at line 175 of file limiter.h.

◆ Bounds

template<int dim, typename Number , typename MemorySpace >

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

Array type used to store accumulated bounds.

Definition at line 190 of file limiter.h.

Constructor & Destructor Documentation

◆ LimiterView()

template<int dim, typename Number , typename MemorySpace >

ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::LimiterView	(	const View &	view,
		const Limiter< ScalarNumber > &	limiter
	)

inline

Constructor taking a HyperbolicSystemView and a Limiter object as arguments

Definition at line 196 of file limiter.h.

Member Function Documentation

◆ iterations()

template<int dim, typename Number , typename MemorySpace >

DEAL_II_HOST_DEVICE_ALWAYS_INLINE unsigned int ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::iterations ( ) const

inline

Return the number of limiter iterations.

Definition at line 205 of file limiter.h.

◆ newton_tolerance()

template<int dim, typename Number , typename MemorySpace >

DEAL_II_HOST_DEVICE_ALWAYS_INLINE ScalarNumber ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::newton_tolerance ( ) const

inline

Return the tolerance for the quadratic Newton stopping criterion.

Definition at line 213 of file limiter.h.

◆ newton_max_iterations()

template<int dim, typename Number , typename MemorySpace >

DEAL_II_HOST_DEVICE_ALWAYS_INLINE unsigned int ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::newton_max_iterations ( ) const

inline

Return the maximal number of quadratic Newton iterations.

Definition at line 222 of file limiter.h.

◆ relaxation_factor()

template<int dim, typename Number , typename MemorySpace >

DEAL_II_HOST_DEVICE_ALWAYS_INLINE ScalarNumber ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::relaxation_factor ( ) const

inline

Return the factor used for scaling the relaxation window.

Definition at line 230 of file limiter.h.

◆ projection_bounds_from_state()

template<int dim, typename Number , typename MemorySpace >

DEAL_II_HOST_DEVICE_ALWAYS_INLINE auto ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::projection_bounds_from_state	(	const PrecomputedVectorView &	pv,
		const unsigned int	i,
		const state_type &	U_i
	)		const

Given a state U_i and an index i return "strict" bounds, i.e., a minimal convex set containing the state.

Definition at line 360 of file limiter.h.

◆ combine_bounds()

template<int dim, typename Number , typename MemorySpace >

DEAL_II_HOST_DEVICE_ALWAYS_INLINE auto ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::combine_bounds	(	const Bounds &	bounds_left,
		const Bounds &	bounds_right
	)		const

Given two bounds bounds_left, bounds_right, this function computes a larger, combined set of bounds that this is a (convex) superset of the two.

Definition at line 376 of file limiter.h.

◆ fully_relax_bounds()

template<int dim, typename Number , typename MemorySpace >

DEAL_II_HOST_DEVICE_ALWAYS_INLINE auto ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::fully_relax_bounds	(	const Bounds &	bounds,
		const Number &	hd
	)		const

This function applies a relaxation to a given a (strict) bound bounds using a non dimensionalized measure hd (that should scale as $h^d$, where $h$ is the local mesh size). This is done for the case of the shallow water equations by multiplying maximum bounds with $(1+r)$ and minimum bounds with $(1-r)$.

Definition at line 390 of file limiter.h.

◆ reset()

template<int dim, typename Number , typename MemorySpace >

DEAL_II_HOST_DEVICE_ALWAYS_INLINE void ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::reset	(	const PrecomputedVectorView &	pv,
		const unsigned int	i,
		const state_type &	U_i,
		const flux_contribution_type &	flux_i
	)

Reset temporary storage

Definition at line 416 of file limiter.h.

◆ accumulate()

template<int dim, typename Number , typename MemorySpace >

DEAL_II_HOST_DEVICE_ALWAYS_INLINE void ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::accumulate	(	const PrecomputedVectorView &	pv,
		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 state_type &	affine_shift
	)

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

Definition at line 438 of file limiter.h.

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

◆ bounds()

template<int dim, typename Number , typename MemorySpace >

DEAL_II_HOST_DEVICE_ALWAYS_INLINE auto ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::bounds ( const Number hd_i ) const

Return the computed bounds (with relaxation applied).

Definition at line 493 of file limiter.h.

◆ limit()

template<int dim, typename Number , typename MemorySpace >

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

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 523 of file limiter.h.

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

Member Data Documentation

◆ n_bounds

template<int dim, typename Number , typename MemorySpace >

constexpr unsigned int ryujin::ShallowWater::LimiterView< dim, Number, MemorySpace >::n_bounds = 3

staticconstexpr

The number of stored entries in the bounds array.

Definition at line 185 of file limiter.h.

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

source/shallow_water/limiter.h

Public Types

Public Member Functions

Computation and manipulation of bounds

Detailed Description

Member Typedef Documentation

◆ View

◆ ScalarNumber

◆ state_type

◆ flux_contribution_type

◆ PrecomputedVectorView

◆ Bounds

Constructor & Destructor Documentation

◆ LimiterView()

Member Function Documentation

◆ iterations()

◆ newton_tolerance()

◆ newton_max_iterations()

◆ relaxation_factor()

◆ projection_bounds_from_state()

◆ combine_bounds()

◆ fully_relax_bounds()

◆ reset()

◆ accumulate()

◆ bounds()

◆ limit()

Member Data Documentation

◆ n_bounds