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

#include <source/shallow_water/indicator.h>

Public Types
using	state_type = HyperbolicSystem::state_type< dim, Number >
using	precomputed_type = HyperbolicSystem::precomputed_type< dim, Number >
using	flux_type = HyperbolicSystem::flux_type< dim, Number >
using	ScalarNumber = typename get_value_type< Number >::type

Public Member Functions
Stencil-based computation of indicators
Intended usage: Indicator<dim, Number> indicator; 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.add(js, U_j, c_ij); } indicator.alpha(hd_i); }
	Indicator (const HyperbolicSystem &hyperbolic_system, const MultiComponentVector< ScalarNumber, n_precomputed_values > &precomputed_values)
void	reset (const unsigned int i, const state_type &U_i)
void	add (const unsigned int *js, const state_type &U_j, const dealii::Tensor< 1, dim, Number > &c_ij)
Number	alpha (const Number h_i)

Static Public Attributes
static constexpr unsigned int	problem_dimension
static constexpr unsigned int	n_precomputed_values

Detailed Description

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

Todo:

documentation

Definition at line 27 of file indicator.h.

Member Typedef Documentation

state_type

template<int dim, typename Number = double>

using ryujin::ShallowWater::Indicator< dim, Number >::state_type = HyperbolicSystem::state_type<dim, Number>

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

Definition at line 39 of file indicator.h.

precomputed_type

template<int dim, typename Number = double>

using ryujin::ShallowWater::Indicator< dim, Number >::precomputed_type = HyperbolicSystem::precomputed_type<dim, Number>

Array type used for precomputed values.

Definition at line 50 of file indicator.h.

flux_type

template<int dim, typename Number = double>

using ryujin::ShallowWater::Indicator< dim, Number >::flux_type = HyperbolicSystem::flux_type<dim, Number>

The storage type used for the flux \(\mathbf{f}\).

Definition at line 55 of file indicator.h.

ScalarNumber

template<int dim, typename Number = double>

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

Definition at line 60 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 MultiComponentVector< ScalarNumber, n_precomputed_values > &  precomputed_values  )

inline

Constructor taking a HyperbolicSystem instance as argument

Definition at line 85 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 143 of file indicator.h.

add()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE void ryujin::ShallowWater::Indicator< dim, Number >::add ( 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 164 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 187 of file indicator.h.

Member Data Documentation

problem_dimension

template<int dim, typename Number = double>

constexpr unsigned int ryujin::ShallowWater::Indicator< dim, Number >::problem_dimension

staticconstexpr

Initial value:

=
          HyperbolicSystem::problem_dimension<dim>

The dimension of the state space.

Definition at line 33 of file indicator.h.

n_precomputed_values

template<int dim, typename Number = double>

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

staticconstexpr

Initial value:

=
          HyperbolicSystem::n_precomputed_values<dim>

The number of precomputed values.

Definition at line 44 of file indicator.h.

---

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

• source/shallow_water/indicator.h