https://mooseframework.inl.gov
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 Attributes | List of all members
ActiveLearningReporterTempl< T > Class Template Reference

This is a base class for performing active learning routines, meant to be used in conjunction with Sampler multiapps and SamplerReporterTransfer. More...

#include <ActiveLearningReporterBase.h>

Inheritance diagram for ActiveLearningReporterTempl< T >:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 ActiveLearningReporterTempl (const InputParameters &parameters)
 
virtual void execute () override
 Here we loop through the samples and call the needSample function to determine if the sample needs to be run and define a value in its place. More...
 
virtual void initialize () override
 
virtual void finalize () override
 
void threadJoin (const UserObject &) final
 
bool shouldStore () const override final
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () 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)
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
std::set< UserObjectName > getDependObjects () const
 
virtual bool needThreadedCopy () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () 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 &nm) const
 
void paramError (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
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) 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 UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & 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)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (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)
 
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 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
 
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 sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

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 ReporterName declareStochasticReporterClone (const Sampler &sampler, const ReporterData &from_data, const ReporterName &from_reporter, std::string prefix="") override
 This is overriden for the following reasons: 1) Only one vector can be declared and must match the type of this class. More...
 
const Sampler & sampler () const
 Get a const reference to the sampler from the parameters. More...
 
const std::vector< std::vector< Real > > & getGlobalInputData () const
 
const std::vector< T > & getGlobalOutputData () const
 Get a const reference to the output data. More...
 
virtual void preNeedSample ()
 Optional virtual function that is called before the sampler loop calling needSample. More...
 
virtual bool needSample (const std::vector< Real > &, dof_id_type, dof_id_type, T &)
 This routine is called during the sampler loop in execute() and is meant to fill in the "need_sample" reporter value and modify the data declared by the transfer. More...
 
template<typename T >
std::vector< T > & declareStochasticReporter (std::string value_name, const Sampler &sampler)
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObject &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
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, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, 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
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
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

Sampler & _sampler
 Sampler given in the parameters, must match the one used to declare the transferred values. More...
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
const THREAD_ID _tid
 
Assembly & _assembly
 
const Moose::CoordinateSystemType & _coord_sys
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
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 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 Attributes

std::vector< bool > & _need_sample
 Reporter value determining whether we need to evaluate the sample through a multiapp or other means. More...
 
std::vector< T > * _data = nullptr
 Reporter value declared with the transfer. More...
 
bool _input_data_requested = false
 Whether or not to gather global input data. More...
 
bool _output_data_requested = false
 Whether or not to gather global output data. More...
 
std::vector< std::vector< Real > > _input_data
 Global input data from sampler. More...
 
std::vector< T > _output_data
 Global output data from sampler. More...
 

Detailed Description

template<typename T>
class ActiveLearningReporterTempl< T >

This is a base class for performing active learning routines, meant to be used in conjunction with Sampler multiapps and SamplerReporterTransfer.

The purpose is to determine if a sample needs to be evaluated by a multiphysics solve and possibly replace quantities of interest with values computed by other means.

Definition at line 15 of file ActiveLearningReporterBase.h.

Constructor & Destructor Documentation

◆ ActiveLearningReporterTempl()

template<typename T >
ActiveLearningReporterTempl< T >::ActiveLearningReporterTempl ( const InputParameters &  parameters)

Definition at line 129 of file ActiveLearningReporterBase.h.

130  : StochasticReporter(parameters),
131  _sampler(this->template getSampler<Sampler>("sampler")),
132  _need_sample(this->template declareStochasticReporter<bool>("need_sample", _sampler))
133 {
134 }
StochasticReporter::StochasticReporter
StochasticReporter(const InputParameters &parameters)
Definition: StochasticReporter.C:33
ActiveLearningReporterTempl::_need_sample
std::vector< bool > & _need_sample
Reporter value determining whether we need to evaluate the sample through a multiapp or other means...
Definition: ActiveLearningReporterBase.h:105
GeneralReporter::parameters
const InputParameters & parameters() const
ActiveLearningReporterTempl::_sampler
Sampler & _sampler
Sampler given in the parameters, must match the one used to declare the transferred values...
Definition: ActiveLearningReporterBase.h:100

Member Function Documentation

◆ declareStochasticReporter()

template<typename T >
std::vector< T > & StochasticReporter::declareStochasticReporter ( std::string  value_name,
const Sampler &  sampler 
)
protectedinherited

Definition at line 131 of file StochasticReporter.h.

Referenced by StochasticReporter::declareStochasticReporterClone(), and SamplerReporterTransfer::intitializeStochasticReporters().

