This (virtual) class sets up the environment underlying the use of the QUESO library by an executable. More...

#include <Environment.h>

Inheritance diagram for QUESO::BaseEnvironment:

Public Member Functions
Constructor/Destructor methods
	BaseEnvironment (const char passedOptionsInputFileName, EnvOptionsValues alternativeOptionsValues)
	Default constructor. More...

	BaseEnvironment (const std::string &passedOptionsInputFileName, EnvOptionsValues *alternativeOptionsValues)

virtual	~BaseEnvironment ()
	Destructor. More...

Environment, Communicator and Options Input File methods
bool	fullEnvIsReady () const
	Returns whether the full environment class is ready (constructor has successfully been called). More...

int	worldRank () const
	Returns the same thing as fullRank() More...

int	fullRank () const
	Returns the rank of the MPI process in QUESO's full communicator. More...

const MpiComm &	fullComm () const
	Access function for the communicator that was passed to QUESO's environment. More...

RawType_MPI_Group	subGroup () const
	Access function for sub-group. More...

int	subRank () const
	Returns the rank of the MPI process in the sub-communicator subComm() More...

const MpiComm &	subComm () const
	Access function for each sub-environment's 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 communicator for processes with subRank() 0. 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

const boost::program_options::options_description &	allOptionsDesc () 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...

I/O methods
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...

virtual void	print (std::ostream &os) const =0

Protected Attributes
bool	m_fullEnvIsReady

int	m_worldRank

ScopedPtr< MpiComm >::Type	m_fullComm

int	m_fullRank

int	m_fullCommSize

RawType_MPI_Group	m_fullGroup

std::string	m_optionsInputFileName

bool	m_optionsInputFileAccessState

ScopedPtr < boost::program_options::options_description > ::Type	m_allOptionsDesc

ScopedPtr < boost::program_options::variables_map > ::Type	m_allOptionsMap

ScopedPtr< GetPot >::Type	m_input

unsigned int	m_subId

std::string	m_subIdString

RawType_MPI_Group	m_subGroup

ScopedPtr< MpiComm >::Type	m_subComm

int	m_subRank

int	m_subCommSize

ScopedPtr< MpiComm >::Type	m_selfComm

RawType_MPI_Group	m_inter0Group

ScopedPtr< MpiComm >::Type	m_inter0Comm

int	m_inter0Rank

int	m_inter0CommSize

ScopedPtr< std::ofstream >::Type	m_subDisplayFile

ScopedPtr< RngBase >::Type	m_rngObject

ScopedPtr< BasicPdfsBase >::Type	m_basicPdfs

struct timeval	m_timevalBegin

bool	m_exceptionalCircumstance

ScopedPtr< EnvOptionsValues >::Type	m_optionsObj

Detailed Description

This (virtual) class sets up the environment underlying the use of the QUESO library by an executable.

This class sets up the environment underlying the use of the QUESO library by an executable. It:

assigns rank numbers, other than the world rank, to nodes participating in a parallel job,
provides communicators for generating a sequence of vectors in a distributed way,
provides functionality to read options from the 'options input file' (whose name is passed in the constructor of this environment class),
opens output files for messages that would otherwise be written to the screen (one output file per allowed rank is opened and allowed ranks can be specified through the 'options input file').
```
This class is virtual. It is inherited by 'EmptyEnvironment' and 'FullEnvironment'.
The QUESO environment class is instantiated at the application level, right after 'MPI_Init(&argc,&argv)'.
The QUESO environment is required by reference by many constructors in the QUESO library,
and is available by reference from many classes as well.
```
```
Throughout QUESO, there are five classes whose constructors check options in the 'options input file':
```
1. BaseEnvironment
2. StatisticalInverseProblem
3. StatisticalForwardProblem
4. MetropolisHastingsSG ('SG' stands for 'sequence generator')
5. MonteCarloSG
```
These classes rely on 'options classes' to read their options from the input file.
The options classes are, respectively:
```
The last two classes also rely on SequenceStatisticalOptions for reading the options specifying which statistics have to be computed on the sequences of vectors

involved.
```
The QUESO environment class manages five types of communicators. Let:
```
1. 'W >= 1' be the size of whole world communicator involved in a parallel run;
2. 'N >= 1' be the size of the communicator passed to the QUESO environment constructor;
3. 'S >= 1' be the number of statistical problems a QUESO environment will be handling at the same time, in parallel.
Usually 'W'='N', but such equality is not necessary. The number 'S' is equal to the QUESO environment option 'm_numSubEnvironments', and is equal to 1 by default. The number 'N' must be a multiple of 'S', otherwise the QUESO class prints a fatal error message and MPI aborts. The five types of communicators that QUESO manages are referred to as:
1. world = MPI_WORLD_COMM, of size W;
2. full = communicator passed to the constructor of BaseEnvironment, of size N and usually equal to the world communicator;
3. sub = communicator of size N/S that contains the number of MPI nodes necessary to solve a statistical inverse problem or a statistical forward problem.
4. self = MPI_SELF_COMM, of size 1;
5. inter0 = communicator of size S formed by all MPI nodes that have 'sub' rank 0 in their respective 'sub' communicators.
So, any given node has potentially five different ranks. Of course, if the user is solving just one statistical problem with just one MPI node, then all ranks are equal to zero.
```
In the QUESO library terminology, one might refer to a QUESO "full" environment composed of
```
'S' QUESO "sub" environments. Each sub environment is assigned a "sub" id varying from 0 (zero) to S-1. Each sub environment is able to generate a statistical inverse problem and/or a statistical forward problem. That is, each sub environment is able to handle a "sub" Markov chain (a sequence) of vectors and/or a "sub" Monte Carlo sequence of output vectors. The "sub" sequences can be seen as forming a "unified" sequence in a distributed way. Indeed, the virtual class 'VectorSequence' provides "sub" and "unified" statistical operations.

A QUESO "sub" environment eventually prints messages to its own output file. In order for that to happen, the requirements are:
1. option 'm_subDisplayFileName', a string, must be different than the default value ".";
2. option 'm_subDisplayAllowedSet', a set of sub ids, must contain the id of the sub environment wanting to write a message to the output file;
3. the previous requirement is automatically satisfied if the option 'm_subDisplayAllowAll', a boolean, is set to 1 (the default value is 0);
4. the processor wanting to write a message to the output file must have sub rank 0 (zero).
If all requirements are satisfied, then QUESO will generate a file with name '<m_subDisplayFileName>_sub<sub id>.txt'. For instance, if 'm_subDisplayFileName' is 'pROblem_775_' then a node of sub rank 0 in sub environment 17 will write a message to the file 'pROblem_775_sub17.txt'.

Definition at line 198 of file Environment.h.

Constructor & Destructor Documentation

QUESO::BaseEnvironment::BaseEnvironment	(	const char *	passedOptionsInputFileName,
		EnvOptionsValues *	alternativeOptionsValues
	)

Default constructor.

Definition at line 145 of file Environment.C.

