#include <source/scalar_conservation/limiter.h>

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::ScalarConservation::LimiterView Definition limiter.h:116 ryujin::ScalarConservation::LimiterView::reset void reset(const PrecomputedVectorView &pv, const unsigned int i, const state_type &U_i, const flux_contribution_type &flux_i) Definition limiter.h:343 ryujin::ScalarConservation::LimiterView::bounds Bounds bounds(const Number hd_i) const Definition limiter.h:403 ryujin::ScalarConservation::LimiterView::accumulate void accumulate(const PrecomputedVectorView &pv, const unsigned int js, const state_type &U_j, const flux_contribution_type &flux_j, const dealii::Tensor< 1, dim, Number > &scaled_c_ij, const state_type &affine_shift) Definition* limiter.h:366
void	reset (const PrecomputedVectorView &pv, const unsigned int i, const state_type &U_i, const flux_contribution_type &flux_i)

void	accumulate (const PrecomputedVectorView &pv, const unsigned int *js, const state_type &U_j, const flux_contribution_type &flux_j, const dealii::Tensor< 1, dim, Number > &scaled_c_ij, const state_type &affine_shift)

Bounds	bounds (const Number hd_i) const

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.)) const

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

using	ScalarNumber = typename View::ScalarNumber

using	state_type = typename View::state_type

using	flux_contribution_type = typename View::flux_contribution_type

using	precomputed_type = typename View::precomputed_type

using	PrecomputedVectorView = typename View::PrecomputedVectorView

static constexpr auto	problem_dimension = View::problem_dimension

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

static constexpr unsigned int	n_bounds = 2

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

unsigned int	iterations () const

ScalarNumber	relaxation_factor () const

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

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

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

Detailed Description

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

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

Member Typedef Documentation

◆ View

template<int dim, typename Number >

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

Definition at line 123 of file limiter.h.

◆ ScalarNumber

template<int dim, typename Number >

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

Definition at line 125 of file limiter.h.

◆ state_type

template<int dim, typename Number >

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

Definition at line 129 of file limiter.h.

◆ flux_contribution_type

template<int dim, typename Number >

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

Definition at line 131 of file limiter.h.

◆ precomputed_type

template<int dim, typename Number >

using ryujin::ScalarConservation::LimiterView< dim, Number >::precomputed_type = typename View::precomputed_type

Definition at line 133 of file limiter.h.

◆ PrecomputedVectorView

template<int dim, typename Number >

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

Definition at line 135 of file limiter.h.

◆ Bounds

template<int dim, typename Number >

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

Array type used to store accumulated bounds.

Definition at line 151 of file limiter.h.

Constructor & Destructor Documentation

◆ LimiterView()

template<int dim, typename Number >

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

inline

Constructor taking a HyperbolicSystemView and a Limiter object as arguments

Definition at line 157 of file limiter.h.

Member Function Documentation

◆ iterations()

template<int dim, typename Number >

unsigned int ryujin::ScalarConservation::LimiterView< dim, Number >::iterations ( ) const

inline

Return the number of limiter iterations.

Definition at line 166 of file limiter.h.

◆ relaxation_factor()

template<int dim, typename Number >

ScalarNumber ryujin::ScalarConservation::LimiterView< dim, Number >::relaxation_factor ( ) const

inline

Return the factor used for scaling the relaxation window.

Definition at line 174 of file limiter.h.

◆ projection_bounds_from_state()

template<int dim, typename Number >

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

inline

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

Definition at line 295 of file limiter.h.

◆ combine_bounds()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::ScalarConservation::LimiterView< dim, Number >::combine_bounds	(	const Bounds &	bounds_left,
		const Bounds &	bounds_right
	)		const

inline

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

◆ fully_relax_bounds()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::ScalarConservation::LimiterView< dim, Number >::fully_relax_bounds	(	const Bounds &	bounds,
		const Number &	hd
	)		const

inline

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).

Definition at line 318 of file limiter.h.

◆ reset()

template<int dim, typename Number >

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

inline

Reset temporary storage

Definition at line 343 of file limiter.h.

◆ accumulate()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE void ryujin::ScalarConservation::LimiterView< dim, Number >::accumulate	(	const PrecomputedVectorView &	pv,
		const unsigned int *	js,
		const state_type &	U_j,
		const flux_contribution_type &	flux_j,
		const dealii::Tensor< 1, dim, Number > &	scaled_c_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 366 of file limiter.h.

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

◆ bounds()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::ScalarConservation::LimiterView< dim, Number >::bounds ( const Number hd_i ) const

inline

Return the computed bounds (with relaxation applied).

Definition at line 403 of file limiter.h.

◆ limit()

template<int dim, typename Number >

std::tuple< Number, bool > ryujin::ScalarConservation::LimiterView< 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.)`
	)		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 16 of file limiter.template.h.

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

Member Data Documentation

◆ problem_dimension

template<int dim, typename Number >

constexpr auto ryujin::ScalarConservation::LimiterView< dim, Number >::problem_dimension = View::problem_dimension

staticconstexpr

Definition at line 127 of file limiter.h.

◆ n_bounds

template<int dim, typename Number >

constexpr unsigned int ryujin::ScalarConservation::LimiterView< dim, Number >::n_bounds = 2

staticconstexpr

The number of stored entries in the bounds array.

Definition at line 146 of file limiter.h.

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

source/scalar_conservation/limiter.h
source/scalar_conservation/limiter.template.h

Public Member Functions

Typedefs and constexpr constants

Computation and manipulation of bounds

Detailed Description

Member Typedef Documentation

◆ View

◆ ScalarNumber

◆ state_type

◆ flux_contribution_type

◆ precomputed_type

◆ PrecomputedVectorView

◆ Bounds

Constructor & Destructor Documentation

◆ LimiterView()

Member Function Documentation

◆ iterations()

◆ relaxation_factor()

◆ projection_bounds_from_state()

◆ combine_bounds()

◆ fully_relax_bounds()

◆ reset()

◆ accumulate()

◆ bounds()

◆ limit()

Member Data Documentation

◆ problem_dimension

◆ n_bounds