132 {
133  const ReporterMode mode =
134  this->_parallel_type == 0 ? REPORTER_MODE_DISTRIBUTED : REPORTER_MODE_ROOT;
135  return this->template declareValueByName<std::vector<T>, StochasticReporterContext<T>>(
136  value_name, mode, sampler);
137 }
REPORTER_MODE_ROOT
const ReporterMode REPORTER_MODE_ROOT
StochasticReporter::_parallel_type
const unsigned int _parallel_type
Definition: StochasticReporter.h:126
REPORTER_MODE_DISTRIBUTED
const ReporterMode REPORTER_MODE_DISTRIBUTED

◆ declareStochasticReporterClone()

template<typename T >
ReporterName ActiveLearningReporterTempl< T >::declareStochasticReporterClone ( const Sampler &  sampler,
const ReporterData &  from_data,
const ReporterName &  from_reporter,
std::string  prefix = "" 
)
overrideprotectedvirtual

This is overriden for the following reasons: 1) Only one vector can be declared and must match the type of this class.

2) Check that the inputted sampler matches the one given in the parameters. 3) We actually get a pointer to the declared value so we can replace it (if necessary) in the needSample routine. 4) Declare the "need_sample" value which can be used to evaluate the sample or not.

Reimplemented from StochasticReporter.

Definition at line 176 of file ActiveLearningReporterBase.h.

180 {
181  // Only one value is allowed to be declared
182  if (_data)
183  this->mooseError(type(), " can only declare a single reporter value.");
184  // Make sure the inputted sampler is the same one in the parameters
185  else if (sampler.name() != _sampler.name())
186  this->paramError("sampler",
187  "Inputted sampler, ",
188  _sampler.name(),
189  ", is not the same as the one producing data, ",
190  sampler.name(),
191  ".");
192  // Make sure reporter value exists
193  else if (!from_data.hasReporterValue(from_reporter))
194  this->mooseError("Reporter value ", from_reporter, " has not been declared.");
195  // Make sure the reporter value is the right type
196  else if (!from_data.hasReporterValue<T>(from_reporter))
197  this->mooseError(
198  type(), " can only use reporter values of type ", MooseUtils::prettyCppType<T>(), ".");
199 
200  std::string value_name = (prefix.empty() ? "" : prefix + ":") + from_reporter.getObjectName() +
201  ":" + from_reporter.getValueName();
202  _data = &this->declareStochasticReporter<T>(value_name, sampler);
203  return {name(), value_name};
204 }
ActiveLearningReporterTempl::sampler
const Sampler & sampler() const
Get a const reference to the sampler from the parameters.
Definition: ActiveLearningReporterBase.h:57
Sampler::name
virtual const std::string & name() const
ActiveLearningReporterTempl::_data
std::vector< T > * _data
Reporter value declared with the transfer.
Definition: ActiveLearningReporterBase.h:107
GeneralReporter::type
const std::string & type() const
GeneralReporter::paramError
void paramError(const std::string &param, Args... args) const
ReporterName::getObjectName
const std::string & getObjectName() const
GeneralReporter::mooseError
void mooseError(Args &&... args) const
ReporterData::hasReporterValue
bool hasReporterValue(const ReporterName &reporter_name) const
ReporterName::getValueName
const std::string & getValueName() const
ActiveLearningReporterTempl::_sampler
Sampler & _sampler
Sampler given in the parameters, must match the one used to declare the transferred values...
Definition: ActiveLearningReporterBase.h:100

◆ execute()

template<typename T >
void ActiveLearningReporterTempl< T >::execute ( )
overridevirtual

Here we loop through the samples and call the needSample function to determine if the sample needs to be run and define a value in its place.

Reimplemented from StochasticReporter.

Definition at line 138 of file ActiveLearningReporterBase.h.

