#include <source/euler/hyperbolic_system.h>

Public Types
using	ScalarNumber = typename get_value_type< Number >::type

Public Member Functions
	HyperbolicSystemView (const HyperbolicSystem &hyperbolic_system)

template<int dim2, typename Number2 >
auto	view () const

template<typename DISPATCH , typename SPARSITY >
DEAL_II_ALWAYS_INLINE void	precomputation_loop (unsigned int cycle, const DISPATCH &dispatch_check, precomputed_vector_type &precomputed_values, const SPARSITY &sparsity_simd, const vector_type &U, unsigned int left, unsigned int right) const

template<int component>
DEAL_II_ALWAYS_INLINE auto	linearized_eigenvector (const state_type &U, const dealii::Tensor< 1, dim, Number > &normal) const -> std::array< state_type, 2 >

template<int component>
DEAL_II_ALWAYS_INLINE auto	prescribe_riemann_characteristic (const state_type &U, const state_type &U_bar, const dealii::Tensor< 1, dim, Number > &normal) const -> state_type

template<typename Lambda >
DEAL_II_ALWAYS_INLINE auto	apply_boundary_conditions (dealii::types::boundary_id id, const state_type &U, const dealii::Tensor< 1, dim, Number > &normal, const Lambda &get_dirichlet_data) const -> state_type

template<typename ST >
auto	expand_state (const ST &state) const -> state_type

template<typename ST >
DEAL_II_ALWAYS_INLINE auto	from_initial_state (const ST &initial_state) const -> state_type

template<typename Lambda >
auto	apply_galilei_transform (const state_type &state, const Lambda &lambda) const -> state_type

template<typename DISPATCH , typename SPARSITY >
DEAL_II_ALWAYS_INLINE void	precomputation_loop (unsigned int cycle, const DISPATCH &dispatch_check, precomputed_vector_type &precomputed_values, const SPARSITY &sparsity_simd, const vector_type &U, unsigned int left, unsigned int right) const

template<int component>
DEAL_II_ALWAYS_INLINE auto	prescribe_riemann_characteristic (const state_type &U, const state_type &U_bar, const dealii::Tensor< 1, dim, Number > &normal) const -> state_type

template<typename Lambda >
DEAL_II_ALWAYS_INLINE auto	apply_boundary_conditions (dealii::types::boundary_id id, const state_type &U, const dealii::Tensor< 1, dim, Number > &normal, const Lambda &get_dirichlet_data) const -> state_type

template<typename ST >
auto	expand_state (const ST &state) const -> state_type

template<typename ST >
DEAL_II_ALWAYS_INLINE auto	from_initial_state (const ST &initial_state) const -> state_type

template<typename Lambda >
auto	apply_galilei_transform (const state_type &state, const Lambda &lambda) const -> state_type

template<typename DISPATCH , typename SPARSITY >
DEAL_II_ALWAYS_INLINE void	precomputation_loop (unsigned int cycle, const DISPATCH &dispatch_check, precomputed_vector_type &precomputed_values, const SPARSITY &sparsity_simd, const vector_type &U, unsigned int left, unsigned int right) const

template<typename Lambda >
DEAL_II_ALWAYS_INLINE auto	apply_boundary_conditions (dealii::types::boundary_id id, const state_type &U, const dealii::Tensor< 1, dim, Number > &, const Lambda &get_dirichlet_data) const -> state_type

template<typename DISPATCH , typename SPARSITY >
DEAL_II_ALWAYS_INLINE void	precomputation_loop (unsigned int cycle, const DISPATCH &dispatch_check, precomputed_vector_type &precomputed_values, const SPARSITY &sparsity_simd, const vector_type &U, unsigned int left, unsigned int right) const

template<int component>
DEAL_II_ALWAYS_INLINE auto	prescribe_riemann_characteristic (const state_type &U, const state_type &U_bar, const dealii::Tensor< 1, dim, Number > &normal) const -> state_type

template<typename Lambda >
DEAL_II_ALWAYS_INLINE auto	apply_boundary_conditions (const dealii::types::boundary_id id, const state_type &U, const dealii::Tensor< 1, dim, Number > &normal, const Lambda &get_dirichlet_data) const -> state_type

template<typename ST >
DEAL_II_ALWAYS_INLINE auto	expand_state (const ST &state) const -> state_type

template<typename ST >
DEAL_II_ALWAYS_INLINE auto	from_initial_state (const ST &initial_state) const -> state_type

template<typename Lambda >
DEAL_II_ALWAYS_INLINE auto	apply_galilei_transform (const state_type &state, const Lambda &lambda) const -> state_type

Access to runtime parameters
DEAL_II_ALWAYS_INLINE ScalarNumber	gamma () const

DEAL_II_ALWAYS_INLINE ScalarNumber	reference_density () const

DEAL_II_ALWAYS_INLINE ScalarNumber	vacuum_state_relaxation_small () const

DEAL_II_ALWAYS_INLINE ScalarNumber	vacuum_state_relaxation_large () const

Special functions for boundary states
template<int component>
std::array< state_type, 2 >	linearized_eigenvector (const state_type &U, const dealii::Tensor< 1, dim, Number > &normal) const

template<int component>
state_type	prescribe_riemann_characteristic (const state_type &U, const state_type &U_bar, const dealii::Tensor< 1, dim, Number > &normal) const

