sierra::Env::Startup Class Reference

Class Startup is a sentry class for starting the application. It ensures that the command line arguments, platform and MPI are ready to go at the start of the application. More...

#include <Env.hpp>

List of all members.

Public Member Functions
	Startup (int *argc, char ***argv, const char *product_name, const char *build_date_time, ExecType mpi_key=EXEC_TYPE_WORLD, const std::vector< int > *peer_sizes=NULL)
	Creates a new Startup instance.
	~Startup ()
	Destroys a Startup instance. IT closes all logging output streams and will finalize MPI only if the Startup::Startup initialized the MPI.

---

Detailed Description

Class Startup is a sentry class for starting the application. It ensures that the command line arguments, platform and MPI are ready to go at the start of the application.

Definition at line 122 of file Env.hpp.

---

Constructor & Destructor Documentation

sierra::Env::Startup::Startup	(	int *	argc,
		char ***	argv,
		const char *	product_name,
		const char *	build_date_time,
		ExecType	mpi_key = EXEC_TYPE_WORLD,
		const std::vector< int > *	peer_sizes = NULL
	)

Creates a new Startup instance.

Parameters:

argc	an int pointer to the main argc.
argv	a char pointer to the main argv.
product_name	a char const pointer to the name of the product.
build_date_time	a char const pointer to __DATE__ " " __TIME__
mpi_key	an optional ExecType enumeration specifying the type of executable. Default is a single executable using MPI_COMM_WORLD. Other options result in a split communicator.
peer_sizes	an optional std::vector<int> const pointer containing the number of processors that each peer communicator (

See also:

parrallel_peer_comm()) will support. The number of peers is determined by the size of the vector. Only used if mpi_key = EXEC_TYPE_PEER

Definition at line 783 of file Env.cpp.

---

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

• Env.hpp
• Env.cpp