139 {
140  // If requesting global data, fill it in
141  if (_input_data_requested)
142  {
143  // Gather inputs for the current step
144  _input_data.assign(_sampler.getNumberOfRows(),
145  std::vector<Real>(_sampler.getNumberOfCols(), 0.0));
146  for (dof_id_type i = _sampler.getLocalRowBegin(); i < _sampler.getLocalRowEnd(); ++i)
147  _input_data[i] = _sampler.getNextLocalRow();
148  for (auto & inp : _input_data)
149  gatherSum(inp);
150  }
151  if (_output_data_requested)
152  {
153  if (!_data)
154  mooseError("Output data has been requested, but none was declared in this object.");
155  _output_data = *_data;
156  _communicator.allgather(_output_data);
157  }
158 
159  // Optional call for before sampler loop
160  preNeedSample();
161 
162  // Dummy value in case _data has not been declared yet
163  T dummy;
164  // Loop over samples to determine if sample is needed. Replace value in _data
165  // (typically only if a sample is not needed). We insert a dummy value in case
166  // _data has not been declared.
167  for (const auto & i : make_range(_sampler.getNumberOfLocalRows()))
168  _need_sample[i] = needSample(_sampler.getNextLocalRow(),
169  i,
170  i + _sampler.getLocalRowBegin(),
171  (_data ? (*_data)[i] : dummy));
172 }
libMesh::Parallel::Communicator::allgather
void allgather(const T &send_data, std::vector< T, A > &recv_data) const
Sampler::getNextLocalRow
std::vector< Real > getNextLocalRow()
Sampler::getLocalRowBegin
dof_id_type getLocalRowBegin() const
ActiveLearningReporterTempl::preNeedSample
virtual void preNeedSample()
Optional virtual function that is called before the sampler loop calling needSample.
Definition: ActiveLearningReporterBase.h:77
libMesh::ParallelObject::_communicator
const Parallel::Communicator & _communicator
Sampler::getNumberOfLocalRows
dof_id_type getNumberOfLocalRows() const
ActiveLearningReporterTempl::needSample
virtual bool needSample(const std::vector< Real > &, dof_id_type, dof_id_type, T &)
This routine is called during the sampler loop in execute() and is meant to fill in the "need_sample"...
Definition: ActiveLearningReporterBase.h:90
ActiveLearningReporterTempl::_data
std::vector< T > * _data
Reporter value declared with the transfer.
Definition: ActiveLearningReporterBase.h:107
ActiveLearningReporterTempl::_output_data_requested
bool _output_data_requested
Whether or not to gather global output data.
Definition: ActiveLearningReporterBase.h:112
GeneralReporter::gatherSum
void gatherSum(T &value)
ActiveLearningReporterTempl::_output_data
std::vector< T > _output_data
Global output data from sampler.
Definition: ActiveLearningReporterBase.h:116
ActiveLearningReporterTempl::_need_sample
std::vector< bool > & _need_sample
Reporter value determining whether we need to evaluate the sample through a multiapp or other means...
Definition: ActiveLearningReporterBase.h:105
ActiveLearningReporterTempl::_input_data_requested
bool _input_data_requested
Whether or not to gather global input data.
Definition: ActiveLearningReporterBase.h:110
Sampler::getLocalRowEnd
dof_id_type getLocalRowEnd() const
Sampler::getNumberOfRows
dof_id_type getNumberOfRows() const
ActiveLearningReporterTempl::_input_data
std::vector< std::vector< Real > > _input_data
Global input data from sampler.
Definition: ActiveLearningReporterBase.h:114
make_range
IntRange< T > make_range(T beg, T end)
GeneralReporter::mooseError
void mooseError(Args &&... args) const
ActiveLearningReporterTempl::_sampler
Sampler & _sampler
Sampler given in the parameters, must match the one used to declare the transferred values...
Definition: ActiveLearningReporterBase.h:100
Sampler::getNumberOfCols
dof_id_type getNumberOfCols() const
dof_id_type
uint8_t dof_id_type

◆ finalize()

virtual void StochasticReporter::finalize ( )
inlineoverridevirtualinherited

Implements GeneralReporter.

Reimplemented in MappingReporter, and EvaluateSurrogate.

Definition at line 114 of file StochasticReporter.h.

114 {}

◆ getGlobalInputData()

template<typename T>
const std::vector<std::vector<Real> >& ActiveLearningReporterTempl< T >::getGlobalInputData ( ) const
inlineprotected

Definition at line 59 of file ActiveLearningReporterBase.h.

60  {
61  _input_data_requested = true;
62  return _input_data;
63  }
ActiveLearningReporterTempl::_input_data_requested
bool _input_data_requested
Whether or not to gather global input data.
Definition: ActiveLearningReporterBase.h:110
ActiveLearningReporterTempl::_input_data
std::vector< std::vector< Real > > _input_data
Global input data from sampler.
Definition: ActiveLearningReporterBase.h:114

◆ getGlobalOutputData()

template<typename T>
const std::vector<T>& ActiveLearningReporterTempl< T >::getGlobalOutputData ( ) const
inlineprotected

Get a const reference to the output data.

Definition at line 68 of file ActiveLearningReporterBase.h.

69  {
70  _output_data_requested = true;
71  return _output_data;
72  }
ActiveLearningReporterTempl::_output_data_requested
bool _output_data_requested
Whether or not to gather global output data.
Definition: ActiveLearningReporterBase.h:112
ActiveLearningReporterTempl::_output_data
std::vector< T > _output_data
Global output data from sampler.
Definition: ActiveLearningReporterBase.h:116

◆ initialize()

virtual void StochasticReporter::initialize ( )
inlineoverridevirtualinherited

Implements GeneralReporter.

Reimplemented in MappingReporter, and EvaluateSurrogate.

