Sundance::SundanceGlobal Class Reference

List of all members.

Static Public Member Functions
static void	setOption (const std::string &optionName, int &value, const std::string &helpMsg)
static void	setOption (const std::string &optionName, std::string &value, const std::string &helpMsg)
static void	setOption (const std::string &optionName, double &value, const std::string &helpMsg)
static void	setOption (const std::string &optionTrueName, const std::string &optionFalseName, bool &value, const std::string &helpMsg)
static int	init (int *argc, char ***argv)
static int	finalize ()
static void	handleException (std::exception &e)
static Teuchos::FancyOStream &	os ()
static bool	passFailTest (bool pass)
static bool	passFailTest (double error, double tol)
static bool	passFailTest (const std::string &statusMsg, bool status, double error, double tol)
static bool &	showStartupMessage ()
static bool &	skipTimingOutput ()
static int &	testStatus ()
static CommandLineProcessor &	clp ()
static bool	checkTest (double error, double tol)
Related Functions
(Note that these are not member functions.)
void	handleException (std::exception &e)
bool	passFailTest (bool pass)
bool	passFailTest (double error, double tol)
bool	passFailTest (const std::string &statusMsg, bool status, double error, double tol)
int &	testStatus ()
CommandLineProcessor &	clp ()
int	init (int *argc, char ***argv)
int	finalize ()

---

Detailed Description

Class Sundance provides several static methods for managing the environment of a simulation. Every simulation code should begin with a call to Sundance::init() and end with a call to Sundance::finalize().

Definition at line 240 of file Sundance.hpp.

---

Member Function Documentation

bool SundanceGlobal::checkTest	(	double	error,
		double	tol
	)		[static]

Definition at line 312 of file Sundance.cpp.

static CommandLineProcessor& Sundance::SundanceGlobal::clp

(

)

[inline, static]

Definition at line 316 of file Sundance.hpp.

Referenced by Sundance::clp().

int SundanceGlobal::finalize

(

)

[static]

Do finalization steps such as calling MPI_finalize() (if necessary), and collecting and printing timing information.

Definition at line 288 of file Sundance.cpp.

References handleException(), and totalTimer().

Referenced by Sundance::finalize().

void SundanceGlobal::handleException

(

std::exception &

e

)

[static]

Definition at line 279 of file Sundance.cpp.

References testStatus().

Referenced by Sundance::handleException().

int SundanceGlobal::init	(	int *	argc,
		char ***	argv
	)		[static]

Do initialization steps such as starting MPI (if necessary), parsing the Unix command line, and reading runtime options from the configuration file. MPI is initialized through a call to Teuchos::GlobalMPISession, which in turn checks whether MPI needs initialization and calls MPI_Init() if necessary. If some other library you're using has its own MPI initialization system, it is thus perfectly safe to call Sundance::init() as well.

Definition at line 157 of file Sundance.cpp.

References clp(), handleException(), Sundance::init(), Teuchos::toString(), and totalTimer().

Referenced by Sundance::init().

static Teuchos::FancyOStream& Sundance::SundanceGlobal::os

(

)

[static]

bool SundanceGlobal::passFailTest

(

bool

pass

)

[static]

Definition at line 377 of file Sundance.cpp.

References testStatus().

Referenced by Sundance::passFailTest().

bool SundanceGlobal::passFailTest	(	double	error,
		double	tol
	)		[static]

Definition at line 321 of file Sundance.cpp.

References testStatus().

bool SundanceGlobal::passFailTest	(	const std::string &	statusMsg,
		bool	status,
		double	error,
		double	tol
	)		[static]

Definition at line 347 of file Sundance.cpp.

References testStatus().

void SundanceGlobal::setOption	(	const std::string &	optionName,
		int &	value,
		const std::string &	helpMsg
	)		[static]

Definition at line 396 of file Sundance.cpp.

References clp(), and Sundance::value.

Referenced by Sundance::setOption().

void SundanceGlobal::setOption	(	const std::string &	optionName,
		std::string &	value,
		const std::string &	helpMsg
	)		[static]

Definition at line 410 of file Sundance.cpp.

References clp(), and Sundance::value.

void SundanceGlobal::setOption	(	const std::string &	optionName,
		double &	value,
		const std::string &	helpMsg
	)		[static]

Definition at line 403 of file Sundance.cpp.

References clp(), and Sundance::value.

void SundanceGlobal::setOption	(	const std::string &	optionTrueName,
		const std::string &	optionFalseName,
		bool &	value,
		const std::string &	helpMsg
	)		[static]

Definition at line 417 of file Sundance.cpp.

References clp(), and Sundance::value.

bool & SundanceGlobal::showStartupMessage

(

)

[static]

Set to true if a message should be written by each processor at startup.

Definition at line 272 of file Sundance.cpp.

static bool& Sundance::SundanceGlobal::skipTimingOutput

(

)

[inline, static]

Decide whether to skip timing outputs to work around a trilinos 6.0.x bug

Definition at line 308 of file Sundance.hpp.

static int& Sundance::SundanceGlobal::testStatus

(

)

[inline, static]

Definition at line 312 of file Sundance.hpp.

Referenced by Sundance::testStatus().

---

Friends And Related Function Documentation

CommandLineProcessor & clp

(

)

[related]

Definition at line 105 of file Sundance.cpp.

Referenced by init(), and setOption().

int finalize

(

)

[related]

Definition at line 113 of file Sundance.cpp.

void handleException

(

std::exception &

e

)

[related]

Definition at line 86 of file Sundance.cpp.

Referenced by finalize(), and init().

int init	(	int *	argc,
		char ***	argv
	)		[related]

Definition at line 109 of file Sundance.cpp.

bool passFailTest

(

bool

pass

)

[related]

Definition at line 90 of file Sundance.cpp.

bool passFailTest	(	double	error,
		double	tol
	)		[related]

Definition at line 93 of file Sundance.cpp.

bool passFailTest	(	const std::string &	statusMsg,
		bool	status,
		double	error,
		double	tol
	)		[related]

Definition at line 97 of file Sundance.cpp.

int & testStatus

(

)

[related]

Definition at line 101 of file Sundance.cpp.

Referenced by handleException(), and passFailTest().