Driver

Collaboration diagram for Driver:

Classes
class	ryujin::EquationDispatch
class	ryujin::Simulation< HD, PD, dim, Number >
class	ryujin::TimeLoop< dim, Number >

Typedefs
using	ryujin::EquationLibrary = Library< Interface::Equation >

Functions
int	ryujin::run (int argc, char *argv[])

Detailed Description

The EquationDispatch class that selects an equation by name, the library of available equations, the Simulation, and the TimeLoop (include/ryujin/driver).

Typedef Documentation

EquationLibrary

using ryujin::EquationLibrary = typedef Library<Interface::Equation>

The library of equations: a registry of all pairings of a hyperbolic and a parabolic description that the EquationDispatch can select by name. The equations of ryujin are registered by default.

A client can add an equation of its own with

EquationLibrary::add([]() {
  return std::make_unique<
      Equation<HyperbolicDescription, ParabolicDescription, Number>>(
      "equation");
});

Definition at line 32 of file equation_library.h.

Function Documentation

run()

int ryujin::run	(	int	argc,
		char *	argv[]
	)

The entry point of the ryujin executable.

Initializes MPI and the thread pools, and determines the parameter file: the only command line argument argv[1] if given, and <executable name>.prm otherwise. If the parameter file does not exist the default parameter files of all registered equations are written. Otherwise the equation selected in the parameter file is run.

A client executable registers its own equations, initial states, and geometries with the respective Library and then calls this function:

int main(int argc, char *argv[])
{
  ryujin::EquationLibrary::add(...);
  return ryujin::run(argc, argv);
}

Returns the exit code of the executable.