Definition at line 112 of file StochasticReporter.h.

112 {}

◆ needSample()

template<typename T>
virtual bool ActiveLearningReporterTempl< T >::needSample ( const std::vector< Real > &  ,
dof_id_type  ,
dof_id_type  ,
T &   
)
inlineprotectedvirtual

This routine is called during the sampler loop in execute() and is meant to fill in the "need_sample" reporter value and modify the data declared by the transfer.

Parameters
rowThe row of data from the sampler
local_indThe local index of the sampler row
global_indThe global index of the sampler row
valReference to the value associated with the row of data.
Returns
Filled in value of "need_sample", meant to determine if a sample needs to be run by a multiapp or other means.

Reimplemented in ActiveLearningGPDecision, BiFidelityActiveLearningGPDecision, and ConditionalSampleReporterTempl< T >.

Definition at line 90 of file ActiveLearningReporterBase.h.

94  {
95  return true;
96  }

◆ preNeedSample()

template<typename T>
virtual void ActiveLearningReporterTempl< T >::preNeedSample ( )
inlineprotectedvirtual

Optional virtual function that is called before the sampler loop calling needSample.

Reimplemented in ActiveLearningGPDecision, and BiFidelityActiveLearningGPDecision.

Definition at line 77 of file ActiveLearningReporterBase.h.

77 {}

◆ sampler()

template<typename T>
const Sampler& ActiveLearningReporterTempl< T >::sampler ( ) const
inlineprotected

Get a const reference to the sampler from the parameters.

This is preferred over having _sampler being a protected member since we don't want derived classes changing the state of the sampler during the loop in execute.

Definition at line 57 of file ActiveLearningReporterBase.h.

57 { return _sampler; }
ActiveLearningReporterTempl::_sampler
Sampler & _sampler
Sampler given in the parameters, must match the one used to declare the transferred values...
Definition: ActiveLearningReporterBase.h:100

◆ validParams()

template<typename T >
InputParameters ActiveLearningReporterTempl< T >::validParams ( )
static

Definition at line 121 of file ActiveLearningReporterBase.h.

Referenced by ActiveLearningGPDecision::validParams(), and ConditionalSampleReporterTempl< T >::validParams().

122 {
123  InputParameters params = StochasticReporter::validParams();
124  params.addRequiredParam<SamplerName>("sampler", "The sampler used to produce data.");
125  return params;
126 }
StochasticReporter::validParams
static InputParameters validParams()
Definition: StochasticReporter.C:17
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)

Member Data Documentation

◆ _data

template<typename T>
std::vector<T>* ActiveLearningReporterTempl< T >::_data = nullptr
private

Reporter value declared with the transfer.

Definition at line 107 of file ActiveLearningReporterBase.h.

◆ _input_data

template<typename T>
std::vector<std::vector<Real> > ActiveLearningReporterTempl< T >::_input_data
private

Global input data from sampler.

Definition at line 114 of file ActiveLearningReporterBase.h.

Referenced by ActiveLearningReporterTempl< Real >::getGlobalInputData().

◆ _input_data_requested

template<typename T>
bool ActiveLearningReporterTempl< T >::_input_data_requested = false
mutableprivate

Whether or not to gather global input data.

Definition at line 110 of file ActiveLearningReporterBase.h.

Referenced by ActiveLearningReporterTempl< Real >::getGlobalInputData().

◆ _need_sample

template<typename T>
std::vector<bool>& ActiveLearningReporterTempl< T >::_need_sample
private

Reporter value determining whether we need to evaluate the sample through a multiapp or other means.

Definition at line 105 of file ActiveLearningReporterBase.h.

◆ _output_data

template<typename T>
std::vector<T> ActiveLearningReporterTempl< T >::_output_data
private

Global output data from sampler.

Definition at line 116 of file ActiveLearningReporterBase.h.

Referenced by ActiveLearningReporterTempl< Real >::getGlobalOutputData().

◆ _output_data_requested

template<typename T>
bool ActiveLearningReporterTempl< T >::_output_data_requested = false
mutableprivate

Whether or not to gather global output data.

Definition at line 112 of file ActiveLearningReporterBase.h.

Referenced by ActiveLearningReporterTempl< Real >::getGlobalOutputData().

◆ _sampler

template<typename T>
Sampler& ActiveLearningReporterTempl< T >::_sampler
protected

Sampler given in the parameters, must match the one used to declare the transferred values.

Definition at line 100 of file ActiveLearningReporterBase.h.

Referenced by ActiveLearningReporterTempl< Real >::sampler().

The documentation for this class was generated from the following file:
Generated on Fri Jul 18 2025 13:44:15 for https://mooseframework.inl.gov by   doxygen 1.8.14