#include <source/time_loop.h>

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

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

Public Types
using	HyperbolicSystem = typename Description::HyperbolicSystem

using	ParabolicSystem = typename Description::ParabolicSystem

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

using	scalar_type = typename OfflineData< dim, Number >::scalar_type

using	vector_type = MultiComponentVector< Number, problem_dimension >

using	precomputed_type = MultiComponentVector< Number, n_precomputed_values >

Public Member Functions
	TimeLoop (const MPI_Comm &mpi_comm)

void	run ()

Static Public Attributes
static constexpr unsigned int	problem_dimension

static constexpr unsigned int	n_precomputed_values

Protected Member Functions
Private methods for run()
void	compute_error (const vector_type &U, Number t)

void	output (const vector_type &U, const std::string &name, Number t, unsigned int cycle)

void	print_parameters (std::ostream &stream)

void	print_mpi_partition (std::ostream &stream)

void	print_memory_statistics (std::ostream &stream)

void	print_timers (std::ostream &stream)

void	print_throughput (unsigned int cycle, Number t, std::ostream &stream, bool final_time=false)

void	print_info (const std::string &header)

void	print_head (const std::string &header, const std::string &secondary, std::ostream &stream)

void	print_cycle_statistics (unsigned int cycle, Number t, unsigned int output_cycle, bool write_to_logfile=false, bool final_time=false)

Detailed Description

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

The high-level time loop driving the computation.

Definition at line 36 of file time_loop.h.

Member Typedef Documentation

◆ HyperbolicSystem

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

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

Definition at line 42 of file time_loop.h.

◆ ParabolicSystem

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

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

Definition at line 47 of file time_loop.h.

◆ HyperbolicSystemView

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

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

Definition at line 52 of file time_loop.h.

◆ scalar_type

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

using ryujin::TimeLoop< Description, dim, Number >::scalar_type = typename OfflineData<dim, Number>::scalar_type

Shorthand typedef for dealii::LinearAlgebra::distributed::Vector<Number>.

Definition at line 71 of file time_loop.h.

◆ vector_type

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

using ryujin::TimeLoop< Description, dim, Number >::vector_type = MultiComponentVector<Number, problem_dimension>

Typedef for a MultiComponentVector storing the state U.

Definition at line 76 of file time_loop.h.

◆ precomputed_type

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

using ryujin::TimeLoop< Description, dim, Number >::precomputed_type = MultiComponentVector<Number, n_precomputed_values>

Typedef for a MultiComponentVector storing precomputed values.

Definition at line 81 of file time_loop.h.

Constructor & Destructor Documentation

◆ TimeLoop()

template<typename Description , int dim, typename Number >

ryujin::TimeLoop< Description, dim, Number >::TimeLoop ( const MPI_Comm & mpi_comm )

Constructor.

Definition at line 28 of file time_loop.template.h.

Member Function Documentation

◆ run()

template<typename Description , int dim, typename Number >

void ryujin::TimeLoop< Description, dim, Number >::run

Run the high-level time loop.

Definition at line 192 of file time_loop.template.h.

References ryujin::Checkpointing::load_mesh(), ryujin::Checkpointing::load_state_vector(), and ryujin::MultiComponentVector< Number, n_comp, simd_length >::write_tensor().

Referenced by ryujin::EquationDispatch::run().

◆ compute_error()

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

void ryujin::TimeLoop< Description, dim, Number >::compute_error	(	const vector_type &	U,
		Number	t
	)

protected

Definition at line 415 of file time_loop.template.h.

References ryujin::MultiComponentVector< Number, n_comp, simd_length >::extract_component(), and ryujin::pow().

◆ output()

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

void ryujin::TimeLoop< Description, dim, Number >::output	(	const vector_type &	U,
		const std::string &	name,
		Number	t,
		unsigned int	cycle
	)

protected

Definition at line 556 of file time_loop.template.h.

References ryujin::MultiComponentVector< Number, n_comp, simd_length >::reinit_with_scalar_partitioner(), and ryujin::Checkpointing::write_checkpoint().

◆ print_parameters()

template<typename Description , int dim, typename Number >

void ryujin::TimeLoop< Description, dim, Number >::print_parameters ( std::ostream & stream )

protected

Definition at line 630 of file time_loop.template.h.

◆ print_mpi_partition()

template<typename Description , int dim, typename Number >

void ryujin::TimeLoop< Description, dim, Number >::print_mpi_partition ( std::ostream & stream )

protected

Definition at line 673 of file time_loop.template.h.

◆ print_memory_statistics()

template<typename Description , int dim, typename Number >

void ryujin::TimeLoop< Description, dim, Number >::print_memory_statistics ( std::ostream & stream )

protected

Definition at line 745 of file time_loop.template.h.

◆ print_timers()

template<typename Description , int dim, typename Number >

void ryujin::TimeLoop< Description, dim, Number >::print_timers ( std::ostream & stream )

protected

Definition at line 773 of file time_loop.template.h.

◆ print_throughput()

template<typename Description , int dim, typename Number >

void ryujin::TimeLoop< Description, dim, Number >::print_throughput	(	unsigned int	cycle,
		Number	t,
		std::ostream &	stream,
		bool	final_time = `false`
	)

protected

Definition at line 858 of file time_loop.template.h.

References ryujin::ScalarConservation::ParabolicSystem::is_identity.

◆ print_info()

template<typename Description , int dim, typename Number >

void ryujin::TimeLoop< Description, dim, Number >::print_info ( const std::string & header )

protected

Definition at line 1021 of file time_loop.template.h.

◆ print_head()

template<typename Description , int dim, typename Number >

void ryujin::TimeLoop< Description, dim, Number >::print_head	(	const std::string &	header,
		const std::string &	secondary,
		std::ostream &	stream
	)

protected

Definition at line 1032 of file time_loop.template.h.

◆ print_cycle_statistics()

template<typename Description , int dim, typename Number >

void ryujin::TimeLoop< Description, dim, Number >::print_cycle_statistics	(	unsigned int	cycle,
		Number	t,
		unsigned int	output_cycle,
		bool	write_to_logfile = `false`,
		bool	final_time = `false`
	)

protected

Definition at line 1061 of file time_loop.template.h.

References ryujin::ScalarConservation::ParabolicSystem::is_identity.

Member Data Documentation

◆ problem_dimension

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

constexpr unsigned int ryujin::TimeLoop< Description, dim, Number >::problem_dimension

staticconstexpr

Initial value:

=

HyperbolicSystemView::problem_dimension

Definition at line 58 of file time_loop.h.

◆ n_precomputed_values

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

constexpr unsigned int ryujin::TimeLoop< Description, dim, Number >::n_precomputed_values

staticconstexpr

Initial value:

=

HyperbolicSystemView::n_precomputed_values

Definition at line 64 of file time_loop.h.

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

source/time_loop.h
source/time_loop.template.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ HyperbolicSystem

◆ ParabolicSystem

◆ HyperbolicSystemView

◆ scalar_type

◆ vector_type

◆ precomputed_type

Constructor & Destructor Documentation

◆ TimeLoop()

Member Function Documentation

◆ run()

◆ compute_error()

◆ output()

◆ print_parameters()

◆ print_mpi_partition()

◆ print_memory_statistics()

◆ print_timers()

◆ print_throughput()

◆ print_info()

◆ print_head()

◆ print_cycle_statistics()

Member Data Documentation

◆ problem_dimension

◆ n_precomputed_values