queso-0.53.0
Namespaces | Macros | Functions | Variables
Defines.h File Reference

Definitions and a class to provide default options to pass to a QUESO environment. More...

#include <queso/config_queso.h>
#include <queso/asserts.h>
#include <iostream>
#include <stdlib.h>
#include <set>
#include <vector>
#include <mpi.h>
Include dependency graph for Defines.h:

Go to the source code of this file.

Namespaces

 QUESO
 

Macros

#define QUESO_HAS_MPI
 This define is deprecated. Remove any #ifdef statements in user code. More...
 
#define QUESO_EXPECTS_LN_LIKELIHOOD_INSTEAD_OF_MINUS_2_LN
 This define is deprecated. Remove any #ifdef statements in user code. More...
 
#define ML_CODE_HAS_NEW_RESTART_CAPABILITY
 
#define QUESO_CLASSES_INSTANTIATE_NEW_MAPS
 
#define QUESO_USES_NEW_RNG_CLASS
 
#define UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT   "m"
 
#define UQ_FILE_EXTENSION_FOR_HDF_FORMAT   "h5"
 
#define queso_do_once(do_this)
 
#define queso_warning(message)
 
#define queso_deprecated()   queso_warning("*** Warning, this code is deprecated and likely to be removed in future library versions: ");
 
#define UQ_RC_MACRO(macroIRc, givenRank, where, what, retValue)
 
#define UQ_TEST_MACRO(test, givenRank, where, what, retValue)
 
#define UQ_FATAL_RC_MACRO(macroIRc, givenRank, where, what)
 
#define UQ_FATAL_TEST_MACRO(test, givenRank, where, what)
 

Functions

int QUESO::MyWorldfullRank ()
 Returns the rank of the calling process in the communicator. More...
 

Variables

const int QUESO::UQ_UNAVAILABLE_RANK = -1
 
const int QUESO::UQ_OK_RC = 0
 
const int QUESO::UQ_INCOMPLETE_IMPLEMENTATION_RC = -1
 
const int QUESO::UQ_INVALID_PARAMETER_SPEC_RC = -2
 
const int QUESO::UQ_INVALID_OBSERVABLE_SPEC_RC = -3
 
const int QUESO::UQ_INVALID_QOI_SPEC_RC = -4
 
const int QUESO::UQ_INVALID_INTERNAL_RESULT_RC = -5
 
const int QUESO::UQ_INVALID_INTERNAL_STATE_RC = -6
 
const int QUESO::UQ_FAILED_TO_OPEN_FILE_RC = -7
 
const int QUESO::UQ_MATRIX_IS_NOT_POS_DEFINITE_RC = -8
 
const int QUESO::UQ_FAILED_READING_FILE_RC = -9
 
const int QUESO::UQ_INVALID_SPACE_COMPONENT_ID_RC = -10
 
const int QUESO::UQ_MATRIX_SVD_FAILED_RC = -11
 

Detailed Description

Definitions and a class to provide default options to pass to a QUESO environment.

Definition in file Defines.h.

Macro Definition Documentation

#define ML_CODE_HAS_NEW_RESTART_CAPABILITY

Definition at line 65 of file Defines.h.

#define QUESO_CLASSES_INSTANTIATE_NEW_MAPS

Definition at line 69 of file Defines.h.

#define queso_deprecated ( )    queso_warning("*** Warning, this code is deprecated and likely to be removed in future library versions: ");

Definition at line 120 of file Defines.h.

