Environment.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// QUESO - a library to support the Quantification of Uncertainty
// for Estimation, Simulation and Optimization
//
// Copyright (C) 2008-2017 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

#ifndef UQ_ENVIRONMENT_H
#define UQ_ENVIRONMENT_H

#include <queso/Defines.h>
#undef UQ_USES_COMMAND_LINE_OPTIONS

#include <queso/MpiComm.h>
#include <queso/ScopedPtr.h>

#ifdef QUESO_HAS_HDF5
#include <hdf5.h>
#endif
#include <iostream>
#include <fstream>


#ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
// Forward declarations
namespace boost {
  namespace program_options {
    class options_description;
    class variables_map;
    }
}
#endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS

namespace QUESO {

// Forward declarations
class GetPot;
class EnvironmentOptions;
class EnvOptionsValues;
class BasicPdfsBase;
class RngBase;


  void queso_terminate_handler();

struct FilePtrSetStruct {

  FilePtrSetStruct();

  ~FilePtrSetStruct();

  std::ofstream* ofsVar;

  std::ifstream* ifsVar;
#ifdef QUESO_HAS_HDF5
  hid_t  h5Var;
#endif
};

//------------------------------------------------------------------------
// Library versioning routines: we include them in a QUESO namespace
// here so that multiple classes can use them as required (and so we
// can have a standalone versioning binary which does not require a full
// QUESO MPI environment.
//------------------------------------------------------------------------

  void QUESO_version_print       (std::ostream &os);
  int  QUESO_get_numeric_version ();

//*****************************************************
// Base class
//*****************************************************
class BaseEnvironment {
public:

  BaseEnvironment(const char* passedOptionsInputFileName, EnvOptionsValues* alternativeOptionsValues);

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


  virtual ~BaseEnvironment();


  bool    fullEnvIsReady() const;


  int     worldRank     () const;


  int     fullRank      () const;


  const MpiComm&   fullComm      () const;

  RawType_MPI_Group     subGroup      () const;


  int     subRank       () const;


  const MpiComm&   subComm       () const;


  const MpiComm&   selfComm      () const;

  int     inter0Rank    () const;

  /*
   * This communicator contains all the processes that have subRank() equal to
   * 0.
   *
   * Their corresponding fullRank() values will be 0, M, 2M, ..., N-M,
   * where M is the number of sub-environments the user asked for and N is the
   * size of fullComm().
   */
  const MpiComm&   inter0Comm    () const;

  std::ofstream*  subDisplayFile() const;

  std::string     subDisplayFileName    () const;

  unsigned int    numSubEnvironments    () const;

  unsigned int    subId () const;

  const std::string&      subIdString   () const;

  //TODO Not implemented?
  void    checkTheParallelEnvironment   () const;

  std::string     optionsInputFileName  () const;

  void    setOptionsInputFileAccessState(bool newState) const; // Yes, 'const'


#ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
#ifdef UQ_USES_COMMAND_LINE_OPTIONS
  const boost::program_options::options_description& allOptionsDesc () const;
#endif
#endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS

#ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
  boost::program_options::variables_map&      allOptionsMap () const;
#endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS


#ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS

  void    scanInputFileForMyOptions(const boost::program_options::options_description& optionsDesc) const;
#endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS

  unsigned int    displayVerbosity () const;

  unsigned int    syncVerbosity    () const;

  unsigned int    checkingLevel    () const;

  const RngBase* rngObject  () const;

  void                  resetSeed  (int newSeedOption);

  int                   seed       () const;

  const BasicPdfsBase* basicPdfs() const;

  std::string platformName      () const;

  std::string identifyingString () const;

  void    resetIdentifyingString(const std::string& newString);

  bool    isThereInputFile      () const;

  struct timeval  timevalBegin  () const;



  bool    openOutputFile(const std::string& fileName, const std::string& fileType,
                         const std::set<unsigned int>& allowedSubEnvIds, bool writeOver,
                         FilePtrSetStruct& filePtrSet) const;

  bool    openUnifiedOutputFile (const std::string& fileName, const std::string& fileType,
                                 bool writeOver, FilePtrSetStruct& filePtrSet) const;

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

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

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

  void    setExceptionalCircumstance    (bool value) const;

  bool    exceptionalCircumstance       () const;

  const GetPot & input() const;


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

protected:
  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;
  mutable bool m_optionsInputFileAccessState; // Yes, 'mutable'
#ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
  ScopedPtr<boost::program_options::options_description>::Type m_allOptionsDesc;
  ScopedPtr<boost::program_options::variables_map>::Type m_allOptionsMap;
#endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
  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;

  mutable ScopedPtr<std::ofstream>::Type m_subDisplayFile;
  ScopedPtr<RngBase>::Type m_rngObject;
  ScopedPtr<BasicPdfsBase>::Type m_basicPdfs;
  struct timeval m_timevalBegin;
  mutable bool m_exceptionalCircumstance;

  ScopedPtr<EnvOptionsValues>::Type m_optionsObj;
};

//*****************************************************
// Empty Environment
//*****************************************************
class EmptyEnvironment : public BaseEnvironment {
public:


  EmptyEnvironment();

 ~EmptyEnvironment();

void print(std::ostream& os) const;
};

//*****************************************************
// Full Environment
//*****************************************************
class FullEnvironment : public BaseEnvironment {
public:


#ifdef QUESO_HAS_MPI
  FullEnvironment(RawType_MPI_Comm inputComm, const char* passedOptionsInputFileName, const char* prefix, EnvOptionsValues* alternativeOptionsValues);

  FullEnvironment(RawType_MPI_Comm inputComm,
                  const std::string& passedOptionsInputFileName,
                  const std::string& prefix,
                  EnvOptionsValues* alternativeOptionsValues);
#endif


  FullEnvironment(const char* passedOptionsInputFileName, const char* prefix, EnvOptionsValues* alternativeOptionsValues);

  FullEnvironment(const std::string& passedOptionsInputFileName,
                  const std::string& prefix,
                  EnvOptionsValues* alternativeOptionsValues);

 ~FullEnvironment();


  void        print       (std::ostream& os) const;

private:
#ifdef QUESO_HAS_MPI
  void        construct(RawType_MPI_Comm inputComm,
                  const char *prefix);
#endif

  void        construct(const char *prefix);

  void        readOptionsInputFile();
  //void        queso_terminate_handler();

};

std::ostream& operator<<(std::ostream& os, const BaseEnvironment& obj);

}  // End namespace QUESO

#endif // UQ_ENVIRONMENT_H