ryujin 2.1.1 revision 9391072059490dd712e0ea92785f21acd6605f00
List of all members
ryujin::TimeLoop< Description, dim, Number > Class Template Referencefinal
Time Integration and Postprocessing

#include <source/time_loop.h>

Inheritance diagram for ryujin::TimeLoop< Description, dim, Number >:
Inheritance graph
[legend]
Collaboration diagram for ryujin::TimeLoop< Description, dim, Number >:
Collaboration graph
[legend]

Public Member Functions

Constructor and setup
 TimeLoop (const MPI_Comm &mpi_comm)
 
void run ()
 

Protected Member Functions

Private methods for run()
void compute_error (StateVector &state_vector, Number t)
 
void output (StateVector &state_vector, const std::string &name, const Number t, const 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)
 

Typedefs and constexpr constants

using HyperbolicSystem = typename Description::HyperbolicSystem
 
using View = typename Description::template HyperbolicSystemView< dim, Number >
 
using ParabolicSystem = typename Description::ParabolicSystem
 
using ParabolicSolver = typename Description::template ParabolicSolver< dim, Number >
 
using ScalarNumber = typename View::ScalarNumber
 
using StateVector = typename View::StateVector
 
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::TimeLoop< Description, dim, Number >

The high-level time loop driving the computation.

Definition at line 35 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 43 of file time_loop.h.

◆ View

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

Definition at line 45 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 48 of file time_loop.h.

◆ ParabolicSolver

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

Definition at line 50 of file time_loop.h.

◆ ScalarNumber

template<typename Description , int dim, typename Number = double>
using ryujin::TimeLoop< Description, dim, Number >::ScalarNumber = typename View::ScalarNumber

Definition at line 53 of file time_loop.h.

◆ StateVector

template<typename Description , int dim, typename Number = double>
using ryujin::TimeLoop< Description, dim, Number >::StateVector = typename View::StateVector

Definition at line 59 of file time_loop.h.

◆ ScalarVector

template<typename Description , int dim, typename Number = double>
using ryujin::TimeLoop< Description, dim, Number >::ScalarVector = Vectors::ScalarVector<Number>

Definition at line 61 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 26 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 215 of file time_loop.template.h.

References ryujin::Checkpointing::load_mesh(), and ryujin::Checkpointing::load_state_vector().

Referenced by ryujin::Dispatch< Description, Number >::Dispatch().

◆ compute_error()

template<typename Description , int dim, typename Number >
void ryujin::TimeLoop< Description, dim, Number >::compute_error ( StateVector &  state_vector,
Number  t 
)
protected

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

References ryujin::pow().

◆ output()

template<typename Description , int dim, typename Number >
void ryujin::TimeLoop< Description, dim, Number >::output ( StateVector &  state_vector,
const std::string &  name,
const Number  t,
const unsigned int  cycle 
)
protected

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

References 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 640 of file time_loop.template.h.

References ryujin::print_revision_and_version().

◆ 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 665 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 737 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 765 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 850 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 1013 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 1024 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 1053 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 auto ryujin::TimeLoop< Description, dim, Number >::problem_dimension = View::problem_dimension
staticconstexpr

Definition at line 55 of file time_loop.h.

◆ n_precomputed_values

template<typename Description , int dim, typename Number = double>
constexpr auto ryujin::TimeLoop< Description, dim, Number >::n_precomputed_values = View::n_precomputed_values
staticconstexpr

Definition at line 57 of file time_loop.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.4