Referenced by QUESO::BaseEnvironment::allOptionsMap(), QUESO::DiscreteSubset< V, M >::contains(), QUESO::ExperimentModelOptions::defineMyOptions(), QUESO::SimulationModelOptions::defineMyOptions(), QUESO::GpmsaComputerModelOptions::defineMyOptions(), QUESO::StatisticalForwardProblemOptions::defineMyOptions(), QUESO::StatisticalInverseProblemOptions::defineMyOptions(), QUESO::MonteCarloSGOptions::defineMyOptions(), QUESO::EnvironmentOptions::defineMyOptions(), QUESO::MetropolisHastingsSGOptions::defineMyOptions(), QUESO::DiscreteSubset< V, M >::DiscreteSubset(), QUESO::FiniteDistribution::env(), QUESO::EnvironmentOptions::EnvironmentOptions(), QUESO::ExperimentModelOptions::ExperimentModelOptions(), QUESO::FiniteDistribution::FiniteDistribution(), QUESO::ExperimentModelOptions::getMyOptionValues(), QUESO::GpmsaComputerModelOptions::getMyOptionValues(), QUESO::StatisticalForwardProblemOptions::getMyOptionValues(), QUESO::StatisticalInverseProblemOptions::getMyOptionValues(), QUESO::MonteCarloSGOptions::getMyOptionValues(), QUESO::EnvironmentOptions::getMyOptionValues(), QUESO::MetropolisHastingsSGOptions::getMyOptionValues(), QUESO::GpmsaComputerModelOptions::GpmsaComputerModelOptions(), QUESO::MetropolisHastingsSGOptions::MetropolisHastingsSGOptions(), QUESO::MonteCarloSGOptions::MonteCarloSGOptions(), QUESO::operator<<(), QUESO::ExperimentModel< S_V, S_M, D_V, D_M >::optionsObj(), QUESO::SimulationModel< S_V, S_M, P_V, P_M, Q_V, Q_M >::optionsObj(), QUESO::DiscreteSubset< V, M >::print(), QUESO::ExperimentModelOptions::print(), QUESO::SimulationModelOptions::print(), QUESO::GpmsaComputerModelOptions::print(), QUESO::StatisticalForwardProblemOptions::print(), QUESO::StatisticalInverseProblemOptions::print(), QUESO::MonteCarloSGOptions::print(), QUESO::EnvironmentOptions::print(), QUESO::MetropolisHastingsSGOptions::print(), QUESO::FiniteDistribution::sample(), QUESO::BaseEnvironment::scanInputFileForMyOptions(), QUESO::ExperimentModelOptions::scanOptionsValues(), QUESO::SimulationModelOptions::scanOptionsValues(), QUESO::GpmsaComputerModelOptions::scanOptionsValues(), QUESO::MLSamplingLevelOptions::scanOptionsValues(), QUESO::StatisticalForwardProblemOptions::scanOptionsValues(), QUESO::MonteCarloSGOptions::scanOptionsValues(), QUESO::EnvironmentOptions::scanOptionsValues(), QUESO::MetropolisHastingsSGOptions::scanOptionsValues(), QUESO::SimulationModelOptions::SimulationModelOptions(), QUESO::StatisticalForwardProblemOptions::StatisticalForwardProblemOptions(), QUESO::StatisticalInverseProblemOptions::StatisticalInverseProblemOptions(), QUESO::FiniteDistribution::weights(), QUESO::DiscreteSubset< V, M >::~DiscreteSubset(), QUESO::EnvironmentOptions::~EnvironmentOptions(), QUESO::ExperimentModelOptions::~ExperimentModelOptions(), QUESO::FiniteDistribution::~FiniteDistribution(), QUESO::GpmsaComputerModelOptions::~GpmsaComputerModelOptions(), QUESO::MetropolisHastingsSGOptions::~MetropolisHastingsSGOptions(), QUESO::MonteCarloSGOptions::~MonteCarloSGOptions(), QUESO::SimulationModelOptions::~SimulationModelOptions(), QUESO::StatisticalForwardProblemOptions::~StatisticalForwardProblemOptions(), and QUESO::StatisticalInverseProblemOptions::~StatisticalInverseProblemOptions().

#define queso_do_once (   do_this)
Value:
do { \
static bool did_this_already = false; \
if (!did_this_already) { \
did_this_already = true; \
do_this; \
} } while (0)

Definition at line 105 of file Defines.h.

#define QUESO_EXPECTS_LN_LIKELIHOOD_INSTEAD_OF_MINUS_2_LN

This define is deprecated. Remove any #ifdef statements in user code.

Definition at line 51 of file Defines.h.

#define QUESO_HAS_MPI

This define is deprecated. Remove any #ifdef statements in user code.

Definition at line 48 of file Defines.h.

#define QUESO_USES_NEW_RNG_CLASS

Definition at line 72 of file Defines.h.

#define queso_warning (   message)
Value:
queso_do_once(std::cerr << message \
<< __FILE__ << ", line " << __LINE__ << ", compiled " << __DATE__ << " at " << __TIME__ << " ***" << std::endl;)
queso_do_once
#define queso_do_once(do_this)
Definition: Defines.h:105

Definition at line 115 of file Defines.h.

#define UQ_FATAL_RC_MACRO (   macroIRc,
  givenRank,
  where,
  what 
)
Value:
queso_deprecated(); \
if (macroIRc) { \
int macroRank = givenRank; \
if (macroRank < 0) { \
macroRank = QUESO::MyWorldfullRank(); \
} \
std::cerr << "UQ RC FATAL ERROR" \
<< ", rank " << macroRank \
<< ", in " << where \
<< ": " << what \
<< ", iRC = " << macroIRc \
<< ". Exiting..." \
<< std::endl; \
queso_error(); \
}
QUESO::MyWorldfullRank
int MyWorldfullRank()
Returns the rank of the calling process in the communicator.
Definition: Defines.C:30
queso_error
#define queso_error()
Definition: asserts.h:53
queso_deprecated
#define queso_deprecated()
Definition: Defines.h:120

Definition at line 154 of file Defines.h.

Referenced by QUESO::GslMatrix::mpiSum().