template<typename Lambda >
state_type	apply_boundary_conditions (const dealii::types::boundary_id id, const state_type &U, const dealii::Tensor< 1, dim, Number > &normal, const Lambda &get_dirichlet_data) const

State transformations
template<typename ST >
state_type	expand_state (const ST &state) const

template<typename ST >
state_type	from_initial_state (const ST &initial_state) const

state_type	from_primitive_state (const state_type &primitive_state) const

state_type	to_primitive_state (const state_type &state) const

template<typename Lambda >
state_type	apply_galilei_transform (const state_type &state, const Lambda &lambda) const

Types and compile time constants
using	state_type = dealii::Tensor< 1, problem_dimension, Number >

using	vector_type = MultiComponentVector< ScalarNumber, problem_dimension >

using	flux_type = dealii::Tensor< 1, problem_dimension, dealii::Tensor< 1, dim, Number > >

using	flux_contribution_type = flux_type

static constexpr unsigned int	problem_dimension = 2 + dim

static const auto	component_names

static const auto	primitive_component_names

Precomputed quantities
using	precomputed_initial_state_type = std::array< Number, n_precomputed_initial_values >

using	precomputed_initial_vector_type = MultiComponentVector< ScalarNumber, n_precomputed_initial_values >

using	precomputed_state_type = std::array< Number, n_precomputed_values >

using	precomputed_vector_type = MultiComponentVector< ScalarNumber, n_precomputed_values >

static constexpr unsigned int	n_precomputed_initial_values = 0

static const auto	precomputed_initial_names

static constexpr unsigned int	n_precomputed_values = 2

static const auto	precomputed_names

static constexpr unsigned int	n_precomputation_cycles = 1

template<typename DISPATCH , typename SPARSITY >
void	precomputation_loop (unsigned int cycle, const DISPATCH &dispatch_check, precomputed_vector_type &precomputed_values, const SPARSITY &sparsity_simd, const vector_type &U, unsigned int left, unsigned int right) const

Access to cached inverses
A collection of commonly used expressions with gamma that would otherwise need to be recomputed many times putting unnecessary pressure on the div/sqrt ALU unit.
static constexpr bool	have_gamma = true

static constexpr bool	have_eos_interpolation_b = false

DEAL_II_ALWAYS_INLINE ScalarNumber	gamma_inverse () const

DEAL_II_ALWAYS_INLINE ScalarNumber	gamma_plus_one_inverse () const

DEAL_II_ALWAYS_INLINE ScalarNumber	gamma_minus_one_inverse () const

DEAL_II_ALWAYS_INLINE ScalarNumber	gamma_minus_one_over_gamma_plus_one () const

Flux computations
static constexpr bool	have_high_order_flux = false

flux_type	f (const state_type &U) const

flux_contribution_type	flux_contribution (const precomputed_vector_type &pv, const precomputed_initial_vector_type &piv, const unsigned int i, const state_type &U_i) const

flux_contribution_type	flux_contribution (const precomputed_vector_type &pv, const precomputed_initial_vector_type &piv, const unsigned int *js, const state_type &U_j) const

state_type	flux_divergence (const flux_contribution_type &flux_i, const flux_contribution_type &flux_j, const dealii::Tensor< 1, dim, Number > &c_ij) const

state_type	high_order_flux_divergence (const flux_contribution_type &flux_i, const flux_contribution_type &flux_j, const dealii::Tensor< 1, dim, Number > &c_ij) const =delete

Computing stencil source terms
static constexpr bool	have_source_terms = false

state_type	nodal_source (const precomputed_vector_type &pv, const unsigned int i, const state_type &U_i, const ScalarNumber tau) const =delete

state_type	nodal_source (const precomputed_vector_type &pv, const unsigned int *js, const state_type &U_j, const ScalarNumber tau) const =delete

Computing derived physical quantities
Number	filter_vacuum_density (const Number &rho) const

Number	pressure (const state_type &U) const

Number	speed_of_sound (const state_type &U) const

Number	specific_entropy (const state_type &U) const

Number	harten_entropy (const state_type &U) const

state_type	harten_entropy_derivative (const state_type &U) const

Number	mathematical_entropy (const state_type &U) const

state_type	mathematical_entropy_derivative (const state_type &U) const

bool	is_admissible (const state_type &U) const

static Number	density (const state_type &U)

static dealii::Tensor< 1, dim, Number >	momentum (const state_type &U)

static Number	total_energy (const state_type &U)

static Number	internal_energy (const state_type &U)

static state_type	internal_energy_derivative (const state_type &U)

Detailed Description

template<int dim, typename Number>
class ryujin::Euler::HyperbolicSystemView< dim, Number >

A view of the HyperbolicSystem that makes methods 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.

Intended usage:

HyperbolicSystem hyperbolic_system;
const auto view = hyperbolic_system.template view<dim, Number>();
const auto flux_i = view.flux_contribution(...);
const auto flux_j = view.flux_contribution(...);
const auto flux_ij = view.flux_divergence(flux_i, flux_j, c_ij);
// etc.

Definition at line 103 of file hyperbolic_system.h.

Member Typedef Documentation

◆ ScalarNumber

template<int dim, typename Number >

using ryujin::Euler::HyperbolicSystemView< dim, Number >::ScalarNumber = typename get_value_type<Number>::type

The underlying scalar number type.

Definition at line 127 of file hyperbolic_system.h.

◆ state_type

template<int dim, typename Number >

using ryujin::Euler::HyperbolicSystemView< dim, Number >::state_type = dealii::Tensor<1, problem_dimension, Number>

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

