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

Public Member Functions
	Environment (int &argc, char **&argv)

	Environment (const Environment &)=delete

Environment &	operator= (const Environment &)=delete

	~Environment ()

MPI_Comm	mpi_communicator () const

Detailed Description

The execution environment of a program using ryujin.

The constructor performs various tasks including

flushing denormals to zero,
initializing MPI,
setting up thread pools (obeying thread limits),
initializing instrumentation (LIKWID and NVTX markers).

The destructor closes the instrumentation and finalizes MPI.

int main(int argc, char *argv[])
{
  ryujin::Environment environment(argc, argv);
 
  ryujin::Simulation<HyperbolicDescription, ParabolicDescription, dim>
      simulation(environment.mpi_communicator());
 
  ryujin::TaskComposition<2> task_composition(simulation);
 
  dealii::ParameterAcceptor::initialize("simulation.prm");
 
  task_composition.run();
}

Definition at line 45 of file environment.h.

Constructor & Destructor Documentation

◆ Environment() [1/2]

ryujin::Environment::Environment	(	int &	argc,
		char **&	argv
	)

Constructor taking the command line arguments of the program.

◆ Environment() [2/2]

ryujin::Environment::Environment ( const Environment & )

delete

◆ ~Environment()

ryujin::Environment::~Environment ( )

Destructor.

Member Function Documentation

◆ operator=()

Environment & ryujin::Environment::operator= ( const Environment & )

delete

◆ mpi_communicator()

MPI_Comm ryujin::Environment::mpi_communicator ( ) const

inline

The MPI communicator.

Definition at line 64 of file environment.h.

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

include/ryujin/driver/environment.h

Public Member Functions