https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
AdaptiveMonteCarloDecision Class Reference

AdaptiveMonteCarloDecision will help make sample accept/reject decisions in adaptive Monte Carlo schemes. More...

#include <AdaptiveMonteCarloDecision.h>

Inheritance diagram for AdaptiveMonteCarloDecision:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 AdaptiveMonteCarloDecision (const InputParameters &parameters)
 
virtual void initialize () override
 
virtual void finalize () override
 
virtual void execute () override
 
void threadJoin (const UserObject &) final
 
bool shouldStore () const override final
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () const
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
void gatherSum (T &value)
 
void gatherMax (T &value)
 
void gatherMin (T &value)
 
void gatherProxyValueMax (T1 &proxy, T2 &value)
 
void gatherProxyValueMin (T1 &proxy, T2 &value)
 
std::set< UserObjectName > getDependObjects () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () const
 
virtual bool needThreadedCopy () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
bool isKokkosObject () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecatedNoTrace (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const std::vector< MooseVariableScalar * > & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyByName (const std::string &prop_name_in)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOldByName (const std::string &prop_name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOlderByName (const std::string &prop_name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialProperty (const std::string &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOld (const std::string &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOlder (const std::string &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > > getKokkosBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase * > > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
virtual bool getMaterialPropertyCalled () const
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
virtual void store (nlohmann::json &json) const
 
virtual void declareLateValues ()
 
void buildOutputHideVariableList (std::set< std::string > variable_names)
 
const std::set< OutputName > & getOutputs ()
 
virtual void subdomainSetup () override
 
virtual void subdomainSetup () override
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasKokkosMaterialProperty (const std::string &name)
 
bool hasKokkosMaterialProperty (const std::string &name)
 
bool hasKokkosMaterialPropertyByName (const std::string &name)
 
bool hasKokkosMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
Moose::Kokkos::Function getKokkosFunction (const std::string &name) const
 
const T & getKokkosFunction (const std::string &name) const
 
Moose::Kokkos::Function getKokkosFunctionByName (const FunctionName &name) const
 
const T & getKokkosFunctionByName (const FunctionName &name) const
 
bool hasKokkosFunction (const std::string &param_name) const
 
bool hasKokkosFunctionByName (const FunctionName &name) const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
T & getSampler (const std::string &name)
 
Sampler & getSampler (const std::string &name)
 
T & getSamplerByName (const SamplerName &name)
 
Sampler & getSamplerByName (const SamplerName &name)
 
virtual void meshChanged ()
 
virtual void meshDisplaced ()
 
PerfGraph & perfGraph ()
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static void callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
 
static void sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header, NameFunc &&name_func)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 
static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObjectBase &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
const ReporterContextBase & getReporterContextBaseByName (const ReporterName &reporter_name) const
 
const ReporterName & getReporterName (const std::string &param_name) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValue & coupledVectorTagScalarValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagScalarValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagScalarValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::Scalar< const Real > kokkosCoupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
virtual void getKokkosMaterialPropertyHook (const std::string &, const unsigned int)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
T & declareUnusedValue (Args &&... args)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

const std::vector< Real > & _output_value
 Model output value from SubApp.
 
std::vector< Real > & _output_required
 Modified value of model output by this reporter class.
 
std::vector< std::vector< Real > > & _inputs
 Model input data that is uncertain.
 
const Moose::CoordinateSystemType & _coord_sys
 
const THREAD_ID _tid
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
Assembly & _assembly
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
const bool & _enabled
 
MooseApp & _app
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
FEProblemBase & _mdi_feproblem
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const InputParameters & _mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase & _mi_feproblem
 
SubProblem & _mi_subproblem
 
const THREAD_ID _mi_tid
 
const bool _is_kokkos_object
 
const Moose::MaterialDataType _material_data_type
 
MaterialData & _material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int > _material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 
Real & _t
 
const Real & _t_old
 
int & _t_step
 
Real & _dt
 
Real & _dt_old
 
bool _is_transient
 
const Parallel::Communicator & _communicator
 

Static Protected Attributes

static const std::string _interpolated_old
 
static const std::string _interpolated_older
 

Private Member Functions

void reinitChain ()
 This reinitializes the Markov chain to the starting value until the Gaussian process training is completed.
 
const Moose::FunctionBase * getKokkosFunctionByNameHelper (const FunctionName &name) const
 
const UserObjectBase & getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const
 
const T & castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const
 
void mooseObjectError (const std::string &param_name, std::stringstream &oss) const
 
const std::string & userObjectType (const UserObjectBase &uo) const
 
const std::string & userObjectName (const UserObjectBase &uo) const
 
const PostprocessorName & getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const
 
bool isDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
PostprocessorValue getDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
void checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const
 
bool postprocessorsAdded () const
 
const VectorPostprocessorValue & getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const
 
const VectorPostprocessorContext< VectorPostprocessorValue > & getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool vectorPostprocessorsAdded () const
 
bool reportersAdded () const
 
void possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") const
 
RestartableDataValue & registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const
 
void registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)
 
RestartableData< T > & declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const
 
virtual std::string meshPropertyPrefix (const std::string &data_name) const
 
const RestartableDataValue & getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const
 
void mooseErrorInternal (Args &&... args) const
 
const VariableValue * getDefaultValue (const std::string &var_name) const
 
const ADVariableValue * getADDefaultValue (const std::string &var_name) const
 
void checkVar (const std::string &var_name) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 
Moose::Kokkos::Variable kokkosCoupledVectorTagScalarVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp) const
 
Moose::MaterialDataType getMaterialDataType (const std::set< BoundaryID > &boundary_ids) const
 
unsigned int getMaxQps () const
 
void addConsumedPropertyName (const MooseObjectName &obj_name, const std::string &prop_name)
 
const ReporterValueName & getReporterValueName (const std::string &param_name) const
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 

Static Private Member Functions

static const hit::Node * getHitNode (const InputParameters &params)
 
static std::string messagePrefix (const InputParameters &params, const bool hit_prefix)
 

Private Attributes

Sampler & _sampler
 The adaptive Monte Carlo sampler.
 
const AdaptiveImportanceSampler *const _ais
 Adaptive Importance Sampler.
 
const ParallelSubsetSimulation *const _pss
 Parallel Subset Simulation sampler.
 
int & _check_step
 Ensure that the MCMC algorithm proceeds in a sequential fashion.
 
std::vector< std::vector< Real > > & _prev_val
 Storage for previously accepted input values. This helps in making decision on the next proposed inputs.
 
std::vector< Real > & _prev_val_out
 Storage for previously accepted output value.
 
std::vector< std::vector< Real > > & _inputs_sto
 Storage for the previously accepted sample inputs across all the subsets.
 
std::vector< std::vector< Real > > & _inputs_sorted
 Store the sorted input samples according to their corresponding outputs.
 
std::vector< Real > & _outputs_sto
 Storage for previously accepted sample outputs across all the subsets.
 
std::vector< Real > & _output_sorted
 Store the sorted output sample values.
 
Real & _output_limit
 Store the intermediate ouput failure thresholds.
 
const bool _gp_used
 Check if a GP is used.
 
const int *const _gp_training_samples
 Store the GP training samples.
 
const bool _always_store
 
UserObject * _primary_thread_copy
 
std::set< std::string > _supplied_uo
 
const ParallelParamObject & _parent
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 
ExecFlagEnum _empty_execute_enum
 
const MooseObject & _fni_object
 
const InputParameters & _fni_params
 
FEProblemBase & _fni_feproblem
 
const THREAD_ID _fni_tid
 
const MooseObject & _uoi_moose_object
 
const FEProblemBase & _uoi_feproblem
 
const THREAD_ID _uoi_tid
 
const MooseObject & _ppi_moose_object
 
const InputParameters & _ppi_params
 
const FEProblemBase & _ppi_feproblem
 
std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > > _default_values
 
const bool _broadcast_by_default
 
const MooseObject & _vpi_moose_object
 
const FEProblemBase & _vpi_feproblem
 
const THREAD_ID _vpi_tid
 
const InputParameters & _ri_params
 
FEProblemBase & _ri_fe_problem_base
 
const ReporterData & _ri_reporter_data
 
const MooseObject & _ri_moose_object
 
const InputParameters & _dni_params
 
FEProblemBase & _dni_feproblem
 
const MooseObject *const _dni_moose_object_ptr
 
const InputParameters & _si_params
 
FEProblemBase & _si_feproblem
 
THREAD_ID _si_tid
 
const RestartableDataMapName _metaname
 
std::string _restartable_name
 
MooseApp & _meta_data_app
 
const MooseObject *const _meta_data_object
 
const InputParameters & _sc_parameters
 
const std::string & _sc_name
 
const bool _sc_is_implicit
 
std::unordered_map< std::string, std::vector< MooseVariableScalar * > > _coupled_scalar_vars
 
std::unordered_map< std::string, std::unique_ptr< VariableValue > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< ADVariableValue > > _dual_default_value
 
std::vector< MooseVariableScalar * > _coupled_moose_scalar_vars
 
std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > > _sc_coupled_vars
 
std::set< TagID > _sc_coupleable_vector_tags
 
std::set< TagID > _sc_coupleable_matrix_tags
 
const MooseObject & _mi_moose_object
 
const bool _mi_boundary_restricted
 
const std::set< SubdomainID > & _mi_block_ids
 
const std::set< BoundaryID > & _mi_boundary_ids
 
std::vector< std::unique_ptr< OptionalMaterialPropertyProxyBase< MaterialPropertyInterface > > > _optional_property_proxies
 
const std::string _ti_name
 
const MooseObject & _reporter_moose_object
 
const InputParameters & _reporter_params
 
const std::string & _reporter_name
 
FEProblemBase & _reporter_fe_problem
 
ReporterData & _reporter_data
 
std::vector< std::unique_ptr< UnusedWrapperBase > > _unused_values
 
MooseApp & _oi_moose_app
 
OutputWarehouse & _oi_output_warehouse
 
std::set< OutputName > _oi_outputs
 

Detailed Description

AdaptiveMonteCarloDecision will help make sample accept/reject decisions in adaptive Monte Carlo schemes.

Definition at line 19 of file AdaptiveMonteCarloDecision.h.

Constructor & Destructor Documentation

◆ AdaptiveMonteCarloDecision()

AdaptiveMonteCarloDecision::AdaptiveMonteCarloDecision ( const InputParameters &  parameters)

Definition at line 39 of file AdaptiveMonteCarloDecision.C.

40 : GeneralReporter(parameters),
41 _output_value(isParamValid("gp_decision") ? getReporterValue<std::vector<Real>>("output_value")
42 : getReporterValue<std::vector<Real>>(
43 "output_value", REPORTER_MODE_DISTRIBUTED)),
44 _output_required(declareValue<std::vector<Real>>("output_required")),
45 _inputs(declareValue<std::vector<std::vector<Real>>>("inputs")),
46 _sampler(getSampler("sampler")),
47 _ais(dynamic_cast<const AdaptiveImportanceSampler *>(&_sampler)),
48 _pss(dynamic_cast<const ParallelSubsetSimulation *>(&_sampler)),
49 _check_step(declareRestartableData<int>("check_step", std::numeric_limits<int>::max())),
50 _prev_val(declareRestartableData<std::vector<std::vector<Real>>>("prev_val")),
51 _prev_val_out(declareRestartableData<std::vector<Real>>("prev_val_out")),
52 _inputs_sto(declareRestartableData<std::vector<std::vector<Real>>>("inputs_sto")),
53 _inputs_sorted(declareRestartableData<std::vector<std::vector<Real>>>("inputs_sorted")),
54 _outputs_sto(declareRestartableData<std::vector<Real>>("outputs_sto")),
55 _output_sorted(declareRestartableData<std::vector<Real>>("output_sorted")),
56 _output_limit(declareRestartableData<Real>("output_limit", 0.0)),
57 _gp_used(isParamValid("gp_decision")),
58#ifdef MOOSE_LIBTORCH_ENABLED
59 _gp_training_samples(
60 _gp_used ? &getUserObject<ActiveLearningGPDecision>("gp_decision").getTrainingSamples()
61 : nullptr)
62#else
63 _gp_training_samples(nullptr)
64#endif
65{
66#ifndef MOOSE_LIBTORCH_ENABLED
67 if (_gp_used)
68 paramError("gp_decision", "The 'gp_decision' parameter requires libtorch.");
69#endif
70
71 // Check whether the selected sampler is an adaptive sampler or not
72 if (!_ais && !_pss)
73 paramError("sampler", "The selected sampler is not an adaptive sampler.");
74
75 const auto rows = _sampler.getNumberOfRows();
76 const auto cols = _sampler.getNumberOfCols();
77
78 // Initialize the required variables depending upon the type of adaptive Monte Carlo algorithm
79 _inputs.resize(cols, std::vector<Real>(rows));
80 _prev_val.resize(cols, std::vector<Real>(rows));
81 _output_required.resize(rows);
82 _prev_val_out.resize(rows);
83
84 if (_ais)
85 {
86 for (dof_id_type j = 0; j < _sampler.getNumberOfCols(); ++j)
87 _prev_val[j][0] = _ais->getInitialValues()[j];
88 _output_limit = _ais->getOutputLimit();
89 }
90 else if (_pss)
91 {
92 _inputs_sto.resize(cols, std::vector<Real>(_pss->getNumSamplesSub()));
93 _inputs_sorted.resize(cols);
94 _outputs_sto.resize(_pss->getNumSamplesSub());
95 _output_limit = -std::numeric_limits<Real>::max();
96 }
97}
98
99void
100AdaptiveMonteCarloDecision::reinitChain()
101{
102 const std::vector<Real> & tmp1 = _ais->getInitialValues();
103 for (dof_id_type j = 0; j < tmp1.size(); ++j)
104 _inputs[j][0] = tmp1[j];
105 _prev_val = _inputs;
106 _prev_val_out[0] = 1.0;
107}
REPORTER_MODE_DISTRIBUTED
const ReporterMode REPORTER_MODE_DISTRIBUTED
int
void ErrorVector unsigned int
AdaptiveImportanceSampler
A class used to perform Adaptive Importance Sampling using a Markov Chain Monte Carlo algorithm.
Definition AdaptiveImportanceSampler.h:19
AdaptiveImportanceSampler::getInitialValues
const std::vector< Real > & getInitialValues() const
Definition AdaptiveImportanceSampler.h:26
AdaptiveMonteCarloDecision::_inputs
std::vector< std::vector< Real > > & _inputs
Model input data that is uncertain.
Definition AdaptiveMonteCarloDecision.h:36
AdaptiveMonteCarloDecision::_output_required
std::vector< Real > & _output_required
Modified value of model output by this reporter class.
Definition AdaptiveMonteCarloDecision.h:33
AdaptiveMonteCarloDecision::_gp_used
const bool _gp_used
Check if a GP is used.
Definition AdaptiveMonteCarloDecision.h:79
AdaptiveMonteCarloDecision::_prev_val_out
std::vector< Real > & _prev_val_out
Storage for previously accepted output value.
Definition AdaptiveMonteCarloDecision.h:61
AdaptiveMonteCarloDecision::_inputs_sorted
std::vector< std::vector< Real > > & _inputs_sorted
Store the sorted input samples according to their corresponding outputs.
Definition AdaptiveMonteCarloDecision.h:67
AdaptiveMonteCarloDecision::_gp_training_samples
const int *const _gp_training_samples
Store the GP training samples.
Definition AdaptiveMonteCarloDecision.h:82
AdaptiveMonteCarloDecision::_output_value
const std::vector< Real > & _output_value
Model output value from SubApp.
Definition AdaptiveMonteCarloDecision.h:30
AdaptiveMonteCarloDecision::_check_step
int & _check_step
Ensure that the MCMC algorithm proceeds in a sequential fashion.
Definition AdaptiveMonteCarloDecision.h:55
AdaptiveMonteCarloDecision::_sampler
Sampler & _sampler
The adaptive Monte Carlo sampler.
Definition AdaptiveMonteCarloDecision.h:46
AdaptiveMonteCarloDecision::_prev_val
std::vector< std::vector< Real > > & _prev_val
Storage for previously accepted input values. This helps in making decision on the next proposed inpu...
Definition AdaptiveMonteCarloDecision.h:58
AdaptiveMonteCarloDecision::_ais
const AdaptiveImportanceSampler *const _ais
Adaptive Importance Sampler.
Definition AdaptiveMonteCarloDecision.h:49
AdaptiveMonteCarloDecision::_inputs_sto
std::vector< std::vector< Real > > & _inputs_sto
Storage for the previously accepted sample inputs across all the subsets.
Definition AdaptiveMonteCarloDecision.h:64
AdaptiveMonteCarloDecision::_output_limit
Real & _output_limit
Store the intermediate ouput failure thresholds.
Definition AdaptiveMonteCarloDecision.h:76
AdaptiveMonteCarloDecision::_outputs_sto
std::vector< Real > & _outputs_sto
Storage for previously accepted sample outputs across all the subsets.
Definition AdaptiveMonteCarloDecision.h:70
AdaptiveMonteCarloDecision::_pss
const ParallelSubsetSimulation *const _pss
Parallel Subset Simulation sampler.
Definition AdaptiveMonteCarloDecision.h:52
AdaptiveMonteCarloDecision::reinitChain
void reinitChain()
This reinitializes the Markov chain to the starting value until the Gaussian process training is comp...
AdaptiveMonteCarloDecision::_output_sorted
std::vector< Real > & _output_sorted
Store the sorted output sample values.
Definition AdaptiveMonteCarloDecision.h:73
GeneralReporter::parameters
const InputParameters & parameters() const
GeneralReporter::paramError
void paramError(const std::string &param, Args... args) const
GeneralReporter::isParamValid
bool isParamValid(const std::string &name) const
ParallelSubsetSimulation
A class used to perform Parallel Subset Simulation Sampling.
Definition ParallelSubsetSimulation.h:19
ParallelSubsetSimulation::getNumSamplesSub
const unsigned int & getNumSamplesSub() const
Access the number samples per subset.
Definition ParallelSubsetSimulation.C:102
GeneralReporter::getReporterValue
const T & getReporterValue(const std::string &param_name, const std::size_t time_index=0)
GeneralReporter::declareValue
T & declareValue(const std::string &param_name, Args &&... args)
GeneralReporter::declareRestartableData
T & declareRestartableData(const std::string &data_name, Args &&... args)
GeneralReporter::getSampler
T & getSampler(const std::string &name)
Sampler::getNumberOfRows
dof_id_type getNumberOfRows() const
Sampler::getNumberOfCols
dof_id_type getNumberOfCols() const
GeneralReporter::getUserObject
const T & getUserObject(const std::string &param_name, bool is_dependency=true) const
CompileTimeDerivatives::max
auto max(const L &left, const R &right)
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Member Function Documentation

◆ execute()

void AdaptiveMonteCarloDecision::execute ( )
overridevirtual

Implements GeneralReporter.

Definition at line 110 of file AdaptiveMonteCarloDecision.C.

111{
112 if (_sampler.getNumberOfLocalRows() == 0 || _check_step == _t_step)
113 {
114 _check_step = _t_step;
115 return;
116 }
117
118 /* Decision step to whether or not to accept the proposed sample by the sampler.
119 This decision step changes with the type of adaptive Monte Carlo sampling algorithm. */
120 if (_ais)
121 {
122 const Real tmp = _ais->getUseAbsoluteValue() ? std::abs(_output_value[0]) : _output_value[0];
123
124 /* Checking whether a GP surrogate is used. If it is used, importance sampling is not performed
125 during the training phase of the GP and all proposed samples are accepted until the training
126 phase is completed. Once the training is completed, the importance sampling starts.
127 If a GP surrogate is not used, the standard proposal and acceptance/rejection is performed as
128 part of the importance sampling. */
129 const bool restart_gp = _gp_used && _t_step == *_gp_training_samples;
130 const bool output_limit_reached = _gp_used || tmp >= _output_limit;
131 if (restart_gp)
132 reinitChain();
133
134 _output_required[0] = output_limit_reached ? 1.0 : 0.0;
135
136 if (_t_step <= _ais->getNumSamplesTrain() && !restart_gp)
137 {
138 /* This is the training phase of the Adaptive Importance Sampling algorithm.
139 Here, it is decided whether or not to accept a proposed sample by the
140 AdaptiveImportanceSampler.C sampler depending upon the model output_value. */
141 _inputs = output_limit_reached
142 ? StochasticTools::reshapeVector(_sampler.getSampleRow(0), 1, true)
143 : _prev_val;
144 if (output_limit_reached)
145 _prev_val = _inputs;
146 _prev_val_out = _output_required;
147 }
148 else if (_t_step > _ais->getNumSamplesTrain() && !restart_gp)
149 {
150 /* This is the sampling phase of the Adaptive Importance Sampling algorithm.
151 Here, all proposed samples by the AdaptiveImportanceSampler.C sampler are accepted since
152 the importance distribution traning phase is finished. */
153 _inputs = StochasticTools::reshapeVector(_sampler.getSampleRow(0), 1, true);
154 _prev_val_out[0] = tmp;
155 }
156 }
157 else if (_pss)
158 {
159 // Track the current subset
160 const unsigned int subset =
161 ((_t_step - 1) * _sampler.getNumberOfRows()) / _pss->getNumSamplesSub();
162 const unsigned int sub_ind =
163 (_t_step - 1) - (_pss->getNumSamplesSub() / _sampler.getNumberOfRows()) * subset;
164 const unsigned int offset = sub_ind * _sampler.getNumberOfRows();
165 const unsigned int count_max = 1 / _pss->getSubsetProbability();
166
167 DenseMatrix<Real> data_in = _sampler.getGlobalSamples();
168
169 // Get the accepted samples outputs across all the procs from the previous step
170 mooseAssert(_output_value.size() >= _sampler.getNumberOfLocalRows(),
171 "Incorrectly sized outputs.");
172 _output_required.assign(_output_value.begin(),
173 _output_value.begin() + _sampler.getNumberOfLocalRows());
174 if (_pss->getUseAbsoluteValue())
175 _output_required = AdaptiveMonteCarloUtils::computeVectorABS(_output_required);
176 _communicator.allgather(_output_required);
177
178 // These are the subsequent subsets which use Markov Chain Monte Carlo sampling scheme
179 if (subset > 0)
180 {
181 if (sub_ind == 0)
182 {
183 // _output_sorted contains largest po percentile output values
184 _output_sorted = AdaptiveMonteCarloUtils::sortOutput(
185 _outputs_sto, _pss->getNumSamplesSub(), _pss->getSubsetProbability());
186 // _inputs_sorted contains the input values corresponding to the largest po percentile
187 // output values
188 _inputs_sorted = AdaptiveMonteCarloUtils::sortInput(
189 _inputs_sto, _outputs_sto, _pss->getNumSamplesSub(), _pss->getSubsetProbability());
190 // Get the subset's intermediate failure threshold values
191 _output_limit = AdaptiveMonteCarloUtils::computeMin(_output_sorted);
192 }
193 // Check whether the number of samples in a Markov chain exceeded the limit
194 if (sub_ind % count_max == 0)
195 {
196 const unsigned int soffset = (sub_ind / count_max) * _sampler.getNumberOfRows();
197 // Reinitialize the starting input values for the next set of Markov chains
198 for (dof_id_type j = 0; j < _sampler.getNumberOfCols(); ++j)
199 _prev_val[j].assign(_inputs_sorted[j].begin() + soffset,
200 _inputs_sorted[j].begin() + soffset + _sampler.getNumberOfRows());
201 _prev_val_out.assign(_output_sorted.begin() + soffset,
202 _output_sorted.begin() + soffset + _sampler.getNumberOfRows());
203 }
204 else
205 {
206 // Otherwise, use the previously accepted input values to propose the next set of input
207 // values
208 for (dof_id_type j = 0; j < _sampler.getNumberOfCols(); ++j)
209 _prev_val[j].assign(_inputs_sto[j].begin() + offset - _sampler.getNumberOfRows(),
210 _inputs_sto[j].begin() + offset);
211 _prev_val_out.assign(_outputs_sto.begin() + offset - _sampler.getNumberOfRows(),
212 _outputs_sto.begin() + offset);
213 }
214 }
215
216 // Check whether the outputs exceed the subset's intermediate failure threshold value
217 for (dof_id_type ss = 0; ss < _sampler.getNumberOfRows(); ++ss)
218 {
219 // Check whether the outputs exceed the subset's intermediate failure threshold value
220 // If so, accept the proposed input values by the Sampler object
221 // Otherwise, use the previously accepted input values
222 const bool output_limit_reached = _output_required[ss] >= _output_limit;
223 for (dof_id_type i = 0; i < _sampler.getNumberOfCols(); ++i)
224 {
225 _inputs[i][ss] = output_limit_reached ? data_in(ss, i) : _prev_val[i][ss];
226 _inputs_sto[i][ss + offset] = _inputs[i][ss];
227 }
228 if (!output_limit_reached)
229 _output_required[ss] = _prev_val_out[ss];
230 _outputs_sto[ss + offset] = _output_required[ss];
231 }
232 }
233 // Track the current step
234 _check_step = _t_step;
235}
AdaptiveImportanceSampler::getUseAbsoluteValue
const bool & getUseAbsoluteValue() const
Definition AdaptiveImportanceSampler.h:32
ParallelSubsetSimulation::getSubsetProbability
const Real & getSubsetProbability() const
Access the subset probability.
Definition ParallelSubsetSimulation.C:114
ParallelSubsetSimulation::getUseAbsoluteValue
const bool & getUseAbsoluteValue() const
Access use absolute value bool.
Definition ParallelSubsetSimulation.C:108
Sampler::getNumberOfLocalRows
dof_id_type getNumberOfLocalRows() const
Sampler::getSampleRow
std::vector< Real > getSampleRow(dof_id_type row_index) const
Sampler::getGlobalSamples
DenseMatrix< Real > getGlobalSamples()
libMesh::Parallel::Communicator::allgather
void allgather(const T &send_data, std::vector< T, A > &recv_data) const
libMesh::ParallelObject::_communicator
const Parallel::Communicator & _communicator
AdaptiveMonteCarloUtils::sortOutput
std::vector< Real > sortOutput(const std::vector< Real > &outputs, const unsigned int samplessub, const Real subset_prob)
return the largest po percentile output values.
Definition AdaptiveMonteCarloUtils.C:66
AdaptiveMonteCarloUtils::computeMin
Real computeMin(const std::vector< Real > &data)
return the minimum value in a vector.
Definition AdaptiveMonteCarloUtils.C:80
AdaptiveMonteCarloUtils::sortInput
std::vector< std::vector< Real > > sortInput(const std::vector< std::vector< Real > > &inputs, const std::vector< Real > &outputs, const unsigned int samplessub, const Real subset_prob)
return input values corresponding to the largest po percentile output values.
Definition AdaptiveMonteCarloUtils.C:48
AdaptiveMonteCarloUtils::computeVectorABS
std::vector< Real > computeVectorABS(const std::vector< Real > &data)
return the absolute values in a vector.
Definition AdaptiveMonteCarloUtils.C:86
StochasticTools::reshapeVector
std::vector< std::vector< T > > reshapeVector(const std::vector< T > &vec, std::size_t n, bool row_major)
Reshape a vector into matrix-like vector of vectors.
Definition StochasticToolsUtils.h:259

◆ finalize()

virtual void AdaptiveMonteCarloDecision::finalize ( )
inlineoverridevirtual

Implements GeneralReporter.

Definition at line 25 of file AdaptiveMonteCarloDecision.h.

25{}

◆ initialize()

virtual void AdaptiveMonteCarloDecision::initialize ( )
inlineoverridevirtual

Implements GeneralReporter.

Definition at line 24 of file AdaptiveMonteCarloDecision.h.

24{}

◆ reinitChain()

void AdaptiveMonteCarloDecision::reinitChain ( )
private

This reinitializes the Markov chain to the starting value until the Gaussian process training is completed.

Referenced by execute().

◆ validParams()

InputParameters AdaptiveMonteCarloDecision::validParams ( )
static

Definition at line 22 of file AdaptiveMonteCarloDecision.C.

23{
24 InputParameters params = GeneralReporter::validParams();
25 params.addClassDescription("Generic reporter which decides whether or not to accept a proposed "
26 "sample in Adaptive Monte Carlo type of algorithms.");
27 params.addRequiredParam<ReporterName>("output_value",
28 "Value of the model output from the SubApp.");
29 params.addParam<ReporterValueName>(
30 "output_required",
31 "output_required",
32 "Modified value of the model output from this reporter class.");
33 params.addParam<ReporterValueName>("inputs", "inputs", "Uncertain inputs to the model.");
34 params.addRequiredParam<SamplerName>("sampler", "The sampler object.");
35 params.addParam<UserObjectName>("gp_decision", "The Gaussian Process decision reporter.");
36 return params;
37}
GeneralReporter::validParams
static InputParameters validParams()
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _ais

const AdaptiveImportanceSampler* const AdaptiveMonteCarloDecision::_ais
private

Adaptive Importance Sampler.

Definition at line 49 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

◆ _check_step

int& AdaptiveMonteCarloDecision::_check_step
private

Ensure that the MCMC algorithm proceeds in a sequential fashion.

Definition at line 55 of file AdaptiveMonteCarloDecision.h.

Referenced by execute().

◆ _gp_training_samples

const int* const AdaptiveMonteCarloDecision::_gp_training_samples
private

Store the GP training samples.

Definition at line 82 of file AdaptiveMonteCarloDecision.h.

Referenced by execute().

◆ _gp_used

const bool AdaptiveMonteCarloDecision::_gp_used
private

Check if a GP is used.

Definition at line 79 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

◆ _inputs

std::vector<std::vector<Real> >& AdaptiveMonteCarloDecision::_inputs
protected

Model input data that is uncertain.

Definition at line 36 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

◆ _inputs_sorted

std::vector<std::vector<Real> >& AdaptiveMonteCarloDecision::_inputs_sorted
private

Store the sorted input samples according to their corresponding outputs.

Definition at line 67 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

◆ _inputs_sto

std::vector<std::vector<Real> >& AdaptiveMonteCarloDecision::_inputs_sto
private

Storage for the previously accepted sample inputs across all the subsets.

Definition at line 64 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

◆ _output_limit

Real& AdaptiveMonteCarloDecision::_output_limit
private

Store the intermediate ouput failure thresholds.

Definition at line 76 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

◆ _output_required

std::vector<Real>& AdaptiveMonteCarloDecision::_output_required
protected

Modified value of model output by this reporter class.

Definition at line 33 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

◆ _output_sorted

std::vector<Real>& AdaptiveMonteCarloDecision::_output_sorted
private

Store the sorted output sample values.

Definition at line 73 of file AdaptiveMonteCarloDecision.h.

Referenced by execute().

◆ _output_value

const std::vector<Real>& AdaptiveMonteCarloDecision::_output_value
protected

Model output value from SubApp.

Definition at line 30 of file AdaptiveMonteCarloDecision.h.

Referenced by execute().

◆ _outputs_sto

std::vector<Real>& AdaptiveMonteCarloDecision::_outputs_sto
private

Storage for previously accepted sample outputs across all the subsets.

Definition at line 70 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

◆ _prev_val

std::vector<std::vector<Real> >& AdaptiveMonteCarloDecision::_prev_val
private

Storage for previously accepted input values. This helps in making decision on the next proposed inputs.

Definition at line 58 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

◆ _prev_val_out

std::vector<Real>& AdaptiveMonteCarloDecision::_prev_val_out
private

Storage for previously accepted output value.

Definition at line 61 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

◆ _pss

const ParallelSubsetSimulation* const AdaptiveMonteCarloDecision::_pss
private

Parallel Subset Simulation sampler.

Definition at line 52 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

◆ _sampler

Sampler& AdaptiveMonteCarloDecision::_sampler
private

The adaptive Monte Carlo sampler.

Definition at line 46 of file AdaptiveMonteCarloDecision.h.

Referenced by AdaptiveMonteCarloDecision(), and execute().

The documentation for this class was generated from the following files:
Generated on Mon Sep 28 2026 20:38:34 for https://mooseframework.inl.gov by doxygen 1.9.8