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

#include <source/vtu_output.h>

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

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

Public Member Functions
Constructor and setup
	VTUOutput (const MPIEnsemble &mpi_ensemble, const OfflineData< dim, Number > &offline_data, const HyperbolicSystem &hyperbolic_system, const ParabolicSystem &parabolic_system, const Postprocessor< Description, dim, Number > &postprocessor, const InitialPrecomputedVector &initial_precomputed, const ScalarVector &alpha, const std::string &subsection="/VTUOutput")
void	prepare ()
void	schedule_output (const StateVector &state_vector, std::string name, Number t, unsigned int cycle, bool output_full=true, bool output_cutplanes=true)

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	precomputed_type = typename View::precomputed_type
using	StateVector = typename View::StateVector
using	InitialPrecomputedVector = typename View::InitialPrecomputedVector
using	ScalarVector = Vectors::ScalarVector< Number >
static constexpr auto	problem_dimension = View::problem_dimension
static constexpr auto	n_precomputed_values = View::n_precomputed_values

Detailed Description

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

the VTUOutput class implements output of the conserved state vector and a number of postprocessed quantities computed by the Postprocessor class.

Definition at line 30 of file vtu_output.h.

Member Typedef Documentation

HyperbolicSystem

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

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

Definition at line 38 of file vtu_output.h.

ParabolicSystem

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

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

Definition at line 39 of file vtu_output.h.

View

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

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

Definition at line 41 of file vtu_output.h.

state_type

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

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

Definition at line 46 of file vtu_output.h.

precomputed_type

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

using ryujin::VTUOutput< Description, dim, Number >::precomputed_type = typename View::precomputed_type

Definition at line 50 of file vtu_output.h.

StateVector

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

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

Definition at line 52 of file vtu_output.h.

InitialPrecomputedVector

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

using ryujin::VTUOutput< Description, dim, Number >::InitialPrecomputedVector = typename View::InitialPrecomputedVector

Definition at line 53 of file vtu_output.h.

ScalarVector

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

using ryujin::VTUOutput< Description, dim, Number >::ScalarVector = Vectors::ScalarVector<Number>

Definition at line 54 of file vtu_output.h.

Constructor & Destructor Documentation

VTUOutput()

template<typename Description , int dim, typename Number >

ryujin::VTUOutput< Description, dim, Number >::VTUOutput	(	const MPIEnsemble &	mpi_ensemble,
		const OfflineData< dim, Number > &	offline_data,
		const HyperbolicSystem &	hyperbolic_system,
		const ParabolicSystem &	parabolic_system,
		const Postprocessor< Description, dim, Number > &	postprocessor,
		const InitialPrecomputedVector &	initial_precomputed,
		const ScalarVector &	alpha,
		const std::string &	subsection = "/VTUOutput< Description, dim, Number >"
	)

Constructor.

Definition at line 22 of file vtu_output.template.h.

Member Function Documentation

prepare()

template<typename Description , int dim, typename Number >

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

Prepare VTU output. A call to prepare() allocates temporary storage and is necessary before schedule_output() can be called.

Calling prepare() allocates temporary storage for additional (dim + 5) scalar vectors of type OfflineData::scalar_type.

Definition at line 68 of file vtu_output.template.h.

References ryujin::SelectedComponentsExtractor< Description, dim, Number >::check().

schedule_output()

template<typename Description , int dim, typename Number >

void ryujin::VTUOutput< Description, dim, Number >::schedule_output	(	const StateVector &	state_vector,
		std::string	name,
		Number	t,
		unsigned int	cycle,
		bool	output_full = true,
		bool	output_cutplanes = true
	)

Given a state vector U and a file name prefix name, the current time t, and the current output cycle cycle) schedule a solution output.

The function post-processes quantities synchronously, and (depending on configuration options) schedules the write-out asynchronously onto a background worker thread. This implies that U can again be modified once schedule_output() returned.

The booleans output_full controls whether the full vector field is written out. Correspondingly, output_cutplanes controls whether cells in the vicinity of predefined cutplanes are written out.

The function requires MPI communication and is not reentrant.

Definition at line 80 of file vtu_output.template.h.

Member Data Documentation

problem_dimension

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

constexpr auto ryujin::VTUOutput< Description, dim, Number >::problem_dimension = View::problem_dimension

staticconstexpr

Definition at line 44 of file vtu_output.h.

n_precomputed_values

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

constexpr auto ryujin::VTUOutput< Description, dim, Number >::n_precomputed_values = View::n_precomputed_values

staticconstexpr

Definition at line 48 of file vtu_output.h.

---

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

• source/vtu_output.h
• source/vtu_output.template.h