Definition at line 222 of file hyperbolic_system.h.

◆ vector_type

template<int dim, typename Number >

using ryujin::Euler::HyperbolicSystemView< dim, Number >::vector_type = MultiComponentVector<ScalarNumber, problem_dimension>

MulticomponentVector for storing a vector of conserved states:

Definition at line 227 of file hyperbolic_system.h.

◆ flux_type

template<int dim, typename Number >

using ryujin::Euler::HyperbolicSystemView< dim, Number >::flux_type = dealii::Tensor<1, problem_dimension, dealii::Tensor<1, dim, Number> >

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

Definition at line 262 of file hyperbolic_system.h.

◆ flux_contribution_type

template<int dim, typename Number >

using ryujin::Euler::HyperbolicSystemView< dim, Number >::flux_contribution_type = flux_type

The storage type used for flux contributions.

Definition at line 268 of file hyperbolic_system.h.

◆ precomputed_initial_state_type

template<int dim, typename Number >

using ryujin::Euler::HyperbolicSystemView< dim, Number >::precomputed_initial_state_type = std::array<Number, n_precomputed_initial_values>

Array type used for precomputed initial values.

Definition at line 284 of file hyperbolic_system.h.

◆ precomputed_initial_vector_type

template<int dim, typename Number >

using ryujin::Euler::HyperbolicSystemView< dim, Number >::precomputed_initial_vector_type = MultiComponentVector<ScalarNumber, n_precomputed_initial_values>

MulticomponentVector for storing a vector of precomputed initial states:

Definition at line 291 of file hyperbolic_system.h.

◆ precomputed_state_type

template<int dim, typename Number >

using ryujin::Euler::HyperbolicSystemView< dim, Number >::precomputed_state_type = std::array<Number, n_precomputed_values>

Array type used for precomputed values.

Definition at line 308 of file hyperbolic_system.h.

◆ precomputed_vector_type

template<int dim, typename Number >

using ryujin::Euler::HyperbolicSystemView< dim, Number >::precomputed_vector_type = MultiComponentVector<ScalarNumber, n_precomputed_values>

MulticomponentVector for storing a vector of precomputed states:

Definition at line 313 of file hyperbolic_system.h.

Constructor & Destructor Documentation

◆ HyperbolicSystemView()

template<int dim, typename Number >

ryujin::Euler::HyperbolicSystemView< dim, Number >::HyperbolicSystemView ( const HyperbolicSystem & hyperbolic_system )

inline

Constructor taking a reference to the underlying HyperbolicSystem

Definition at line 110 of file hyperbolic_system.h.

Member Function Documentation

◆ view()

template<int dim, typename Number >

template<int dim2, typename Number2 >

auto ryujin::Euler::HyperbolicSystemView< dim, Number >::view ( ) const

inline

Create a modified view from the current one:

Definition at line 119 of file hyperbolic_system.h.

◆ gamma()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE ScalarNumber ryujin::Euler::HyperbolicSystemView< dim, Number >::gamma ( ) const

inline

Definition at line 134 of file hyperbolic_system.h.

◆ reference_density()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE ScalarNumber ryujin::Euler::HyperbolicSystemView< dim, Number >::reference_density ( ) const

inline

Definition at line 139 of file hyperbolic_system.h.

◆ vacuum_state_relaxation_small()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE ScalarNumber ryujin::Euler::HyperbolicSystemView< dim, Number >::vacuum_state_relaxation_small ( ) const

inline

Definition at line 145 of file hyperbolic_system.h.

◆ vacuum_state_relaxation_large()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE ScalarNumber ryujin::Euler::HyperbolicSystemView< dim, Number >::vacuum_state_relaxation_large ( ) const

inline

Definition at line 151 of file hyperbolic_system.h.

◆ gamma_inverse()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE ScalarNumber ryujin::Euler::HyperbolicSystemView< dim, Number >::gamma_inverse ( ) const

inline

Definition at line 166 of file hyperbolic_system.h.

◆ gamma_plus_one_inverse()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE ScalarNumber ryujin::Euler::HyperbolicSystemView< dim, Number >::gamma_plus_one_inverse ( ) const

inline

Definition at line 171 of file hyperbolic_system.h.

◆ gamma_minus_one_inverse()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE ScalarNumber ryujin::Euler::HyperbolicSystemView< dim, Number >::gamma_minus_one_inverse ( ) const

inline

Definition at line 176 of file hyperbolic_system.h.

◆ gamma_minus_one_over_gamma_plus_one()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE ScalarNumber ryujin::Euler::HyperbolicSystemView< dim, Number >::gamma_minus_one_over_gamma_plus_one ( ) const

inline

Definition at line 182 of file hyperbolic_system.h.

◆ precomputation_loop() [1/5]

template<int dim, typename Number >

template<typename DISPATCH , typename SPARSITY >

void ryujin::Euler::HyperbolicSystemView< dim, Number >::precomputation_loop	(	unsigned int	cycle,
		const DISPATCH &	dispatch_check,
		precomputed_vector_type &	precomputed_values,
		const SPARSITY &	sparsity_simd,
		const vector_type &	U,
		unsigned int	left,
		unsigned int	right
	)		const

Step 0: precompute values for hyperbolic update. This routine is called within our usual loop() idiom in HyperbolicModule

◆ density()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::Euler::HyperbolicSystemView< dim, Number >::density ( const state_type & U )

