ryujin 2.1.1 revision 863a4d36dcc743d4e1a9b41cfabd03d0aea57863
List of all members
ryujin::ShallowWater::Indicator< dim, Number > Class Template Reference

#include <source/shallow_water/indicator.h>

Public Member Functions

Stencil-based computation of indicators

Intended usage:

for (unsigned int i = n_internal; i < n_owned; ++i) {
// ...
indicator.reset(i, U_i);
for (unsigned int col_idx = 1; col_idx < row_length; ++col_idx) {
// ...
indicator.accumulate(js, U_j, c_ij);
}
indicator.alpha(hd_i);
}
void reset(const unsigned int, const state_type &U_i)
Definition: indicator.h:157
void accumulate(const unsigned int *js, const state_type &U_j, const dealii::Tensor< 1, dim, Number > &c_ij)
Definition: indicator.h:178
Number alpha(const Number h_i)
Definition: indicator.h:204
 Indicator (const HyperbolicSystem &hyperbolic_system, const Parameters &parameters, const PrecomputedVector &precomputed_values)
 
void reset (const unsigned int, const state_type &U_i)
 
void accumulate (const unsigned int *js, const state_type &U_j, const dealii::Tensor< 1, dim, Number > &c_ij)
 
Number alpha (const Number h_i)
 

Typedefs and constexpr constants

using View = HyperbolicSystemView< dim, Number >
 
using ScalarNumber = typename View::ScalarNumber
 
using state_type = typename View::state_type
 
using flux_type = typename View::flux_type
 
using precomputed_type = typename View::precomputed_type
 
using PrecomputedVector = typename View::PrecomputedVector
 
using Parameters = IndicatorParameters< ScalarNumber >
 
static constexpr auto problem_dimension = View::problem_dimension
 

Detailed Description

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

An suitable indicator strategy that is used to form the preliminary high-order update.

Definition at line 49 of file indicator.h.

Member Typedef Documentation

◆ View

template<int dim, typename Number = double>
using ryujin::ShallowWater::Indicator< dim, Number >::View = HyperbolicSystemView<dim, Number>

Definition at line 57 of file indicator.h.

◆ ScalarNumber

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

Definition at line 59 of file indicator.h.

◆ state_type

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

Definition at line 63 of file indicator.h.

◆ flux_type

template<int dim, typename Number = double>
using ryujin::ShallowWater::Indicator< dim, Number >::flux_type = typename View::flux_type

Definition at line 65 of file indicator.h.

◆ precomputed_type

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

Definition at line 67 of file indicator.h.

◆ PrecomputedVector

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

Definition at line 69 of file indicator.h.

◆ Parameters

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

Definition at line 71 of file indicator.h.

Constructor & Destructor Documentation

◆ Indicator()

template<int dim, typename Number = double>
ryujin::ShallowWater::Indicator< dim, Number >::Indicator ( const HyperbolicSystem hyperbolic_system,
const Parameters parameters,
const PrecomputedVector precomputed_values 
)
inline

Constructor taking a HyperbolicSystem instance as argument

Definition at line 96 of file indicator.h.

Member Function Documentation

◆ reset()

template<int dim, typename Number >
DEAL_II_ALWAYS_INLINE void ryujin::ShallowWater::Indicator< dim, Number >::reset ( const unsigned int  i,
const state_type U_i 
)
inline

Reset temporary storage and initialize for a new row corresponding to state vector U_i.

Definition at line 157 of file indicator.h.

◆ accumulate()

template<int dim, typename Number >
DEAL_II_ALWAYS_INLINE void ryujin::ShallowWater::Indicator< dim, Number >::accumulate ( const unsigned int *  js,
const state_type U_j,
const dealii::Tensor< 1, dim, Number > &  c_ij 
)
inline

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

Definition at line 178 of file indicator.h.

◆ alpha()

template<int dim, typename Number >
DEAL_II_ALWAYS_INLINE Number ryujin::ShallowWater::Indicator< dim, Number >::alpha ( const Number  h_i)
inline

Return the computed alpha_i value.

Definition at line 204 of file indicator.h.

Member Data Documentation

◆ problem_dimension

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

Definition at line 61 of file indicator.h.


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