ryujin::Interface::Equation Class Reference

#include <include/ryujin/interface/equation.h>

Inheritance diagram for ryujin::Interface::Equation:

Public Member Functions
virtual	~Equation ()=default
virtual void	run (int dim, const std::string &parameter_file, const MPI_Comm &mpi_comm) const =0
virtual void	create_parameter_files () const =0

Protected Member Functions
	Equation (const std::string &name)

Detailed Description

An equation: a pairing of a hyperbolic and a parabolic description that can be selected by name with the run time parameter "equation".

Definition at line 25 of file equation.h.

Constructor & Destructor Documentation

~Equation()

virtual ryujin::Interface::Equation::~Equation ( )

virtualdefault

Equation()

ryujin::Interface::Equation::Equation ( const std::string &  name )

inlineprotected

The name of the equation, as selected by the run time parameter "equation".

Definition at line 51 of file equation.h.

Member Function Documentation

run()

virtual void ryujin::Interface::Equation::run ( int  dim, const std::string &  parameter_file, const MPI_Comm &  mpi_comm  ) const

pure virtual

Construct and run the simulation for dimension dim with the parameters of parameter_file.

Implemented in ryujin::Equation< HyperbolicDescription, ParabolicDescription, Number >.

create_parameter_files()

virtual void ryujin::Interface::Equation::create_parameter_files ( ) const

pure virtual

Write the default parameter files of the equation for all dimensions.

Implemented in ryujin::Equation< HyperbolicDescription, ParabolicDescription, Number >.

---

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

• include/ryujin/interface/equation.h