References m_optionsInputFileName, and m_optionsObj.

   :
   m_fullEnvIsReady             (false),
   m_worldRank                  (-1),
   m_fullComm                   (),
   m_fullRank                   (-1),
   m_fullCommSize               (1),
   m_optionsInputFileName       (""),
   m_optionsInputFileAccessState(true),
 #ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
   m_allOptionsDesc             (),
   m_allOptionsMap              (),
 #endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
   m_input                      (new GetPot),
   m_subComm                    (),
   m_subRank                    (-1),
   m_subCommSize                (1),
   m_selfComm                   (),
   m_inter0Comm                 (),
   m_inter0Rank                 (-1),
   m_inter0CommSize             (1),
   m_subDisplayFile             (),
   m_rngObject                  (),
   m_basicPdfs                  (),
   m_exceptionalCircumstance    (false),
   m_optionsObj                 ()
 {
   if (passedOptionsInputFileName) m_optionsInputFileName     = passedOptionsInputFileName;
 
   // If the user passed in an options object pointer, we really shouldn't let
   // ScopedPtr delete their object, so we make a copy.  That way, the dtor
   // will kill this local copy and leave the user's object in tact.
   if (alternativeOptionsValues != NULL) {
     m_optionsObj.reset(new EnvOptionsValues(*alternativeOptionsValues));
   }
 }

QUESO::BaseEnvironment::BaseEnvironment	(	const std::string &	passedOptionsInputFileName,
		EnvOptionsValues *	alternativeOptionsValues
	)

Definition at line 184 of file Environment.C.

References m_optionsObj.

   :
   m_fullEnvIsReady             (false),
   m_worldRank                  (-1),
   m_fullComm                   (),
   m_fullRank                   (-1),
   m_fullCommSize               (1),
   m_optionsInputFileName       (passedOptionsInputFileName),
   m_optionsInputFileAccessState(true),
 #ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
   m_allOptionsDesc             (),
   m_allOptionsMap              (),
 #endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
   m_input                      (new GetPot),
   m_subComm                    (),
   m_subRank                    (-1),
   m_subCommSize                (1),
   m_selfComm                   (),
   m_inter0Comm                 (),
   m_inter0Rank                 (-1),
   m_inter0CommSize             (1),
   m_subDisplayFile             (),
   m_rngObject                  (),
   m_basicPdfs                  (),
   m_exceptionalCircumstance    (false),
   m_optionsObj                 ()
 {
   // If the user passed in an options object pointer, we really shouldn't let
   // ScopedPtr delete their object, so we make a copy.  That way, the dtor
   // will kill this local copy and leave the user's object in tact.
   if (alternativeOptionsValues != NULL) {
     m_optionsObj.reset(new EnvOptionsValues(*alternativeOptionsValues));
   }
 }

QUESO::BaseEnvironment::~BaseEnvironment ( )

virtual

Destructor.

It deallocates memory and does other cleanup for the class object and its class members when the object is destroyed. It displays the total run time of the combo QUESO + application using the function gettimeofday() from a struct timeval (as specified in <sys/time.h>).

Definition at line 222 of file Environment.C.

References displayVerbosity(), m_fullRank, m_subDisplayFile, and m_timevalBegin.

 {
   //if (m_subDisplayFile) {
   //  *m_subDisplayFile << "Entering BaseEnvironment::destructor()"
   //                          << std::endl;
   //}
 
   struct timeval timevalNow;
   /*int iRC = 0;*/
   /*iRC = */gettimeofday(&timevalNow, NULL);
 
   if (this->displayVerbosity() > 0) {
     if (m_subDisplayFile) {
        *m_subDisplayFile << "Ending run at "    << ctime(&timevalNow.tv_sec)
                          << "Total run time = " << timevalNow.tv_sec - m_timevalBegin.tv_sec
                          << " seconds"
                          << std::endl;
     }
 
     if (m_fullRank == 0) {
       std::cout << "Ending run at "    << ctime(&timevalNow.tv_sec)
                 << "Total run time = " << timevalNow.tv_sec - m_timevalBegin.tv_sec
                 << " seconds"
                 << std::endl;
       }
     }
 
   //if (m_subDisplayFile) {
   //  *m_subDisplayFile << "Leaving BaseEnvironment::destructor()"
   //                          << std::endl;
   //}
 }

Member Function Documentation

const boost::program_options::options_description & QUESO::BaseEnvironment::allOptionsDesc ( ) const

Definition at line 375 of file Environment.C.

References m_allOptionsDesc.

 {
   queso_deprecated();
 
   return *m_allOptionsDesc;
 }

boost::program_options::variables_map & QUESO::BaseEnvironment::allOptionsMap ( ) const

Access function to private attribute m_allOptionsMap. It is an instance of boost::program_options::variables_map(), which allows concrete variables to map which store variables in real map.

Definition at line 386 of file Environment.C.

References m_allOptionsMap.

Referenced by QUESO::StatisticalInverseProblemOptions::getMyOptionValues(), QUESO::EnvironmentOptions::getMyOptionValues(), and QUESO::MetropolisHastingsSGOptions::getMyOptionValues().

 {
   queso_deprecated();
 
   queso_require_msg(m_allOptionsMap, "m_allOptionsMap variable is NULL");
   return *m_allOptionsMap;
 }

const BasicPdfsBase * QUESO::BaseEnvironment::basicPdfs ( ) const

Access to Basic PDFs.

Definition at line 490 of file Environment.C.

References m_basicPdfs.

 {
   return m_basicPdfs.get();
 }

unsigned int QUESO::BaseEnvironment::checkingLevel ( ) const

Access function to private attribute m_checkingLevel.

Definition at line 464 of file Environment.C.

References m_optionsObj.

Referenced by QUESO::TeuchosMatrix::inverse(), and QUESO::GslMatrix::inverse().

 {
   queso_require_msg(m_optionsObj, "m_optionsObj variable is NULL");
   return m_optionsObj->m_checkingLevel;
 }

void QUESO::BaseEnvironment::checkTheParallelEnvironment ( ) const

void QUESO::BaseEnvironment::closeFile	(	FilePtrSetStruct &	filePtrSet,
		const std::string &	fileType
	)		const

Closes the file.

Definition at line 1084 of file Environment.C.

References QUESO::FilePtrSetStruct::h5Var, QUESO::FilePtrSetStruct::ifsVar, m_subDisplayFile, QUESO::FilePtrSetStruct::ofsVar, subDisplayFile(), and subRank().

