This class sets up the environment underlying the use of the QUESO library by an executable. More...
#include <Environment.h>
Inheritance diagram for QUESO::EmptyEnvironment:
Collaboration diagram for QUESO::EmptyEnvironment:
Public Member Functions | |
| void | print (std::ostream &os) const |
Constructor/Destructor methods | |
| EmptyEnvironment () | |
| Default constructor. Does nothing. More... | |
| ~EmptyEnvironment () | |
| Destructor. More... | |
 Public Member Functions inherited from QUESO::BaseEnvironment | |
| BaseEnvironment (const char *passedOptionsInputFileName, EnvOptionsValues *alternativeOptionsValues) | |
| Default constructor. More... | |
| BaseEnvironment (const std::string &passedOptionsInputFileName, EnvOptionsValues *alternativeOptionsValues) | |
| virtual | ~BaseEnvironment () |
| Destructor. More... | |
| bool | fullEnvIsReady () const |
| Returns whether the full environment class is ready (constructor has successfully been called). More... | |
| int | worldRank () const |
| Returns the process world rank. More... | |
| int | fullRank () const |
| Returns the process full rank. More... | |
| const MpiComm & | fullComm () const |
| Access function for MpiComm full communicator. More... | |
| RawType_MPI_Group | subGroup () const |
| Access function for sub-group. More... | |
| int | subRank () const |
| Access function for sub-rank. More... | |
| const MpiComm & | subComm () const |
| Access function for MpiComm sub communicator. More... | |
| const MpiComm & | selfComm () const |
| Access function for MpiComm self-communicator. More... | |
| int | inter0Rank () const |
| Returns the process inter0 rank. More... | |
| const MpiComm & | inter0Comm () const |
| Access function for MpiComm inter0-communicator. More... | |
| std::ofstream * | subDisplayFile () const |
| Access function for m_subDisplayFile (displays file on stream). More... | |
| std::string | subDisplayFileName () const |
| Access function for m_subDisplayFileName (displays filename on stream). More... | |
| unsigned int | numSubEnvironments () const |
| Access function to the number of sub-environments. More... | |
| unsigned int | subId () const |
| Access function to the number of each sub-environment Id: m_subId. More... | |
| const std::string & | subIdString () const |
| Access to the attribute m_subIdString; which stores the string for the sub-environment, and it will be used, for instance, to create the output files for each sub-environment. More... | |
| void | checkTheParallelEnvironment () const |
| std::string | optionsInputFileName () const |
| Access to the attribute m_optionsInputFileName, which stores the name of the input file passed by the user to QUESO. More... | |
| void | setOptionsInputFileAccessState (bool newState) const |
| boost::program_options::variables_map & | allOptionsMap () const |
| void | scanInputFileForMyOptions (const boost::program_options::options_description &optionsDesc) const |
| This method scans the input file provided by the user to QUESO. More... | |
| unsigned int | displayVerbosity () const |
| unsigned int | syncVerbosity () const |
| Access function to private attribute m_syncVerbosity. More... | |
| unsigned int | checkingLevel () const |
| Access function to private attribute m_checkingLevel. More... | |
| const RngBase * | rngObject () const |
| Access to the RNG object. More... | |
| void | resetSeed (int newSeedOption) |
| Reset RNG seed. More... | |
| int | seed () const |
| Access to the RNG seed. More... | |
| const BasicPdfsBase * | basicPdfs () const |
| Access to Basic PDFs. More... | |
| std::string | platformName () const |
| Access to the platform name. More... | |
| std::string | identifyingString () const |
| Access function to private attribute m_identifyingString: identifying string. More... | |
| void | resetIdentifyingString (const std::string &newString) |
Reset private attribute m_identifyingString with the value newString. More... | |
| bool | isThereInputFile () const |
| //TODO Not implemented? it is called in examples/validationCycle/tests_old/results_5_25/uqTgaEx4.h. More... | |
| struct timeval | timevalBegin () const |
| Used to save the time when the combo `QUESO+user's application' started to run. More... | |
| bool | openOutputFile (const std::string &fileName, const std::string &fileType, const std::set< unsigned int > &allowedSubEnvIds, bool writeOver, FilePtrSetStruct &filePtrSet) const |
| Opens an output file for each sub-environment that was chosen to send data to the file. More... | |
| bool | openUnifiedOutputFile (const std::string &fileName, const std::string &fileType, bool writeOver, FilePtrSetStruct &filePtrSet) const |
| Opens a unified output file, that will contain data from all sub-environments. More... | |
| bool | openInputFile (const std::string &fileName, const std::string &fileType, const std::set< unsigned int > &allowedSubEnvIds, FilePtrSetStruct &filePtrSet) const |
| Opens an input file. More... | |
| bool | openUnifiedInputFile (const std::string &fileName, const std::string &fileType, FilePtrSetStruct &filePtrSet) const |
| Opens the unified input file. More... | |
| void | closeFile (FilePtrSetStruct &filePtrSet, const std::string &fileType) const |
| Closes the file. More... | |
| void | setExceptionalCircumstance (bool value) const |
| Set an exceptional circumstance. More... | |
| bool | exceptionalCircumstance () const |
| Decides whether there is an exceptional circumstance. More... | |
| const GetPot & | input () const |
| The GetPot input file parser. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from QUESO::BaseEnvironment | |
| bool | m_fullEnvIsReady |
| int | m_worldRank |
| MpiComm * | m_fullComm |
| int | m_fullRank |
| int | m_fullCommSize |
| RawType_MPI_Group | m_fullGroup |
| std::string | m_optionsInputFileName |
| bool | m_optionsInputFileAccessState |
| boost::program_options::options_description * | m_allOptionsDesc |
| boost::program_options::variables_map * | m_allOptionsMap |
| ScopedPtr< GetPot >::Type | m_input |
| unsigned int | m_subId |
| std::string | m_subIdString |
| RawType_MPI_Group | m_subGroup |
| MpiComm * | m_subComm |
| int | m_subRank |
| int | m_subCommSize |
| MpiComm * | m_selfComm |
| RawType_MPI_Group | m_inter0Group |
| MpiComm * | m_inter0Comm |
| int | m_inter0Rank |
| int | m_inter0CommSize |
| std::ofstream * | m_subDisplayFile |
| RngBase * | m_rngObject |
| BasicPdfsBase * | m_basicPdfs |
| struct timeval | m_timevalBegin |
| bool | m_exceptionalCircumstance |
| EnvOptionsValues * | m_optionsObj |
Detailed Description
This class sets up the environment underlying the use of the QUESO library by an executable.
Definition at line 411 of file Environment.h.
Constructor & Destructor Documentation
| QUESO::EmptyEnvironment::EmptyEnvironment | ( | ) |
Default constructor. Does nothing.
It initialized BaseEnvironment with no input file and a NULL pointer for the alternativeOptionsValues.
Definition at line 1157 of file Environment.C.
BaseEnvironment(const char *passedOptionsInputFileName, EnvOptionsValues *alternativeOptionsValues)
Default constructor.
Definition: Environment.C:141
| QUESO::EmptyEnvironment::~EmptyEnvironment | ( | ) |
Member Function Documentation
|
virtual |
Implements QUESO::BaseEnvironment.
Definition at line 1168 of file Environment.C.
The documentation for this class was generated from the following files:
- src/core/inc/Environment.h
- src/core/src/Environment.C