inlinestatic

For a given (2+dim dimensional) state vector U, return the density U[0]

Definition at line 732 of file hyperbolic_system.h.

◆ filter_vacuum_density()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::Euler::HyperbolicSystemView< dim, Number >::filter_vacuum_density ( const Number & rho ) const

inline

Given a density rho this function returns 0 if the magniatude of rho is smaller or equal than relaxation_large * rho_cutoff. Otherwise rho is returned unmodified. Here, rho_cutoff is the reference density multiplied by eps.

Definition at line 740 of file hyperbolic_system.h.

◆ momentum()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE dealii::Tensor< 1, dim, Number > ryujin::Euler::HyperbolicSystemView< dim, Number >::momentum ( const state_type & U )

inlinestatic

For a given (2+dim dimensional) state vector U, return the momentum vector [U[1], ..., U[1+dim]].

Definition at line 754 of file hyperbolic_system.h.

◆ total_energy()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::Euler::HyperbolicSystemView< dim, Number >::total_energy ( const state_type & U )

inlinestatic

For a given (2+dim dimensional) state vector U, return the total energy U[1+dim]

Definition at line 765 of file hyperbolic_system.h.

◆ internal_energy()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::Euler::HyperbolicSystemView< dim, Number >::internal_energy ( const state_type & U )

inlinestatic

For a given (2+dim dimensional) state vector U, compute and return the internal energy \(\varepsilon = (\rho e)\).

Definition at line 773 of file hyperbolic_system.h.

◆ internal_energy_derivative()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::internal_energy_derivative ( const state_type & U )

inlinestatic

For a given (2+dim dimensional) state vector U, compute and return the derivative of the internal energy \(\varepsilon = (\rho e)\).

Definition at line 787 of file hyperbolic_system.h.

◆ pressure()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::Euler::HyperbolicSystemView< dim, Number >::pressure ( const state_type & U ) const

inline

For a given (2+dim dimensional) state vector U, compute and return the pressure \(p\).

We assume that the pressure is given by a polytropic equation of state, i.e.,

\[ p = (\gamma - 1)\;(\rho e) \]

Definition at line 814 of file hyperbolic_system.h.

◆ speed_of_sound()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::Euler::HyperbolicSystemView< dim, Number >::speed_of_sound ( const state_type & U ) const

inline

For a given (2+dim dimensional) state vector U, compute the (physical) speed of sound:

\[ c^2 = \frac{\gamma\,p}{\rho} \]

Definition at line 823 of file hyperbolic_system.h.

◆ specific_entropy()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::Euler::HyperbolicSystemView< dim, Number >::specific_entropy ( const state_type & U ) const

inline

For a given (2+dim dimensional) state vector U, compute and return the (scaled) specific entropy

\[ e^{(\gamma-1)s} = \frac{\rho\,e}{\rho^\gamma}. \]

Definition at line 834 of file hyperbolic_system.h.

References ryujin::pow().

◆ harten_entropy()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::Euler::HyperbolicSystemView< dim, Number >::harten_entropy ( const state_type & U ) const

inline

For a given (2+dim dimensional) state vector U, compute and return the Harten-type entropy

\[ \eta = (\rho^2 e) ^ {1 / (\gamma + 1)}. \]

Definition at line 845 of file hyperbolic_system.h.

References ryujin::pow().

◆ harten_entropy_derivative()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::harten_entropy_derivative ( const state_type & U ) const

inline