Referenced by QUESO::GslVector::subReadContents(), QUESO::TeuchosVector::subReadContents(), QUESO::TeuchosMatrix::subReadContents(), QUESO::GslMatrix::subReadContents(), QUESO::GslVector::subWriteContents(), QUESO::TeuchosVector::subWriteContents(), QUESO::TeuchosMatrix::subWriteContents(), and QUESO::GslMatrix::subWriteContents().

 {
   std::string fileType(inputFileType);
 #ifdef QUESO_HAS_HDF5
   // Do nothing
 #else
   if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
     if (m_subDisplayFile) {
       *this->subDisplayFile() << "WARNING in BaseEnvironment::closeFile()"
                               << ": file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                               << "' has been requested, but this QUESO library has not been built with 'hdf5'"
                               << ". Code will therefore process the file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                               << "' instead..."
                               << std::endl;
     }
     if (this->subRank() == 0) {
       std::cerr << "WARNING in BaseEnvironment::closeFile()"
                 << ": file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                 << "' has been requested, but this QUESO library has not been built with 'hdf5'"
                 << ". Code will therefore process the file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                 << "' instead..."
                 << std::endl;
     }
     fileType = UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT;
   }
 #endif
 
   if ((fileType == UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT) ||
       (fileType == UQ_FILE_EXTENSION_FOR_TXT_FORMAT)) {
     //filePtrSet.ofsVar->close(); // close() crashes on Mac; need to use delete(); why? prudenci 2010/June
     delete filePtrSet.ofsVar;
     filePtrSet.ofsVar = NULL;
 
     //filePtrSet.ifsVar->close();
     delete filePtrSet.ifsVar;
     filePtrSet.ifsVar = NULL;
   }
 #ifdef QUESO_HAS_HDF5
   else if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
     H5Fclose(filePtrSet.h5Var);
   }
 #endif
   else {
     queso_error_msg("invalid file type");
   }
 
   return;
 }

unsigned int QUESO::BaseEnvironment::displayVerbosity ( ) const

Access function to private attribute m_displayVerbosity. It manages how much information will be release during the use of the QUESO library.

Definition at line 450 of file Environment.C.

References m_optionsObj.

 {
   queso_require_msg(m_optionsObj, "m_optionsObj variable is NULL");
   return m_optionsObj->m_displayVerbosity;
 }

bool QUESO::BaseEnvironment::exceptionalCircumstance ( ) const

Decides whether there is an exceptional circumstance.

Definition at line 1143 of file Environment.C.

References m_exceptionalCircumstance.

 {
   return m_exceptionalCircumstance;
 }

const MpiComm & QUESO::BaseEnvironment::fullComm ( ) const

Access function for the communicator that was passed to QUESO's environment.

The 'full' communicator is the MPI communicator that the user passed when creating the QUESO FullEnvironment. This is usually MPI_COMM_WORLD, but the user is permitted to pass any MPI communicator smaller than MPI_COMM_WORLD.

Definition at line 274 of file Environment.C.

References m_fullComm.

Referenced by QUESO::FullEnvironment::construct(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::MiscCheckTheParallelEnvironment(), and QUESO::InterpolationSurrogateIOASCII< V, M >::read().

 {
   queso_require_msg(m_fullComm, "m_fullComm variable is NULL");
   return *m_fullComm;
 }

bool QUESO::BaseEnvironment::fullEnvIsReady ( ) const

Returns whether the full environment class is ready (constructor has successfully been called).

Definition at line 256 of file Environment.C.

References m_fullEnvIsReady.

 {
   return m_fullEnvIsReady;
 }

int QUESO::BaseEnvironment::fullRank ( ) const

Returns the rank of the MPI process in QUESO's full communicator.

Returns the rank of the MPI process in the communicator returned by fullComm().

See fullComm() for what the full communicator is.

Definition at line 268 of file Environment.C.

References m_fullRank.

Referenced by QUESO::GslVector::cwSetBeta(), QUESO::TeuchosVector::cwSetBeta(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::MetropolisHastingsSGOptions::getMyOptionValues(), QUESO::GslMatrix::mpiSum(), QUESO::OptimizerMonitor::print_header(), QUESO::OptimizerMonitor::print_iteration(), QUESO::InterpolationSurrogateIOASCII< V, M >::read(), QUESO::EnvironmentOptions::scanOptionsValues(), QUESO::GslVector::subReadContents(), QUESO::TeuchosVector::subReadContents(), QUESO::TeuchosMatrix::subReadContents(), QUESO::GslMatrix::subReadContents(), and QUESO::MpiComm::syncPrintDebugMsg().

 {
   return m_fullRank;
 }

std::string QUESO::BaseEnvironment::identifyingString ( ) const

Access function to private attribute m_identifyingString: identifying string.

Definition at line 502 of file Environment.C.

References m_optionsObj.

 {
   return m_optionsObj->m_identifyingString;
 }

const GetPot & QUESO::BaseEnvironment::input ( ) const

The GetPot input file parser.

Definition at line 1149 of file Environment.C.

References m_input.

Referenced by QUESO::BaseScalarFunction< V, M >::BaseScalarFunction(), QUESO::EnvOptionsValues::EnvOptionsValues(), QUESO::MLSamplingLevelOptions::getAllOptions(), QUESO::InfiniteDimensionalMCMCSamplerOptions::InfiniteDimensionalMCMCSamplerOptions(), QUESO::MLSamplingOptions::MLSamplingOptions(), QUESO::operator<<(), QUESO::OptimizerOptions::OptimizerOptions(), QUESO::GPMSAOptions::parse(), and QUESO::SipOptionsValues::SipOptionsValues().

 {
   return *m_input;
 }

const MpiComm & QUESO::BaseEnvironment::inter0Comm ( ) const

Access function for MpiComm communicator for processes with subRank() 0.

Definition at line 313 of file Environment.C.

References m_inter0Comm.

Referenced by QUESO::ComputeCovCorrBetweenScalarSequences(), and QUESO::ComputeCovCorrMatricesBetweenVectorSequences().

 {
   queso_require_msg(m_inter0Comm, "m_inter0Comm variable is NULL");
   return *m_inter0Comm;
 }

int QUESO::BaseEnvironment::inter0Rank ( ) const

Returns the process inter0 rank.

Definition at line 307 of file Environment.C.

References m_inter0Rank.

Referenced by QUESO::ComputeCovCorrBetweenScalarSequences(), QUESO::ComputeCovCorrMatricesBetweenVectorSequences(), QUESO::ComputeUnifiedGaussian2dKde(), QUESO::MetropolisHastingsSGOptions::getMyOptionValues(), and QUESO::MpiComm::syncPrintDebugMsg().

 {
   return m_inter0Rank;
 }

bool QUESO::BaseEnvironment::isThereInputFile ( ) const

//TODO Not implemented? it is called in examples/validationCycle/tests_old/results_5_25/uqTgaEx4.h.

unsigned int QUESO::BaseEnvironment::numSubEnvironments ( ) const

Access function to the number of sub-environments.

Definition at line 335 of file Environment.C.

References m_optionsObj.

Referenced by QUESO::ComputeUnifiedGaussian2dKde(), and QUESO::MiscCheckTheParallelEnvironment().

 {
   queso_require_msg(m_optionsObj, "m_optionsObj variable is NULL");
   return m_optionsObj->m_numSubEnvironments;
 }

bool QUESO::BaseEnvironment::openInputFile	(	const std::string &	fileName,
		const std::string &	fileType,
		const std::set< unsigned int > &	allowedSubEnvIds,
		FilePtrSetStruct &	filePtrSet
	)		const

Opens an input file.

Definition at line 896 of file Environment.C.

References QUESO::CheckFilePath(), displayVerbosity(), QUESO::FilePtrSetStruct::h5Var, QUESO::FilePtrSetStruct::ifsVar, m_subDisplayFile, subDisplayFile(), and subRank().

Referenced by QUESO::GslVector::subReadContents(), QUESO::TeuchosVector::subReadContents(), QUESO::TeuchosMatrix::subReadContents(), and QUESO::GslMatrix::subReadContents().

 {
   std::string fileType(inputFileType);
 #ifdef QUESO_HAS_HDF5
   // Do nothing
 #else
   if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
     if (m_subDisplayFile) {
       *this->subDisplayFile() << "WARNING in BaseEnvironment::openInputFile()"
                               << ": file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                               << "' has been requested, but this QUESO library has not been built with 'hdf5'"
                               << ". Code will therefore process the file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                               << "' instead..."
                               << std::endl;
     }
     if (this->subRank() == 0) {
       std::cerr << "WARNING in BaseEnvironment::openInputFile()"
                 << ": file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                 << "' has been requested, but this QUESO library has not been built with 'hdf5'"
                 << ". Code will therefore process the file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                 << "' instead..."
                 << std::endl;
     }
     fileType = UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT;
   }
 #endif
 
   bool returnValue = true;
   filePtrSet.ifsVar = NULL;
   if ((baseFileName                         == UQ_ENV_FILENAME_FOR_NO_INPUT_FILE) ||
       (allowedSubEnvIds.find(this->subId()) == allowedSubEnvIds.end()           )) {
     if ((m_subDisplayFile) && (this->displayVerbosity() >= 10)) {
       *this->subDisplayFile() << "In BaseEnvironment::openInputFile()"
                               << ": no input file opened with base name '" << baseFileName << "." << fileType
                               << "'"
                               << std::endl;
     }
     returnValue = false;
   }
   else {
     // Open file
     if ((m_subDisplayFile) && (this->displayVerbosity() >= 10)) {
       *this->subDisplayFile() << "In BaseEnvironment::openInputFile()"
                               << ": opening input file with base name '" << baseFileName << "." << fileType
                               << "'"
                               << std::endl;
     }
     if (this->subRank() == 0) {
       // Verify parent directory exists (for cases when a user
       // specifies a relative path for the desired output file). prudenci 2010/06/26
       // std::cout << "checking " << baseFileName+"."+fileType << std::endl;
       int irtrn = CheckFilePath((baseFileName+"."+fileType).c_str());
       queso_require_greater_equal_msg(irtrn, 0, "unable to verify input path");
 
       if ((fileType == UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT) ||
           (fileType == UQ_FILE_EXTENSION_FOR_TXT_FORMAT)) {
         filePtrSet.ifsVar = new std::ifstream((baseFileName+"."+fileType).c_str(),
                                               std::ofstream::in);
         if ((filePtrSet.ifsVar == NULL) || (filePtrSet.ifsVar->is_open() == false)) {
           std::cerr << "In BaseEnvironment::openInputFile()"
                     << ": failed to open input file with base name '" << baseFileName << "." << fileType
                     << "'"
                     << std::endl;
         }
         queso_require_msg(!((filePtrSet.ifsVar == NULL) || (filePtrSet.ifsVar->is_open() == false)), "file with fileName could not be found");
       }
 #ifdef QUESO_HAS_HDF5
       else if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
         filePtrSet.h5Var = H5Fopen((baseFileName+"."+fileType).c_str(),
                                    H5F_ACC_RDONLY,
                                    H5P_DEFAULT);
       }
 #endif
       else {
         queso_error_msg("invalid file type");
       }
     }
     else {
       returnValue = false;
     }
     //this->subComm().Barrier(); // prudenci-2011-01-17
   }
 
   return returnValue;
 }

