ryujin::Quantities< Description, dim, Number > Class Template Reference

#include <source/quantities.h>

Inheritance diagram for ryujin::Quantities< Description, dim, Number >:

Collaboration diagram for ryujin::Quantities< Description, dim, Number >:

Public Types
Typedefs and constexpr constants
using	HyperbolicSystem = typename Description::HyperbolicSystem
using	ParabolicSystem = typename Description::ParabolicSystem
using	View = typename Description::template HyperbolicSystemView< dim, Number >
using	state_type = typename View::state_type
using	StateVector = typename View::StateVector

Public Member Functions
Constructor and setup
	Quantities (const MPIEnsemble &mpi_ensemble, const OfflineData< dim, Number > &offline_data, const HyperbolicSystem &hyperbolic_system, const ParabolicSystem &parabolic_system, const std::string &subsection="/Quantities")
void	prepare (const std::string &name)
void	accumulate (const StateVector &state_vector, const Number t)
void	write_out (const StateVector &state_vector, const Number t, unsigned int cycle)

Detailed Description

template<typename Description, int dim, typename Number = double>
class ryujin::Quantities< Description, dim, Number >

A postprocessor class for quantities of interest.

Definition at line 30 of file quantities.h.

Member Typedef Documentation

HyperbolicSystem

template<typename Description , int dim, typename Number = double>

using ryujin::Quantities< Description, dim, Number >::HyperbolicSystem = typename Description::HyperbolicSystem

Definition at line 38 of file quantities.h.

ParabolicSystem

template<typename Description , int dim, typename Number = double>

using ryujin::Quantities< Description, dim, Number >::ParabolicSystem = typename Description::ParabolicSystem

Definition at line 39 of file quantities.h.

View

template<typename Description , int dim, typename Number = double>

using ryujin::Quantities< Description, dim, Number >::View = typename Description::template HyperbolicSystemView<dim, Number>

Definition at line 41 of file quantities.h.

state_type

template<typename Description , int dim, typename Number = double>

using ryujin::Quantities< Description, dim, Number >::state_type = typename View::state_type

Definition at line 44 of file quantities.h.

StateVector

template<typename Description , int dim, typename Number = double>

using ryujin::Quantities< Description, dim, Number >::StateVector = typename View::StateVector

Definition at line 46 of file quantities.h.

Constructor & Destructor Documentation

Quantities()

template<typename Description , int dim, typename Number >

ryujin::Quantities< Description, dim, Number >::Quantities	(	const MPIEnsemble &	mpi_ensemble,
		const OfflineData< dim, Number > &	offline_data,
		const HyperbolicSystem &	hyperbolic_system,
		const ParabolicSystem &	parabolic_system,
		const std::string &	subsection = "/Quantities< Description, dim, Number >"
	)

Constructor.

Definition at line 51 of file quantities.template.h.

Member Function Documentation

prepare()

template<typename Description , int dim, typename Number >

void ryujin::Quantities< Description, dim, Number >::prepare

(

const std::string &

name

)

Prepare evaluation. A call to prepare() allocates temporary storage and is necessary before accumulate() and write_out() can be called.

Calling prepare() allocates temporary storage for various boundary and interior maps. The storage requirement varies according to the supplied manifold descriptions.

The string parameter name is used as base name for output files.

Definition at line 91 of file quantities.template.h.

accumulate()

template<typename Description , int dim, typename Number >

void ryujin::Quantities< Description, dim, Number >::accumulate	(	const StateVector &	state_vector,
		const Number	t
	)

Takes a state vector U at time t (obtained at the end of a full Strang step) and accumulates statistics for quantities of interests for all defined manifolds.

Definition at line 501 of file quantities.template.h.

References RYUJIN_UNLIKELY.

write_out()

template<typename Description , int dim, typename Number >

void ryujin::Quantities< Description, dim, Number >::write_out	(	const StateVector &	state_vector,
		const Number	t,
		unsigned int	cycle
	)

Write quantities of interest to designated output files.

Definition at line 572 of file quantities.template.h.

---

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

• source/quantities.h
• source/quantities.template.h