#define UQ_FATAL_TEST_MACRO (   test,
  givenRank,
  where,
  what 
)
Value:
queso_deprecated(); \
if (test) { \
int macroRank = givenRank; \
if (macroRank < 0) { \
macroRank = QUESO::MyWorldfullRank(); \
} \
std::cerr << "UQ TEST FATAL ERROR" \
<< ", rank " << macroRank \
<< ", in " << where \
<< ": " << what \
<< ". Exiting..." \
<< std::endl; \
queso_error(); \
}
QUESO::MyWorldfullRank
int MyWorldfullRank()
Returns the rank of the calling process in the communicator.
Definition: Defines.C:30
queso_error
#define queso_error()
Definition: asserts.h:53
queso_deprecated
#define queso_deprecated()
Definition: Defines.h:120

Definition at line 171 of file Defines.h.

#define UQ_FILE_EXTENSION_FOR_HDF_FORMAT   "h5"

Definition at line 90 of file Defines.h.

Referenced by QUESO::BaseEnvironment::closeFile(), QUESO::BaseEnvironment::openInputFile(), QUESO::BaseEnvironment::openOutputFile(), QUESO::BaseEnvironment::openUnifiedInputFile(), QUESO::BaseEnvironment::openUnifiedOutputFile(), QUESO::SequenceOfVectors< V, M >::subWriteContents(), QUESO::SequenceOfVectors< V, M >::unifiedReadContents(), QUESO::ScalarSequence< T >::unifiedReadContents(), QUESO::SequenceOfVectors< V, M >::unifiedWriteContents(), and QUESO::ScalarSequence< T >::unifiedWriteContents().

#define UQ_FILE_EXTENSION_FOR_MATLAB_FORMAT   "m"

Definition at line 89 of file Defines.h.

Referenced by QUESO::BaseEnvironment::closeFile(), QUESO::MLSampling< P_V, P_M >::generateSequence(), QUESO::MetropolisHastingsSG< P_V, P_M >::generateSequence(), QUESO::MLSampling< P_V, P_M >::generateSequence_Level0_all(), QUESO::MLSampling< P_V, P_M >::generateSequence_Step11_inter0(), QUESO::GpmsaComputerModel< S_V, S_M, D_V, D_M, P_V, P_M, Q_V, Q_M >::GpmsaComputerModel(), QUESO::MonteCarloSG< P_V, P_M, Q_V, Q_M >::internGenerateSequence(), QUESO::BaseEnvironment::openInputFile(), QUESO::BaseEnvironment::openOutputFile(), QUESO::BaseEnvironment::openUnifiedInputFile(), QUESO::BaseEnvironment::openUnifiedOutputFile(), QUESO::StatisticalForwardProblem< P_V, P_M, Q_V, Q_M >::solveWithMonteCarlo(), QUESO::SequenceOfVectors< V, M >::subWriteContents(), QUESO::SequenceOfVectors< V, M >::unifiedReadContents(), QUESO::ScalarSequence< T >::unifiedReadContents(), QUESO::SequenceOfVectors< V, M >::unifiedWriteContents(), and QUESO::ScalarSequence< T >::unifiedWriteContents().

#define UQ_RC_MACRO (   macroIRc,
  givenRank,
  where,
  what,
  retValue 
)
Value:
queso_deprecated(); \
if (macroIRc) { \
int macroRank = givenRank; \
if (macroRank < 0) { \
macroRank = QUESO::MyWorldfullRank(); \
} \
std::cerr << "UQ RC ERROR" \
<< ", rank " << macroRank \
<< ", in " << where \
<< ": " << what \
<< ", iRc = " << macroIRc \
<< std::endl; \
return retValue; \
}
QUESO::MyWorldfullRank
int MyWorldfullRank()
Returns the rank of the calling process in the communicator.
Definition: Defines.C:30
queso_deprecated
#define queso_deprecated()
Definition: Defines.h:120

Definition at line 123 of file Defines.h.

Referenced by QUESO::GslMatrix::chol(), and QUESO::GslMatrix::internalSvd().

#define UQ_TEST_MACRO (   test,
  givenRank,
  where,
  what,
  retValue 
)
Value:
queso_deprecated(); \
if (test) { \
int macroRank = givenRank; \
if (macroRank < 0) { \
macroRank = QUESO::MyWorldfullRank(); \
} \
std::cerr << "UQ TEST ERROR" \
<< ", rank " << macroRank \
<< ", in " << where \
<< ": " << what \
<< std::endl; \
return retValue; \
}
QUESO::MyWorldfullRank
int MyWorldfullRank()
Returns the rank of the calling process in the communicator.
Definition: Defines.C:30
queso_deprecated
#define queso_deprecated()
Definition: Defines.h:120

Definition at line 139 of file Defines.h.

Generated on Thu Jun 11 2015 13:52:33 for queso-0.53.0 by  doxygen 1.8.5