bool QUESO::BaseEnvironment::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.

Definition at line 521 of file Environment.C.

References QUESO::CheckFilePath(), displayVerbosity(), QUESO::FilePtrSetStruct::h5Var, m_subDisplayFile, QUESO::FilePtrSetStruct::ofsVar, subDisplayFile(), subId(), subIdString(), and subRank().

Referenced by QUESO::GslVector::subWriteContents(), QUESO::TeuchosVector::subWriteContents(), QUESO::TeuchosMatrix::subWriteContents(), and QUESO::GslMatrix::subWriteContents().

 {
   std::string fileType(inputFileType);
 #ifdef QUESO_HAS_HDF5
   // Do nothing
 #else
   if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
     if (m_subDisplayFile) {
       *this->subDisplayFile() << "WARNING in BaseEnvironment::openOutputFile()"
                               << ": file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                               << "' has been requested, but this QUESO library has not been built with 'hdf5'"
                               << ". Code will therefore process the file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                               << "' instead..."
                               << std::endl;
     }
     if (this->subRank() == 0) {
       std::cerr << "WARNING in BaseEnvironment::openOutputFile()"
                 << ": file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                 << "' has been requested, but this QUESO library has not been built with 'hdf5'"
                 << ". Code will therefore process the file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                 << "' instead..."
                 << std::endl;
     }
     fileType = UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT;
   }
 #endif
 
   bool returnValue = true;
   filePtrSet.ofsVar = NULL;
   if ((baseFileName                         == UQ_ENV_FILENAME_FOR_NO_OUTPUT_FILE) ||
       (allowedSubEnvIds.find(this->subId()) == allowedSubEnvIds.end()            )) {
     if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
       *this->subDisplayFile() << "In BaseEnvironment::openOutputFile()"
                               << ", subId = "     << this->subId()
                               << ": no output file opened with base name '" << baseFileName << "." << fileType
                               << "'"
                               << ", writeOver = " << writeOver
                               << std::endl;
     }
     returnValue = false;
   }
   else {
     // Open file
     if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
       *this->subDisplayFile() << "In BaseEnvironment::openOutputFile()"
                               << ", subId = "     << this->subId()
                               << ": opening output file with base name '" << baseFileName << "." << fileType
                               << "'"
                               << ", writeOver = " << writeOver
                               << std::endl;
     }
 
     if (this->subRank() == 0) {
 #if 0
       std::cout << "In BaseEnvironment::openOutputFile()"
                 << ": opening output file with base name '" << baseFileName << "." << fileType
                 << "'"
                 << ", writeOver = " << writeOver
                 << std::endl;
 #endif
 
       // Verify parent directory exists (for cases when a user
       // specifies a relative path for the desired output file).
       // std::cout << "checking " << baseFileName+"_sub"+this->subIdString()+"."+fileType << std::endl;
       if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
         *this->subDisplayFile() << "In BaseEnvironment::openOutputFile()"
                                 << ", subId = "     << this->subId()
                                 << ", trying to open output file with base name '" << baseFileName << "." << fileType
                                 << "'"
                                 << ", writeOver = " << writeOver
                                 << ": calling CheckFilePath()..."
                                 << std::endl;
       }
       int irtrn = CheckFilePath((baseFileName+"_sub"+this->subIdString()+"."+fileType).c_str());
       if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
         *this->subDisplayFile() << "In BaseEnvironment::openOutputFile()"
                                 << ", subId = "     << this->subId()
                                 << ", trying to open output file with base name '" << baseFileName << "." << fileType
                                 << "'"
                                 << ", writeOver = " << writeOver
                                 << ": returned from CheckFilePath() with irtrn = " << irtrn
                                 << std::endl;
       }
       queso_require_greater_equal_msg(irtrn, 0, "unable to verify output path");
 
       if (writeOver) {
         // Write over an eventual pre-existing file
         if ((fileType == UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT) ||
             (fileType == UQ_FILE_EXTENSION_FOR_TXT_FORMAT)) {
           filePtrSet.ofsVar = new std::ofstream((baseFileName+"_sub"+this->subIdString()+"."+fileType).c_str(),
                                                 std::ofstream::out | std::ofstream::trunc);
         }
         else if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
           queso_error_msg("hdf file type not supported yet");
         }
         else {
           queso_error_msg("invalid file type");
         }
         if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
           *this->subDisplayFile() << "In BaseEnvironment::openOutputFile()"
                                   << ": just opened output file with base name '" << baseFileName << "." << fileType
                                   << "'"
                                   << ", writeOver = " << writeOver
                                   << ", options 'out|trunc'"
                                   << ", osfvar = " << filePtrSet.ofsVar
                                   << std::endl;
         }
       }
       else {
         // Write at the end of an eventual pre-existing file
         if ((fileType == UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT) ||
             (fileType == UQ_FILE_EXTENSION_FOR_TXT_FORMAT)) {
 #if 0
           filePtrSet.ofsVar = new std::ofstream((baseFileName+"_sub"+this->subIdString()+"."+fileType).c_str(),
                                                 std::ofstream::in);
           std::cout << "filePtrSet.ofsVar(1) = " << filePtrSet.ofsVar << std::endl;
           if (filePtrSet.ofsVar) std::cout << "filePtrSet.ofsVar(1)->is_open() = " << filePtrSet.ofsVar->is_open() << std::endl;
           if (filePtrSet.ofsVar) delete filePtrSet.ofsVar;
 #endif
           // 'm' and Ranger nodes behave differently on ofstream constructor... prudenci 2010/03/05
           filePtrSet.ofsVar = new std::ofstream((baseFileName+"_sub"+this->subIdString()+"."+fileType).c_str(),
                                                 std::ofstream::out /*| std::ofstream::in*/ | std::ofstream::app);
         }
 #ifdef QUESO_HAS_HDF5
         else if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
           std::string fullFileName =
             baseFileName+"_sub"+this->subIdString()+"."+fileType;
 
           // Use H5F_ACC_EXCL because not overwriting, so fail on existing file
           filePtrSet.h5Var = H5Fcreate(fullFileName.c_str(),
                                        H5F_ACC_EXCL,
                                        H5P_DEFAULT,
                                        H5P_DEFAULT);
 
           queso_require_greater_equal_msg(
               filePtrSet.h5Var, 0,
               "error opening file `" << fullFileName << "`");
         }
 #endif
         else {
           queso_error_msg("invalid file type");
         }
         if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
           *this->subDisplayFile() << "In BaseEnvironment::openOutputFile()"
                                   << ": just opened output file with base name '" << baseFileName << "." << fileType
                                   << "'"
                                   << ", writeOver = " << writeOver
                                   << ", options 'out|in|app'"
                                   << ", osfvar = " << filePtrSet.ofsVar
                                   << std::endl;
         }
 
         if (fileType == UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT) {
           //std::cout << "filePtrSet.ofsVar(2) = " << filePtrSet.ofsVar << std::endl;
           //if (filePtrSet.ofsVar) std::cout << "filePtrSet.ofsVar(2)->is_open() = " << filePtrSet.ofsVar->is_open() << std::endl;
           if ((filePtrSet.ofsVar            == NULL ) ||
               (filePtrSet.ofsVar->is_open() == false)) {
             //std::cout << "Retrying 1..." << std::endl;
             delete filePtrSet.ofsVar;
             filePtrSet.ofsVar = new std::ofstream((baseFileName+"_sub"+this->subIdString()+"."+fileType).c_str(),
                                                   std::ofstream::out | std::ofstream::trunc);
             if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
               *this->subDisplayFile() << "In BaseEnvironment::openOutputFile()"
                                       << ": just opened output file with base name '" << baseFileName << "." << fileType
                                       << "'"
                                       << ", writeOver = " << writeOver
                                       << ", options 'out|trunc'"
                                       << ", osfvar = " << filePtrSet.ofsVar
                                       << std::endl;
             }
           }
         } // only for matlab formats
       }
 
       // Check the file actually opened
       if ((fileType == UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT) ||
           (fileType == UQ_FILE_EXTENSION_FOR_TXT_FORMAT)) {
         queso_require_msg(
             (filePtrSet.ofsVar && filePtrSet.ofsVar->is_open()),
             "failed to open output file");
       }
     }
     else {
       returnValue = false;
     }
     //this->subComm().Barrier(); // prudenci-2011-01-17
   }
 
   return returnValue;
 }

