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

Inheritance diagram for ryujin::Equation< HyperbolicDescription, ParabolicDescription, Number >:

Collaboration diagram for ryujin::Equation< HyperbolicDescription, ParabolicDescription, Number >:

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

void	run (int dim, const std::string &parameter_file, const MPI_Comm &mpi_comm) const override

void	create_parameter_files () const override

Public Member Functions inherited from ryujin::Interface::Equation
virtual	~Equation ()=default

Additional Inherited Members
Protected Member Functions inherited from ryujin::Interface::Equation
	Equation (const std::string &name)

Detailed Description

template<typename HyperbolicDescription, typename ParabolicDescription, typename Number = double>
class ryujin::Equation< HyperbolicDescription, ParabolicDescription, Number >

The equation that pairs the HyperbolicDescription with the ParabolicDescription, for the number type Number.

Definition at line 26 of file equation.h.

Constructor & Destructor Documentation

◆ Equation()

template<typename HyperbolicDescription , typename ParabolicDescription , typename Number = double>

ryujin::Equation< HyperbolicDescription, ParabolicDescription, Number >::Equation ( const std::string & name )

inline

Constructor taking the name of the equation.

Definition at line 32 of file equation.h.

Member Function Documentation

◆ run()

template<typename HyperbolicDescription , typename ParabolicDescription , typename Number >

void ryujin::Equation< HyperbolicDescription, ParabolicDescription, Number >::run	(	int	dim,
		const std::string &	parameter_file,
		const MPI_Comm &	mpi_comm
	)		const

overridevirtual

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

Implements ryujin::Interface::Equation.

Definition at line 24 of file equation.template.h.

◆ create_parameter_files()

template<typename HyperbolicDescription , typename ParabolicDescription , typename Number >

void ryujin::Equation< HyperbolicDescription, ParabolicDescription, Number >::create_parameter_files ( ) const

overridevirtual

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

Implements ryujin::Interface::Equation.

Definition at line 56 of file equation.template.h.

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

include/ryujin/typed/equation.h
include/ryujin/typed/equation.template.h