ryujin 2.1.1 revision 9391072059490dd712e0ea92785f21acd6605f00
List of all members
ryujin::ShallowWater::Limiter< dim, Number > Class Template Reference
The Shallow Water Equations

#include <source/shallow_water/limiter.h>

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

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 PrecomputedVector = typename View::PrecomputedVector
 
using Parameters = LimiterParameters< ScalarNumber >
 
static constexpr auto problem_dimension = View::problem_dimension
 

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, affine_shift);
}
limiter.bounds(hd_i);
}
ryujin::ShallowWater::Limiter::accumulate
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 state_type &affine_shift)
Definition: limiter.h:271
ryujin::ShallowWater::Limiter::bounds
Bounds bounds(const Number hd_i) const
Definition: limiter.h:334
ryujin::ShallowWater::Limiter::reset
void reset(const unsigned int i, const state_type &U_i, const flux_contribution_type &flux_i)
Definition: limiter.h:249
using Bounds = std::array< Number, n_bounds >
 
static constexpr unsigned int n_bounds = 5
 
 Limiter (const HyperbolicSystem &hyperbolic_system, const Parameters &parameters, const PrecomputedVector &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 state_type &affine_shift)
 
Bounds bounds (const Number hd_i) const
 
static Bounds combine_bounds (const Bounds &bounds_left, const Bounds &bounds_right)
 

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>

Definition at line 95 of file limiter.h.

◆ ScalarNumber

template<int dim, typename Number = double>
using ryujin::ShallowWater::Limiter< dim, Number >::ScalarNumber = typename View::ScalarNumber

Definition at line 97 of file limiter.h.

◆ state_type

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

Definition at line 101 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

Definition at line 103 of file limiter.h.

◆ precomputed_type

template<int dim, typename Number = double>
using ryujin::ShallowWater::Limiter< dim, Number >::precomputed_type = typename View::precomputed_type

Definition at line 105 of file limiter.h.

◆ PrecomputedVector

template<int dim, typename Number = double>
using ryujin::ShallowWater::Limiter< dim, Number >::PrecomputedVector = typename View::PrecomputedVector

Definition at line 107 of file limiter.h.

◆ Parameters

template<int dim, typename Number = double>
using ryujin::ShallowWater::Limiter< dim, Number >::Parameters = LimiterParameters<ScalarNumber>

Definition at line 109 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 139 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 PrecomputedVector &  precomputed_values 
)
inline

Constructor taking a HyperbolicSystem instance as argument

Definition at line 144 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 249 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 state_type &  affine_shift 
)
inline

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

Definition at line 271 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 334 of file limiter.h.

◆ combine_bounds()

template<int dim, typename Number >
DEAL_II_ALWAYS_INLINE auto ryujin::ShallowWater::Limiter< dim, Number >::combine_bounds ( const Bounds &  bounds_left,
const Bounds &  bounds_right 
)
inlinestatic

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

Definition at line 386 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 402 of file limiter.h.

Member Data Documentation

◆ problem_dimension

template<int dim, typename Number = double>
constexpr auto ryujin::ShallowWater::Limiter< dim, Number >::problem_dimension = View::problem_dimension
staticconstexpr

Definition at line 99 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 134 of file limiter.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.4