bool QUESO::BaseEnvironment::openUnifiedInputFile	(	const std::string &	fileName,
		const std::string &	fileType,
		FilePtrSetStruct &	filePtrSet
	)		const

Opens the unified input file.

Definition at line 991 of file Environment.C.

References QUESO::CheckFilePath(), displayVerbosity(), QUESO::FilePtrSetStruct::h5Var, QUESO::FilePtrSetStruct::ifsVar, m_subDisplayFile, subDisplayFile(), and subRank().

 {
   std::string fileType(inputFileType);
 #ifdef QUESO_HAS_HDF5
   // Do nothing
 #else
   if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
     if (m_subDisplayFile) {
       *this->subDisplayFile() << "WARNING in BaseEnvironment::openUnifiedInputFile()"
                               << ": file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                               << "' has been requested, but this QUESO library has not been built with 'hdf5'"
                               << ". Code will therefore process the file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                               << "' instead..."
                               << std::endl;
     }
     if (this->subRank() == 0) {
       std::cerr << "WARNING in BaseEnvironment::openUnifiedInputFile()"
                 << ": file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                 << "' has been requested, but this QUESO library has not been built with 'hdf5'"
                 << ". Code will therefore process the file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                 << "' instead..."
                 << std::endl;
     }
     fileType = UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT;
   }
 #endif
 
   bool returnValue = true;
   filePtrSet.ifsVar = NULL;
   if (baseFileName == UQ_ENV_FILENAME_FOR_NO_INPUT_FILE) {
     if ((m_subDisplayFile) && (this->displayVerbosity() >= 10)) {
       *this->subDisplayFile() << "In BaseEnvironment::openUnifiedInputFile()"
                               << ": no input file opened with base name '" << baseFileName << "." << fileType
                               << "'"
                               << std::endl;
     }
     returnValue = false;
   }
   else {
     // Open file
     if ((m_subDisplayFile) && (this->displayVerbosity() >= 10)) {
       *this->subDisplayFile() << "In BaseEnvironment::openUnifiedInputFile()"
                               << ": opening input file with base name '" << baseFileName << "." << fileType
                               << "'"
                               << std::endl;
     }
     if (this->subRank() == 0) { // Needed ???????? prudenci 2010-11-11
       // Verify parent directory exists (for cases when a user
       // specifies a relative path for the desired output file). prudenci 2010/06/26
       // std::cout << "checking " << baseFileName+"."+fileType << std::endl;
       int irtrn = CheckFilePath((baseFileName+"."+fileType).c_str());
       queso_require_greater_equal_msg(irtrn, 0, "unable to verify input path");
 
       if ((fileType == UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT) ||
           (fileType == UQ_FILE_EXTENSION_FOR_TXT_FORMAT)) {
         filePtrSet.ifsVar = new std::ifstream((baseFileName+"."+fileType).c_str(),
                                               std::ofstream::in);
         if ((filePtrSet.ifsVar == NULL) || (filePtrSet.ifsVar->is_open() == false)) {
           std::cerr << "In BaseEnvironment::openUnifiedInputFile()"
                     << ": failed to open input file with base name '" << baseFileName << "." << fileType
                     << "'"
                     << std::endl;
         }
         queso_require_msg(!((filePtrSet.ifsVar == NULL) || (filePtrSet.ifsVar->is_open() == false)), "file with fileName could not be found");
       }
 #ifdef QUESO_HAS_HDF5
       else if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
         filePtrSet.h5Var = H5Fopen((baseFileName+"."+fileType).c_str(),
                                    H5F_ACC_RDONLY,
                                    H5P_DEFAULT);
       }
 #endif
       else {
         queso_error_msg("invalid file type");
       }
     }
     //else {
     //  returnValue = false;
     //}
     //this->subComm().Barrier();
   }
 
   return returnValue;
 }