For a given (2+dim dimensional) state vector U, compute and return the derivative \(\eta'\) of the Harten-type entropy

\[ \eta = (\rho^2 e) ^ {1 / (\gamma + 1)}. \]

Definition at line 860 of file hyperbolic_system.h.

References ryujin::pow().

◆ mathematical_entropy()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE Number ryujin::Euler::HyperbolicSystemView< dim, Number >::mathematical_entropy ( const state_type & U ) const

inline

For a given (2+dim dimensional) state vector U, compute and return the entropy \(\eta = p^{1/\gamma}\).

Definition at line 897 of file hyperbolic_system.h.

References ryujin::pow().

◆ mathematical_entropy_derivative()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::mathematical_entropy_derivative ( const state_type & U ) const

inline

For a given (2+dim dimensional) state vector U, compute and return the derivative \(\eta'\) of the entropy \(\eta = p^{1/\gamma}\).

Definition at line 908 of file hyperbolic_system.h.

References ryujin::pow().

◆ is_admissible()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE bool ryujin::Euler::HyperbolicSystemView< dim, Number >::is_admissible ( const state_type & U ) const

inline

Returns whether the state U is admissible. If U is a vectorized state then U is admissible if all vectorized values are admissible.

Definition at line 945 of file hyperbolic_system.h.

◆ linearized_eigenvector() [1/2]

template<int dim, typename Number >

template<int component>

std::array< state_type, 2 > ryujin::Euler::HyperbolicSystemView< dim, Number >::linearized_eigenvector	(	const state_type &	U,
		const dealii::Tensor< 1, dim, Number > &	normal
	)		const

For a given state U and normal direction normal returns the n-th pair of left and right eigenvectors of the linearized normal flux.

◆ prescribe_riemann_characteristic() [1/4]

template<int dim, typename Number >

template<int component>

state_type ryujin::Euler::HyperbolicSystemView< dim, Number >::prescribe_riemann_characteristic	(	const state_type &	U,
		const state_type &	U_bar,
		const dealii::Tensor< 1, dim, Number > &	normal
	)		const

Decomposes a given state U into Riemann invariants and then replaces the first or second Riemann characteristic from the one taken from U_bar state. Note that the U_bar state is just the prescribed dirichlet values.

◆ apply_boundary_conditions() [1/5]

template<int dim, typename Number >

template<typename Lambda >

state_type ryujin::Euler::HyperbolicSystemView< dim, Number >::apply_boundary_conditions	(	const dealii::types::boundary_id	id,
		const state_type &	U,
		const dealii::Tensor< 1, dim, Number > &	normal,
		const Lambda &	get_dirichlet_data
	)		const

Apply boundary conditions.

For the compressible Euler equations we have:

Dirichlet boundary conditions by prescribing the return value of get_dirichlet_data() as is.
Slip boundary conditions where we remove the normal component of the momentum.
No slip boundary conditions where we set the momentum to 0.
"Dynamic boundary" conditions that prescribe different Riemann invariants from the return value of get_dirichlet_data() depending on the flow state (supersonic versus subsonic, outflow versus inflow).

◆ f()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::f ( const state_type & U ) const

inline

Given a state U compute the flux

\[ \begin{pmatrix} \textbf m \\ \textbf v\otimes \textbf m + p\mathbb{I}_d \\ \textbf v(E+p) \end{pmatrix}, \]

Definition at line 1154 of file hyperbolic_system.h.

◆ flux_contribution() [1/2]

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::flux_contribution	(	const precomputed_vector_type &	pv,
		const precomputed_initial_vector_type &	piv,
		const unsigned int	i,
		const state_type &	U_i
	)		const

inline

Given a state U_i and an index i compute flux contributions.

Intended usage:

Indicator<dim, Number> indicator;
for (unsigned int i = n_internal; i < n_owned; ++i) {
  // ...
  const auto flux_i = flux_contribution(precomputed..., i, U_i);
  for (unsigned int col_idx = 1; col_idx < row_length; ++col_idx) {
    // ...
    const auto flux_j = flux_contribution(precomputed..., js, U_j);
    const auto flux_ij = flux_divergence(flux_i, flux_j, c_ij);
  }
}

For the Euler equations we simply compute f(U_i).

Definition at line 1176 of file hyperbolic_system.h.

◆ flux_contribution() [2/2]

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::flux_contribution	(	const precomputed_vector_type &	pv,
		const precomputed_initial_vector_type &	piv,
		const unsigned int *	js,
		const state_type &	U_j
	)		const

inline

Definition at line 1188 of file hyperbolic_system.h.

◆ flux_divergence()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::flux_divergence	(	const flux_contribution_type &	flux_i,
		const flux_contribution_type &	flux_j,
		const dealii::Tensor< 1, dim, Number > &	c_ij
	)		const

inline

Given flux contributions flux_i and flux_j compute the flux (-f(U_i) - f(U_j)

Definition at line 1200 of file hyperbolic_system.h.

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

◆ high_order_flux_divergence()

template<int dim, typename Number >

state_type ryujin::Euler::HyperbolicSystemView< dim, Number >::high_order_flux_divergence	(	const flux_contribution_type &	flux_i,
		const flux_contribution_type &	flux_j,
		const dealii::Tensor< 1, dim, Number > &	c_ij
	)		const

delete

◆ nodal_source() [1/2]

template<int dim, typename Number >

state_type ryujin::Euler::HyperbolicSystemView< dim, Number >::nodal_source	(	const precomputed_vector_type &	pv,
		const unsigned int	i,
		const state_type &	U_i,
		const ScalarNumber	tau
	)		const

delete

◆ nodal_source() [2/2]

template<int dim, typename Number >

state_type ryujin::Euler::HyperbolicSystemView< dim, Number >::nodal_source	(	const precomputed_vector_type &	pv,
		const unsigned int *	js,
		const state_type &	U_j,
		const ScalarNumber	tau
	)		const

delete

◆ expand_state() [1/4]

template<int dim, typename Number >

template<typename ST >

state_type ryujin::Euler::HyperbolicSystemView< dim, Number >::expand_state ( const ST & state ) const

Given a state vector associated with a different spatial dimensions than the current one, return an "expanded" version of the state vector associated with dim spatial dimensions where the momentum vector of the conserved state state is expaned with zeros to a total length of dim entries.

Note: dim has to be larger or equal than the dimension of the ST vector.

◆ from_initial_state() [1/4]

template<int dim, typename Number >

template<typename ST >

state_type ryujin::Euler::HyperbolicSystemView< dim, Number >::from_initial_state ( const ST & initial_state ) const

Given an initial state [rho, u_1, ..., u_?, p] return a conserved state [rho, m_1, ..., m_d, E].

This function simply calls from_primitive_state() and expand_state().

Note: This function is used to conveniently convert (user provided) primitive initial states with pressure values to a conserved state in the EulerInitialStateLibrary. As such, this function is implemented in the Euler::HyperbolicSystem and EulerAEOS::HyperbolicSystem classes.

◆ from_primitive_state()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::from_primitive_state ( const state_type & primitive_state ) const

inline

Given a primitive state [rho, u_1, ..., u_d, p] return a conserved state

Definition at line 1245 of file hyperbolic_system.h.

◆ to_primitive_state()

template<int dim, typename Number >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::to_primitive_state ( const state_type & state ) const

inline

Given a conserved state return a primitive state [rho, u_1, ..., u_d, p]

Definition at line 1267 of file hyperbolic_system.h.

◆ apply_galilei_transform() [1/4]

template<int dim, typename Number >

template<typename Lambda >

state_type ryujin::Euler::HyperbolicSystemView< dim, Number >::apply_galilei_transform	(	const state_type &	state,
		const Lambda &	lambda
	)		const

Transform the current state according to a given operator lambda acting on a dim dimensional momentum (or velocity) vector.

◆ precomputation_loop() [2/5]

template<int dim, typename Number >

template<typename DISPATCH , typename SPARSITY >

DEAL_II_ALWAYS_INLINE void ryujin::Euler::HyperbolicSystemView< dim, Number >::precomputation_loop	(	unsigned int	cycle,
		const DISPATCH &	dispatch_check,
		precomputed_vector_type &	precomputed_values,
		const SPARSITY &	sparsity_simd,
		const vector_type &	U,
		unsigned int	left,
		unsigned int	right
	)		const

inline

Definition at line 697 of file hyperbolic_system.h.

References RYUJIN_OMP_FOR.

◆ linearized_eigenvector() [2/2]

template<int dim, typename Number >

template<int component>

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::linearized_eigenvector	(	const state_type &	U,
		const dealii::Tensor< 1, dim, Number > &	normal
	)		const -> std::array<state_type, 2>

inline

Definition at line 975 of file hyperbolic_system.h.

◆ prescribe_riemann_characteristic() [2/4]

template<int dim, typename Number >

template<int component>

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::prescribe_riemann_characteristic	(	const state_type &	U,
		const state_type &	U_bar,
		const dealii::Tensor< 1, dim, Number > &	normal
	)		const -> state_type

inline

Definition at line 1030 of file hyperbolic_system.h.

References ryujin::pow().

◆ apply_boundary_conditions() [2/5]

template<int dim, typename Number >

template<typename Lambda >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::apply_boundary_conditions	(	dealii::types::boundary_id	id,
		const state_type &	U,
		const dealii::Tensor< 1, dim, Number > &	normal,
		const Lambda &	get_dirichlet_data
	)		const -> state_type

inline

Definition at line 1089 of file hyperbolic_system.h.

References ryujin::dirichlet, ryujin::dynamic, ryujin::no_slip, and ryujin::slip.

◆ expand_state() [2/4]

template<int dim, typename Number >

template<typename ST >

auto ryujin::Euler::HyperbolicSystemView< dim, Number >::expand_state ( const ST & state ) const -> state_type

Definition at line 1211 of file hyperbolic_system.h.

◆ from_initial_state() [2/4]

template<int dim, typename Number >

template<typename ST >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::from_initial_state ( const ST & initial_state ) const -> state_type

inline

Definition at line 1235 of file hyperbolic_system.h.

◆ apply_galilei_transform() [2/4]

template<int dim, typename Number >

template<typename Lambda >

auto ryujin::Euler::HyperbolicSystemView< dim, Number >::apply_galilei_transform	(	const state_type &	state,
		const Lambda &	lambda
	)		const -> state_type

Definition at line 1287 of file hyperbolic_system.h.

◆ precomputation_loop() [3/5]

template<int dim, typename Number >

template<typename DISPATCH , typename SPARSITY >

DEAL_II_ALWAYS_INLINE void ryujin::Euler::HyperbolicSystemView< dim, Number >::precomputation_loop	(	unsigned int	cycle,
		const DISPATCH &	dispatch_check,
		precomputed_vector_type &	precomputed_values,
		const SPARSITY &	sparsity_simd,
		const vector_type &	U,
		unsigned int	left,
		unsigned int	right
	)		const

inline

Definition at line 809 of file hyperbolic_system.h.

References RYUJIN_OMP_FOR, and RYUJIN_OMP_SINGLE.

◆ prescribe_riemann_characteristic() [3/4]

template<int dim, typename Number >

template<int component>

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::prescribe_riemann_characteristic	(	const state_type &	U,
		const state_type &	U_bar,
		const dealii::Tensor< 1, dim, Number > &	normal
	)		const -> state_type

inline

Definition at line 1166 of file hyperbolic_system.h.

References ryujin::pow().

◆ apply_boundary_conditions() [3/5]

template<int dim, typename Number >

template<typename Lambda >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::apply_boundary_conditions	(	dealii::types::boundary_id	id,
		const state_type &	U,
		const dealii::Tensor< 1, dim, Number > &	normal,
		const Lambda &	get_dirichlet_data
	)		const -> state_type

inline

Definition at line 1239 of file hyperbolic_system.h.

References ryujin::dirichlet, ryujin::dynamic, ryujin::no_slip, and ryujin::slip.

◆ expand_state() [3/4]

template<int dim, typename Number >

template<typename ST >

auto ryujin::Euler::HyperbolicSystemView< dim, Number >::expand_state ( const ST & state ) const -> state_type

Definition at line 1368 of file hyperbolic_system.h.

◆ from_initial_state() [3/4]

template<int dim, typename Number >

template<typename ST >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::from_initial_state ( const ST & initial_state ) const -> state_type

inline

Definition at line 1392 of file hyperbolic_system.h.

◆ apply_galilei_transform() [3/4]

template<int dim, typename Number >

template<typename Lambda >

auto ryujin::Euler::HyperbolicSystemView< dim, Number >::apply_galilei_transform	(	const state_type &	state,
		const Lambda &	lambda
	)		const -> state_type

Definition at line 1452 of file hyperbolic_system.h.

◆ precomputation_loop() [4/5]

template<int dim, typename Number >

template<typename DISPATCH , typename SPARSITY >

DEAL_II_ALWAYS_INLINE void ryujin::Euler::HyperbolicSystemView< dim, Number >::precomputation_loop	(	unsigned int	cycle,
		const DISPATCH &	dispatch_check,
		precomputed_vector_type &	precomputed_values,
		const SPARSITY &	sparsity_simd,
		const vector_type &	U,
		unsigned int	left,
		unsigned int	right
	)		const

inline

Definition at line 592 of file hyperbolic_system.h.

References RYUJIN_OMP_FOR.

◆ apply_boundary_conditions() [4/5]

template<int dim, typename Number >

template<typename Lambda >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::apply_boundary_conditions	(	dealii::types::boundary_id	id,
		const state_type &	U,
		const dealii::Tensor< 1, dim, Number > &	,
		const Lambda &	get_dirichlet_data
	)		const -> state_type

inline

Definition at line 683 of file hyperbolic_system.h.

References ryujin::dirichlet, ryujin::dynamic, ryujin::no_slip, and ryujin::slip.

◆ precomputation_loop() [5/5]

template<int dim, typename Number >

template<typename DISPATCH , typename SPARSITY >

DEAL_II_ALWAYS_INLINE void ryujin::Euler::HyperbolicSystemView< dim, Number >::precomputation_loop	(	unsigned int	cycle,
		const DISPATCH &	dispatch_check,
		precomputed_vector_type &	precomputed_values,
		const SPARSITY &	sparsity_simd,
		const vector_type &	U,
		unsigned int	left,
		unsigned int	right
	)		const

inline

Definition at line 672 of file hyperbolic_system.h.

References ryujin::pow(), and RYUJIN_OMP_FOR.

◆ prescribe_riemann_characteristic() [4/4]

template<int dim, typename Number >

template<int component>

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::prescribe_riemann_characteristic	(	const state_type &	U,
		const state_type &	U_bar,
		const dealii::Tensor< 1, dim, Number > &	normal
	)		const -> state_type

inline

Definition at line 891 of file hyperbolic_system.h.

◆ apply_boundary_conditions() [5/5]

template<int dim, typename Number >

template<typename Lambda >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::apply_boundary_conditions	(	const dealii::types::boundary_id	id,
		const state_type &	U,
		const dealii::Tensor< 1, dim, Number > &	normal,
		const Lambda &	get_dirichlet_data
	)		const -> state_type

inline

Definition at line 940 of file hyperbolic_system.h.

References ryujin::dirichlet, ryujin::dirichlet_momentum, ryujin::dynamic, ryujin::no_slip, and ryujin::slip.

◆ expand_state() [4/4]

template<int dim, typename Number >

template<typename ST >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::expand_state ( const ST & state ) const -> state_type

inline

Definition at line 1245 of file hyperbolic_system.h.

◆ from_initial_state() [4/4]

template<int dim, typename Number >

template<typename ST >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::from_initial_state ( const ST & initial_state ) const -> state_type

inline

Definition at line 1267 of file hyperbolic_system.h.

◆ apply_galilei_transform() [4/4]

template<int dim, typename Number >

template<typename Lambda >

DEAL_II_ALWAYS_INLINE auto ryujin::Euler::HyperbolicSystemView< dim, Number >::apply_galilei_transform	(	const state_type &	state,
		const Lambda &	lambda
	)		const -> state_type

inline

Definition at line 1310 of file hyperbolic_system.h.

Member Data Documentation

◆ have_gamma

template<int dim, typename Number >

constexpr bool ryujin::Euler::HyperbolicSystemView< dim, Number >::have_gamma = true

staticconstexpr

constexpr boolean used in the EulerInitialStates namespace

Definition at line 191 of file hyperbolic_system.h.

◆ have_eos_interpolation_b

template<int dim, typename Number >

constexpr bool ryujin::Euler::HyperbolicSystemView< dim, Number >::have_eos_interpolation_b = false

staticconstexpr

constexpr boolean used in the EulerInitialStates namespace

Definition at line 196 of file hyperbolic_system.h.

◆ problem_dimension

template<int dim, typename Number >

constexpr unsigned int ryujin::Euler::HyperbolicSystemView< dim, Number >::problem_dimension = 2 + dim

staticconstexpr

The dimension of the state space.

Definition at line 217 of file hyperbolic_system.h.

◆ component_names

template<int dim, typename Number >

const auto ryujin::Euler::HyperbolicSystemView< dim, Number >::component_names

inlinestatic

Initial value:

=
          []() -> std::array<std::string, problem_dimension> {
        if constexpr (dim == 1)
          return {"rho", "m", "E"};
        else if constexpr (dim == 2)
          return {"rho", "m_1", "m_2", "E"};
        else if constexpr (dim == 3)
          return {"rho", "m_1", "m_2", "m_3", "E"};
        __builtin_trap();
      }()

An array holding all component names of the conserved state as a string.

Definition at line 233 of file hyperbolic_system.h.

◆ primitive_component_names

template<int dim, typename Number >

const auto ryujin::Euler::HyperbolicSystemView< dim, Number >::primitive_component_names

inlinestatic

Initial value:

=
          []() -> std::array<std::string, problem_dimension> {
        if constexpr (dim == 1)
          return {"rho", "v", "p"};
        else if constexpr (dim == 2)
          return {"rho", "v_1", "v_2", "p"};
        else if constexpr (dim == 3)
          return {"rho", "v_1", "v_2", "v_3", "p"};
        __builtin_trap();
      }()

An array holding all component names of the primitive state as a string.

Definition at line 248 of file hyperbolic_system.h.

◆ n_precomputed_initial_values

template<int dim, typename Number >

constexpr unsigned int ryujin::Euler::HyperbolicSystemView< dim, Number >::n_precomputed_initial_values = 0

staticconstexpr

The number of precomputed initial values.

Definition at line 279 of file hyperbolic_system.h.

◆ precomputed_initial_names

template<int dim, typename Number >

const auto ryujin::Euler::HyperbolicSystemView< dim, Number >::precomputed_initial_names

inlinestatic

Initial value:

=

std::array<std::string, n_precomputed_initial_values>{}

An array holding all component names of the precomputed values.

Definition at line 297 of file hyperbolic_system.h.

◆ n_precomputed_values

template<int dim, typename Number >

constexpr unsigned int ryujin::Euler::HyperbolicSystemView< dim, Number >::n_precomputed_values = 2

staticconstexpr

The number of precomputed values.

Definition at line 303 of file hyperbolic_system.h.

◆ precomputed_names

template<int dim, typename Number >

const auto ryujin::Euler::HyperbolicSystemView< dim, Number >::precomputed_names

inlinestatic

Initial value:

=

std::array<std::string, n_precomputed_values>{"s", "eta_h"}

An array holding all component names of the precomputed values.

Definition at line 319 of file hyperbolic_system.h.

◆ n_precomputation_cycles

template<int dim, typename Number >

constexpr unsigned int ryujin::Euler::HyperbolicSystemView< dim, Number >::n_precomputation_cycles = 1

staticconstexpr

The number of precomputation cycles.

Definition at line 325 of file hyperbolic_system.h.

◆ have_high_order_flux

template<int dim, typename Number >

constexpr bool ryujin::Euler::HyperbolicSystemView< dim, Number >::have_high_order_flux = false

staticconstexpr

The low-order and high-order fluxes are the same

Definition at line 565 of file hyperbolic_system.h.

◆ have_source_terms

template<int dim, typename Number >

constexpr bool ryujin::Euler::HyperbolicSystemView< dim, Number >::have_source_terms = false

staticconstexpr

We do not have source terms:

Definition at line 579 of file hyperbolic_system.h.

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

source/euler/hyperbolic_system.h
source/euler_aeos/hyperbolic_system.h
source/scalar_conservation/hyperbolic_system.h
source/shallow_water/hyperbolic_system.h

Public Types

Public Member Functions

Types and compile time constants

Precomputed quantities

Access to cached inverses

Flux computations

Computing stencil source terms

Computing derived physical quantities

Detailed Description

Member Typedef Documentation

◆ ScalarNumber

◆ state_type

◆ vector_type

◆ flux_type

◆ flux_contribution_type

◆ precomputed_initial_state_type

◆ precomputed_initial_vector_type

◆ precomputed_state_type

◆ precomputed_vector_type

Constructor & Destructor Documentation

◆ HyperbolicSystemView()

Member Function Documentation

◆ view()

◆ gamma()

◆ reference_density()

◆ vacuum_state_relaxation_small()

◆ vacuum_state_relaxation_large()

◆ gamma_inverse()

◆ gamma_plus_one_inverse()

◆ gamma_minus_one_inverse()

◆ gamma_minus_one_over_gamma_plus_one()

◆ precomputation_loop() [1/5]

◆ density()

◆ filter_vacuum_density()

◆ momentum()

◆ total_energy()

◆ internal_energy()

◆ internal_energy_derivative()

◆ pressure()

◆ speed_of_sound()

◆ specific_entropy()

◆ harten_entropy()

◆ harten_entropy_derivative()

◆ mathematical_entropy()

◆ mathematical_entropy_derivative()

◆ is_admissible()

◆ linearized_eigenvector() [1/2]

◆ prescribe_riemann_characteristic() [1/4]

◆ apply_boundary_conditions() [1/5]

◆ f()

◆ flux_contribution() [1/2]

◆ flux_contribution() [2/2]

◆ flux_divergence()

◆ high_order_flux_divergence()

◆ nodal_source() [1/2]

◆ nodal_source() [2/2]

◆ expand_state() [1/4]

◆ from_initial_state() [1/4]

◆ from_primitive_state()

◆ to_primitive_state()

◆ apply_galilei_transform() [1/4]

◆ precomputation_loop() [2/5]

◆ linearized_eigenvector() [2/2]

◆ prescribe_riemann_characteristic() [2/4]

◆ apply_boundary_conditions() [2/5]

◆ expand_state() [2/4]

◆ from_initial_state() [2/4]

◆ apply_galilei_transform() [2/4]

◆ precomputation_loop() [3/5]

◆ prescribe_riemann_characteristic() [3/4]

◆ apply_boundary_conditions() [3/5]

◆ expand_state() [3/4]

◆ from_initial_state() [3/4]

◆ apply_galilei_transform() [3/4]

◆ precomputation_loop() [4/5]

◆ apply_boundary_conditions() [4/5]

◆ precomputation_loop() [5/5]

◆ prescribe_riemann_characteristic() [4/4]

◆ apply_boundary_conditions() [5/5]

◆ expand_state() [4/4]