ryujin::EquationDispatch Class Reference

#include <include/ryujin/driver/equation_dispatch.h>

Inheritance diagram for ryujin::EquationDispatch:

Collaboration diagram for ryujin::EquationDispatch:

Public Member Functions
	EquationDispatch ()
void	dispatch (const std::string &parameter_file, const MPI_Comm &mpi_comm)

Static Public Member Functions
static void	create_parameter_files ()

Detailed Description

Dispatcher class that runs the equation selected in the parameter file.

When starting up the ryujin executable we are faced with the following difficulties:

• The Simulation class is templated in the HyperbolicDescription, the ParabolicDescription, and the dimension that have to be read from the ryujin.prm parameter file.
• The final set of valid parameters that can be configured in the ryujin.prm depend on the runtime parameters "dimension" and "equation" themselves.

We thus first read in two parameters from the parameter file:

subsection B - Equation
  set dimension           = ...
  set equation            = ...
end

and then run the equation of the EquationLibrary with the given name for the given dimension.

Definition at line 52 of file equation_dispatch.h.

Constructor & Destructor Documentation

EquationDispatch()

ryujin::EquationDispatch::EquationDispatch ( )

inline

Definition at line 55 of file equation_dispatch.h.

References ryujin::dave, and ryujin::Library< Base, Args >::selection().

Member Function Documentation

create_parameter_files()

static void ryujin::EquationDispatch::create_parameter_files ( )

inlinestatic

Write the default parameter files of all registered equations.

Definition at line 79 of file equation_dispatch.h.

References ryujin::Library< Base, Args >::create(), and ryujin::dave.

dispatch()

void ryujin::EquationDispatch::dispatch ( const std::string &  parameter_file, const MPI_Comm &  mpi_comm  )

inline

Read the parameters "dimension" and "equation" from parameter_file and run the selected equation.

Definition at line 97 of file equation_dispatch.h.

References ryujin::dave, and ryujin::Library< Base, Args >::select().

---

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

• include/ryujin/driver/equation_dispatch.h