bool QUESO::BaseEnvironment::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.

Definition at line 726 of file Environment.C.

References QUESO::CheckFilePath(), displayVerbosity(), QUESO::FilePtrSetStruct::h5Var, m_subDisplayFile, QUESO::FilePtrSetStruct::ofsVar, subDisplayFile(), and subRank().

 {
   std::string fileType(inputFileType);
 #ifdef QUESO_HAS_HDF5
   // Do nothing
 #else
   if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
     if (m_subDisplayFile) {
       *this->subDisplayFile() << "WARNING in BaseEnvironment::openUnifiedOutputFile()"
                               << ": file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                               << "' has been requested, but this QUESO library has not been built with 'hdf5'"
                               << ". Code will therefore process the file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                               << "' instead..."
                               << std::endl;
     }
     if (this->subRank() == 0) {
       std::cerr << "WARNING in BaseEnvironment::openUnifiedOutputFile()"
                 << ": file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                 << "' has been requested, but this QUESO library has not been built with 'hdf5'"
                 << ". Code will therefore process the file format '" << UQ_FILE_EXTENSION_FOR_HDF_FORMAT
                 << "' instead..."
                 << std::endl;
     }
     fileType = UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT;
   }
 #endif
 
   bool returnValue = true;
   filePtrSet.ofsVar = NULL;
   if (baseFileName == ".") {
     if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
       *this->subDisplayFile() << "In BaseEnvironment::openUnifiedOutputFile()"
                               << ": no unified output file opened with base name '" << baseFileName << "." << fileType
                               << "'"
                               << ", writeOver = " << writeOver
                               << std::endl;
     }
     returnValue = false;
   }
   else {
     // Open file
     if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
       *this->subDisplayFile() << "In BaseEnvironment::openUnifiedOutputFile()"
                               << ": opening unified output file with base name '" << baseFileName << "." << fileType
                               << "'"
                               << ", writeOver = " << writeOver
                               << std::endl;
     }
 
 
     //if ((this->subRank   () == 0) &&
     //    (this->inter0Rank() == 0)) {
 #if 0
       std::cout << "In BaseEnvironment::openUnifiedOutputFile()"
                 << ": opening output file with base name '" << baseFileName << "." << fileType
                 << "'"
                 << ", writeOver = " << writeOver
                 << std::endl;
 #endif
       // Verify parent directory exists (for cases when a user
       // specifies a relative path for the desired output file). prudenci 2010/06/26
       // std::cout << "checking " << baseFileName+"."+fileType << std::endl;
       int irtrn = CheckFilePath((baseFileName+"."+fileType).c_str());
       queso_require_greater_equal_msg(irtrn, 0, "unable to verify output path");
 
       if (writeOver) {
         // Write over an eventual pre-existing file
         if ((fileType == UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT) ||
             (fileType == UQ_FILE_EXTENSION_FOR_TXT_FORMAT)) {
           filePtrSet.ofsVar = new std::ofstream((baseFileName+"."+fileType).c_str(),
                                                 std::ofstream::out | std::ofstream::trunc);
         }
 #ifdef QUESO_HAS_HDF5
         else if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
           filePtrSet.h5Var = H5Fcreate((baseFileName+"."+fileType).c_str(),
                                        H5F_ACC_TRUNC,
                                        H5P_DEFAULT,
                                        H5P_DEFAULT);
         }
 #endif
         else {
           queso_error_msg("invalid file type");
         }
         if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
           *this->subDisplayFile() << "In BaseEnvironment::openUnifiedOutputFile()"
                                   << ": just opened output file with base name '" << baseFileName << "." << fileType
                                   << "'"
                                   << ", writeOver = " << writeOver
                                   << ", options 'out|trunc'"
                                   << ", osfvar = " << filePtrSet.ofsVar
                                   << std::endl;
         }
       }
       else {
         // Write at the end of an eventual pre-existing file
         // 'm' and Ranger nodes behave differently on ofstream constructor... prudenci 2010/03/05
         if ((fileType == UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT) ||
             (fileType == UQ_FILE_EXTENSION_FOR_TXT_FORMAT)) {
           filePtrSet.ofsVar = new std::ofstream((baseFileName+"."+fileType).c_str(),
                                                 std::ofstream::out /*| std::ofstream::in*/ | std::ofstream::app);
         }
 #ifdef QUESO_HAS_HDF5
         else if (fileType == UQ_FILE_EXTENSION_FOR_HDF_FORMAT) {
           filePtrSet.h5Var = H5Fcreate((baseFileName+"."+fileType).c_str(), // TEMPORARY - FIX ME
                                        H5F_ACC_TRUNC,
                                        H5P_DEFAULT,
                                        H5P_DEFAULT);
 
           //                    m_worldRank,
           //                    "BaseEnvironment::openUnifiedOutputFile(), writeOver=false",
           //                    "hdf file type not supported yet");
         }
 #endif
         else {
           queso_error_msg("invalid file type");
         }
         if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
           *this->subDisplayFile() << "In BaseEnvironment::openUnifiedOutputFile()"
                                   << ": just opened output file with base name '" << baseFileName << "." << fileType
                                   << "'"
                                   << ", writeOver = " << writeOver
                                   << ", options 'out|in|app'"
                                   << ", osfvar = " << filePtrSet.ofsVar
                                   << std::endl;
         }
         if ((filePtrSet.ofsVar            == NULL ) ||
             (filePtrSet.ofsVar->is_open() == false)) {
 #if 0
           std::cout << "Retrying 2..." << std::endl;
 #endif
           delete filePtrSet.ofsVar;
           filePtrSet.ofsVar = new std::ofstream((baseFileName+"."+fileType).c_str(),
                                                 std::ofstream::out | std::ofstream::trunc);
           if ((m_subDisplayFile) && (this->displayVerbosity() > 10)) { // output debug
             *this->subDisplayFile() << "In BaseEnvironment::openUnifiedOutputFile()"
                                     << ": just opened output file with base name '" << baseFileName << "." << fileType
                                     << "'"
                                     << ", writeOver = " << writeOver
                                     << ", options 'out|trunc'"
                                     << ", osfvar = " << filePtrSet.ofsVar
                                     << std::endl;
           }
         }
       }
       if (filePtrSet.ofsVar == NULL) {
         std::cerr << "In BaseEnvironment::openUnifiedOutputFile()"
                   << ": failed to open unified output file with base name '" << baseFileName << "." << fileType
                   << "'"
                   << std::endl;
       }
       queso_require_msg((filePtrSet.ofsVar && filePtrSet.ofsVar->is_open()), "failed to open output file");
     //}
   }
 
   return returnValue;
 }

