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) |
| Do initialization steps such as starting MPI (if necessary), parsing the Unix command line, and reading runtime options from the configuration file. | |
| static int | finalize () |
| Do finalization steps such as calling MPI_finalize() (if necessary), and collecting and printing timing information. | |
| 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 () |
| Set to true if a message should be written by each processor at startup. | |
| static bool & | skipTimingOutput () |
| Decide whether to skip timing outputs to work around a trilinos 6.0.x bug. | |
| static int & | testStatus () |
| static CommandLineProcessor & | clp () |
Static Private Member Functions | |
| static bool | checkTest (double error, double tol) |
| static RCP< GlobalMPISession > | globalMPISession (int *argc, char ***argv) |
Every simulation code should begin with a call to Sundance::init() and end with a call to Sundance::finalize().
Definition at line 226 of file Sundance.hpp.
| bool SundanceGlobal::checkTest | ( | double | error, | |
| double | tol | |||
| ) | [static, private] |
Definition at line 312 of file Sundance.cpp.
References Playa::MPIComm::allReduce(), Playa::MPIDataType::intType(), Playa::MPIOp::sumOp(), and Playa::MPIComm::world().
Referenced by passFailTest().
| CommandLineProcessor & clp | ( | ) | [inline, static] |
Definition at line 302 of file Sundance.hpp.
Referenced by Sundance::clp(), init(), and setOption().
| int finalize | ( | ) | [static] |
Do finalization steps such as calling MPI_finalize() (if necessary), and collecting and printing timing information.
Definition at line 279 of file Sundance.cpp.
References handleException(), skipTimingOutput(), Sundance::QuadratureEvalMediator::totalFlops(), Sundance::CellJacobianBatch::totalFlops(), Sundance::RefIntegral::totalFlops(), Sundance::QuadratureIntegralBase::totalFlops(), Sundance::EvalVector::totalFlops(), totalTimer(), and Playa::MPIComm::world().
Referenced by Sundance::finalize().
| static RCP<GlobalMPISession> Sundance::SundanceGlobal::globalMPISession | ( | int * | argc, | |
| char *** | argv | |||
| ) | [inline, static, private] |
| void handleException | ( | std::exception & | e | ) | [static] |
Definition at line 270 of file Sundance.cpp.
References testStatus().
Referenced by finalize(), Sundance::handleException(), and init().
| int 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 141 of file Sundance.cpp.
References clp(), Sundance::VersionString::date(), globalMPISession(), handleException(), Sundance::VersionString::number(), skipTimingOutput(), Sundance::toString(), totalTimer(), Sundance::Assembler::workSetSize(), and Playa::MPIComm::world().
Referenced by Sundance::init().
| static Teuchos::FancyOStream& Sundance::SundanceGlobal::os | ( | ) | [static] |
| bool passFailTest | ( | const std::string & | statusMsg, | |
| bool | status, | |||
| double | error, | |||
| double | tol | |||
| ) | [static] |
Definition at line 346 of file Sundance.cpp.
References checkTest(), testStatus(), and Playa::MPIComm::world().
| bool passFailTest | ( | double | error, | |
| double | tol | |||
| ) | [static] |
Definition at line 321 of file Sundance.cpp.
References checkTest(), testStatus(), and Playa::MPIComm::world().
| bool passFailTest | ( | bool | pass | ) | [static] |
Definition at line 375 of file Sundance.cpp.
References testStatus(), and Playa::MPIComm::world().
Referenced by Sundance::passFailTest().
| void SundanceGlobal::setOption | ( | const std::string & | optionTrueName, | |
| const std::string & | optionFalseName, | |||
| bool & | value, | |||
| const std::string & | helpMsg | |||
| ) | [static] |
| void SundanceGlobal::setOption | ( | const std::string & | optionName, | |
| double & | value, | |||
| const std::string & | helpMsg | |||
| ) | [static] |
| void SundanceGlobal::setOption | ( | const std::string & | optionName, | |
| std::string & | value, | |||
| const std::string & | helpMsg | |||
| ) | [static] |
| void SundanceGlobal::setOption | ( | const std::string & | optionName, | |
| int & | value, | |||
| const std::string & | helpMsg | |||
| ) | [static] |
| bool & SundanceGlobal::showStartupMessage | ( | ) | [static] |
Set to true if a message should be written by each processor at startup.
Definition at line 258 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 294 of file Sundance.hpp.
Referenced by finalize(), and init().
| int & testStatus | ( | ) | [inline, static] |
Definition at line 298 of file Sundance.hpp.
Referenced by handleException(), passFailTest(), and Sundance::testStatus().