std::string QUESO::BaseEnvironment::optionsInputFileName ( ) const

Access to the attribute m_optionsInputFileName, which stores the name of the input file passed by the user to QUESO.

Definition at line 354 of file Environment.C.

References m_optionsInputFileAccessState, and m_optionsInputFileName.

Referenced by QUESO::EnvironmentOptions::EnvironmentOptions(), QUESO::GPMSAFactory< V, M >::GPMSAFactory(), QUESO::InfiniteDimensionalMCMCSampler::InfiniteDimensionalMCMCSampler(), QUESO::InfiniteDimensionalMCMCSamplerOptions::InfiniteDimensionalMCMCSamplerOptions(), QUESO::MetropolisHastingsSGOptions::MetropolisHastingsSGOptions(), QUESO::GPMSAOptions::parse(), QUESO::MLSamplingLevelOptions::scanOptionsValues(), QUESO::StatisticalInverseProblem< P_V, P_M >::StatisticalInverseProblem(), and QUESO::StatisticalInverseProblemOptions::StatisticalInverseProblemOptions().

 {
   if (m_optionsInputFileAccessState) {
     return m_optionsInputFileName;
   }
   else {
     return "";
   }
 }

std::string QUESO::BaseEnvironment::platformName ( ) const

Access to the platform name.

Definition at line 496 of file Environment.C.

References m_optionsObj.

 {
   return m_optionsObj->m_platformName;
 }

virtual void QUESO::BaseEnvironment::print ( std::ostream & os ) const

pure virtual

Implemented in QUESO::FullEnvironment, and QUESO::EmptyEnvironment.

void QUESO::BaseEnvironment::resetIdentifyingString ( const std::string & newString )

Reset private attribute m_identifyingString with the value newString.

Definition at line 508 of file Environment.C.

References m_optionsObj.

 {
   m_optionsObj->m_identifyingString = newString;
   return;
 }

void QUESO::BaseEnvironment::resetSeed ( int newSeedOption )

Reset RNG seed.

Definition at line 483 of file Environment.C.

References m_rngObject.

 {
   m_rngObject->resetSeed(newSeedOption);
   return;
 }

const RngBase * QUESO::BaseEnvironment::rngObject ( ) const

Access to the RNG object.

Definition at line 471 of file Environment.C.

References m_rngObject.

Referenced by QUESO::InfiniteDimensionalMCMCSampler::_metropolis_hastings(), QUESO::GslVector::cwSetBeta(), QUESO::TeuchosVector::cwSetBeta(), QUESO::GslVector::cwSetGamma(), QUESO::TeuchosVector::cwSetGamma(), QUESO::GslVector::cwSetGaussian(), QUESO::TeuchosVector::cwSetGaussian(), QUESO::GslVector::cwSetInverseGamma(), QUESO::TeuchosVector::cwSetInverseGamma(), QUESO::GslVector::cwSetUniform(), QUESO::TeuchosVector::cwSetUniform(), QUESO::InfiniteDimensionalGaussian::draw(), and QUESO::FiniteDistribution::sample().

 {
   return m_rngObject.get();
 }

void QUESO::BaseEnvironment::scanInputFileForMyOptions ( const boost::program_options::options_description & optionsDesc ) const

This method scans the input file provided by the user to QUESO.

It checks if no input file is passed and updates the private attribute m_allOptionsDesc, which keeps all the options.

Definition at line 397 of file Environment.C.

References m_allOptionsDesc, m_allOptionsMap, m_optionsInputFileName, and QUESO::queso_require_not_equal_to_msg.

Referenced by QUESO::StatisticalInverseProblemOptions::scanOptionsValues(), QUESO::EnvironmentOptions::scanOptionsValues(), and QUESO::MetropolisHastingsSGOptions::scanOptionsValues().

 {
   queso_deprecated();
 
 #ifdef UQ_USES_COMMAND_LINE_OPTIONS
   // If you want to use command line options, the following line does *not* work outside 'main.C',
   // e.g., in the constructor of FullEnvironment:
   // Line: boost::program_options::store(boost::program_options::parse_command_line(argc, argv, *m_allOptionsDesc), *m_allOptionsMap);
   //
   // Instead, put the following three lines *immediately after* instantianting the UQ environment
   // variable "FullEnvironment* env":
   // Line 1: boost::program_options::store(boost::program_options::parse_command_line(argc, argv, env->allOptionsDesc()), env->allOptionsMap());
   // Line 2: boost::program_options::notify(env->allOptionsMap());
   // Line 3: env->getMyOptionValues();
 #endif
 
 #ifdef QUESO_MEMORY_DEBUGGING
   std::cout << "Entering BaseEnv::scanInputFileForMyOptions()" << std::endl;
 #endif
 
   queso_require_msg(m_allOptionsDesc, "m_allOptionsDesc variable is NULL");
   m_allOptionsDesc->add(optionsDesc);
   //if (m_subDisplayFile) {
   //  *m_subDisplayFile << *m_allOptionsDesc
   //                    << std::endl;
   //}
 
   queso_require_not_equal_to_msg(m_optionsInputFileName, std::string(""),
                                  std::string("m_optionsInputFileName is 'nothing'"));
   //std::ifstream ifs(m_optionsInputFileName.c_str());
   std::ifstream* ifs = new std::ifstream(m_optionsInputFileName.c_str());
 #ifdef QUESO_MEMORY_DEBUGGING
   std::cout << "in BaseEnv::scanInputFileForMyOptions(), before store(a)" << std::endl;
 #endif
 
   queso_require_msg(m_allOptionsMap, "m_allOptionsMap variable is NULL");
   boost::program_options::store(boost::program_options::parse_config_file(*ifs, *m_allOptionsDesc, true), *m_allOptionsMap);
 #ifdef QUESO_MEMORY_DEBUGGING
   std::cout << "in BaseEnv::scanInputFileForMyOptions(), after store(a)" << std::endl;
 #endif
   boost::program_options::notify(*m_allOptionsMap);
 
   //ifs.close();
   delete ifs;
 #ifdef QUESO_MEMORY_DEBUGGING
   std::cout << "Leaving BaseEnv::scanInputFileForMyOptions()" << std::endl;
 #endif
 
   return;
 }

int QUESO::BaseEnvironment::seed ( ) const

Access to the RNG seed.

Definition at line 477 of file Environment.C.

References m_rngObject.

 {
   return m_rngObject->seed();
 }

const MpiComm & QUESO::BaseEnvironment::selfComm ( ) const

Access function for MpiComm self-communicator.

This communicator is exactly MPI_COMM_SELF.

Definition at line 300 of file Environment.C.

References m_selfComm.

 {
   queso_require_msg(m_selfComm, "m_selfComm variable is NULL");
   return *m_selfComm;
 }

void QUESO::BaseEnvironment::setExceptionalCircumstance ( bool value ) const

Set an exceptional circumstance.

Definition at line 1136 of file Environment.C.

References m_exceptionalCircumstance.

 {
   m_exceptionalCircumstance = value;
   return;
 }

void QUESO::BaseEnvironment::setOptionsInputFileAccessState ( bool newState ) const

Definition at line 365 of file Environment.C.

References m_optionsInputFileAccessState.

 {
   m_optionsInputFileAccessState = newState;
 
   return;
 }

const MpiComm & QUESO::BaseEnvironment::subComm ( ) const

Access function for each sub-environment's communicator.

Let's say QUESO was passed a fullComm() communicator of size N. The ranks of each process in this communicator are:

0 1 2 ... N-2 N-1

If the user asks for M sub-environments (chains) then, assuming M divides N, QUESO partitions the processes in the fullComm() communicator into M sub-communicators like so:

Sub-environment 0 contains processes with fullRank() 0 1 ... M-1

Sub-environment 1 contains processes with fullRank() M M+1 ... 2M-1

et cetera

Sub-environment M-1 contains processes with fullRank() N-M N-M+1 ... N-1

subComm() returns the sub-communicator corresponding to the sub-environment the calling MPI process belongs to. For example, if I am an MPI process calling this function and I live in sub-environment k, then this method returns the sub-communicator for sub-environment k.

Definition at line 293 of file Environment.C.

References m_subComm.

Referenced by QUESO::VectorFunctionSynchronizer< P_V, P_M, Q_V, Q_M >::callFunction(), and QUESO::MiscCheckTheParallelEnvironment().

 {
   queso_require_msg(m_subComm, "m_subComm variable is NULL");
   return *m_subComm;
 }

std::ofstream * QUESO::BaseEnvironment::subDisplayFile ( ) const

Access function for m_subDisplayFile (displays file on stream).

Definition at line 320 of file Environment.C.

References m_subDisplayFile.

 {
   // Potentially dangerous?  The user might delete it...
   return m_subDisplayFile.get();
 }

std::string QUESO::BaseEnvironment::subDisplayFileName ( ) const

Access function for m_subDisplayFileName (displays filename on stream).

Definition at line 327 of file Environment.C.

References m_optionsObj.

 {
   if (m_optionsObj == NULL) return ".";
 
   return m_optionsObj->m_subDisplayFileName;
 }

RawType_MPI_Group QUESO::BaseEnvironment::subGroup ( ) const

Access function for sub-group.

Definition at line 281 of file Environment.C.

References m_subGroup.

 {
   return m_subGroup;
 }

unsigned int QUESO::BaseEnvironment::subId ( ) const

Access function to the number of each sub-environment Id: m_subId.

Definition at line 342 of file Environment.C.

References m_subId.

Referenced by QUESO::MLSamplingLevelOptions::checkOptions(), QUESO::MhOptionsValues::checkOptions(), QUESO::MetropolisHastingsSGOptions::getMyOptionValues(), openOutputFile(), and QUESO::MpiComm::syncPrintDebugMsg().

 {
   return m_subId;
 }

const std::string & QUESO::BaseEnvironment::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.

Definition at line 348 of file Environment.C.

References m_subIdString.

Referenced by openOutputFile(), QUESO::Sampled1D1DFunction::printForMatlab(), QUESO::GslVector::subWriteContents(), QUESO::TeuchosVector::subWriteContents(), QUESO::TeuchosMatrix::subWriteContents(), and QUESO::GslMatrix::subWriteContents().

 {
   return m_subIdString;
 }

int QUESO::BaseEnvironment::subRank ( ) const

Returns the rank of the MPI process in the sub-communicator subComm()

Example, if the calling MPI process has fullRank() equal to 3, the size of fullComm() is 6, and the user asked for two sub-environments, then this method will return 0. Here's why.

fullComm() has MPI processes with these ranks: 0 1 2 3 4 5

QUESO divides the first three (ranks 0, 1, 2) of these into a sub-communicator for sub-environment 0. Inside the sub-communicator their ranks are 0, 1, 2, respectively.

QUESO divides the second three (ranks 3, 4, 5) of these into a sub-communicator for sub-environment 1. Inside the sub-communicator their ranks are 0, 1, 2, respectively.

It should be clear, now, that if fullRank() is 3 then subRank() is 0.

Definition at line 287 of file Environment.C.

References m_subRank.

Referenced by closeFile(), QUESO::MetropolisHastingsSGOptions::getMyOptionValues(), QUESO::MiscCheckTheParallelEnvironment(), openInputFile(), openOutputFile(), openUnifiedInputFile(), openUnifiedOutputFile(), QUESO::GslVector::subReadContents(), QUESO::TeuchosVector::subReadContents(), QUESO::TeuchosMatrix::subReadContents(), QUESO::GslMatrix::subReadContents(), QUESO::GslVector::subWriteContents(), QUESO::TeuchosVector::subWriteContents(), QUESO::TeuchosMatrix::subWriteContents(), QUESO::GslMatrix::subWriteContents(), and QUESO::MpiComm::syncPrintDebugMsg().

 {
   return m_subRank;
 }

unsigned int QUESO::BaseEnvironment::syncVerbosity ( ) const

Access function to private attribute m_syncVerbosity.

Definition at line 457 of file Environment.C.

References m_optionsObj.

Referenced by QUESO::MpiComm::syncPrintDebugMsg().

 {
   queso_require_msg(m_optionsObj, "m_optionsObj variable is NULL");
   return m_optionsObj->m_syncVerbosity;
 }

struct timeval QUESO::BaseEnvironment::timevalBegin ( ) const

Used to save the time when the combo `QUESO+user's application' started to run.

Definition at line 515 of file Environment.C.

 {
   return m_timevalBegin;
 }

int QUESO::BaseEnvironment::worldRank ( ) const

Returns the same thing as fullRank()

This is the same thing as fullRank(), since QUESO's 'world' communicator is not MPI_COMM_WORLD, but the communicator that user passed to it when creating the environment.

Definition at line 262 of file Environment.C.

References m_worldRank.

Referenced by QUESO::MetropolisHastingsSG< P_V, P_M >::alpha(), QUESO::TeuchosMatrix::chol(), QUESO::GslMatrix::chol(), QUESO::ComputeCovCorrMatricesBetweenVectorSequences(), QUESO::MetropolisHastingsSGOptions::getMyOptionValues(), QUESO::GslMatrix::internalSvd(), and QUESO::ScalarSequence< T >::subInterQuantileRange().