This object is mainly meant for demonstration for eventual active learning algorithms, but could prove useful. More...

#include <ConditionalSampleReporter.h>

Inheritance diagram for ConditionalSampleReporterTempl< T >:

Public Types
typedef DataFileName	DataFileParameterType

typedef GenericSymFunction< is_ad >	SymFunction

typedef std::shared_ptr< SymFunction >	SymFunctionPtr

Public Member Functions
	ConditionalSampleReporterTempl (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

void	setParserFeatureFlags (SymFunctionPtr &) 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 Types
enum	FailureMethod

Protected Member Functions
virtual bool	needSample (const std::vector< Real > &row, dof_id_type local_ind, dof_id_type global_ind, T &val) override
	This evaluates the inputted function to determine whether a multiapp solve is necessary/allowed, otherwise it replaces the "transferred" quantity with a default value. More...

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...

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)

GenericReal< is_ad >	evaluate (SymFunctionPtr &, const std::string &object_name="")

GenericReal< is_ad >	evaluate (SymFunctionPtr &, const std::vector< GenericReal< is_ad >> &, const std::string &object_name="")

void	addFParserConstants (SymFunctionPtr &parser, const std::vector< std::string > &constant_names, const std::vector< std::string > &constant_expressions) const

virtual void	functionsOptimize (SymFunctionPtr &parsed_function)

void	functionsOptimize (SymFunctionPtr &parsed_function)

void	functionsOptimize (SymFunctionPtr &parsed_function)

void	parsedFunctionSetup (SymFunctionPtr &function, const std::string &expression, const std::string &variables, const std::vector< std::string > &constant_names, const std::vector< std::string > &constant_expressions, const libMesh::Parallel::Communicator &comm) const

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

enum FunctionParserUtils::FailureMethod	_evalerror_behavior

const Real	_quiet_nan

std::vector< GenericReal< is_ad > >	_func_params

const Real	_epsilon

bool	_enable_jit

bool	_enable_ad_cache

bool	_disable_fpoptimizer

bool	_enable_auto_optimize

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

static const char *	_eval_error_msg []

Private Attributes
const std::string &	_function
	User-inputted function string. More...

const T &	_default_value
	User-inputted default value. More...

const std::vector< std::pair< std::string, unsigned int > >	_sampler_vars
	Pairs between the variables in the function string and their associated sampler column index. More...

const bool	_use_time
	Whether or not the function string includes a time variable. More...

SymFunctionPtr	_func_F
	Parsed function pointer. More...

Detailed Description

template<typename T>
class ConditionalSampleReporterTempl< T >

This object is mainly meant for demonstration for eventual active learning algorithms, but could prove useful.

Basically, it enables a inputted function to determine if a multiapp solve is "possible". For instance, maybe a certain sampled value needs to be possitive, this class can filter those samples out and replace quantities of interest with a default value.

Definition at line 17 of file ConditionalSampleReporter.h.

Constructor & Destructor Documentation

◆ ConditionalSampleReporterTempl()

template<typename T >

ConditionalSampleReporterTempl< T >::ConditionalSampleReporterTempl ( const InputParameters & parameters )

Definition at line 41 of file ConditionalSampleReporter.C.

   : ActiveLearningReporterTempl<T>(parameters),
     FunctionParserUtils<false>(parameters),
     _function(this->template getParam<std::string>("function")),
     _default_value(this->template getParam<T>("default_value")),
     _sampler_vars(
         this->template getParam<std::string, unsigned int>("sampler_vars", "sampler_var_indices")),
     _use_time(this->template getParam<bool>("use_time"))
 {
   // Gather variables and see if any of the indexes are out-of-bounds
   std::stringstream vars;
   std::string sep = "";
   for (const auto & it : _sampler_vars)
   {
     vars << sep << it.first;
     if (it.second >= this->sampler().getNumberOfCols())
       this->paramError("sampler_var_indices",
                        "Provided index ",
                        it.second,
                        " must be smaller than the sampler number of columns (",
                        this->sampler().getNumberOfCols(),
                        ").");
     sep = ",";
   }
   if (_use_time)
     vars << sep << "t";
 
   // Parse the inputted function
   _func_F = std::make_shared<SymFunction>();
   setParserFeatureFlags(_func_F);
   if (_func_F->Parse(_function, vars.str()) >= 0)
     this->paramError("function", "Invalid function:\n", _function, "\n", _func_F->ErrorMsg());
   if (!_disable_fpoptimizer)
     _func_F->Optimize();
 
   if (_enable_jit)
   {
     // let rank 0 do the JIT compilation first
     if (this->_communicator.rank() != 0)
       this->_communicator.barrier();
 
     _func_F->JITCompile();
 
     // wait for ranks > 0 to catch up
     if (this->_communicator.rank() == 0)
       this->_communicator.barrier();
   }
 
   _func_params.resize(_sampler_vars.size() + (_use_time ? 1 : 0));
 }

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().

 {
   const ReporterMode mode =
       this->_parallel_type == 0 ? REPORTER_MODE_DISTRIBUTED : REPORTER_MODE_ROOT;
   return this->template declareValueByName<std::vector<T>, StochasticReporterContext<T>>(
       value_name, mode, sampler);
 }

◆ declareStochasticReporterClone()

template<typename T >

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

overrideprotectedvirtualinherited

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.

 {
   // Only one value is allowed to be declared
   if (_data)
     this->mooseError(type(), " can only declare a single reporter value.");
   // Make sure the inputted sampler is the same one in the parameters
   else if (sampler.name() != _sampler.name())
     this->paramError("sampler",
                      "Inputted sampler, ",
                      _sampler.name(),
                      ", is not the same as the one producing data, ",
                      sampler.name(),
                      ".");
   // Make sure reporter value exists
   else if (!from_data.hasReporterValue(from_reporter))
     this->mooseError("Reporter value ", from_reporter, " has not been declared.");
   // Make sure the reporter value is the right type
   else if (!from_data.hasReporterValue<T>(from_reporter))
     this->mooseError(
         type(), " can only use reporter values of type ", MooseUtils::prettyCppType<T>(), ".");
 
   std::string value_name = (prefix.empty() ? "" : prefix + ":") + from_reporter.getObjectName() +
                            ":" + from_reporter.getValueName();
   _data = &this->declareStochasticReporter<T>(value_name, sampler);
   return {name(), value_name};
 }

◆ execute()

template<typename T >

void ActiveLearningReporterTempl< T >::execute ( )

overridevirtualinherited

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.

 {
   // If requesting global data, fill it in
   if (_input_data_requested)
   {
     // Gather inputs for the current step
     _input_data.assign(_sampler.getNumberOfRows(),
                        std::vector<Real>(_sampler.getNumberOfCols(), 0.0));
     for (dof_id_type i = _sampler.getLocalRowBegin(); i < _sampler.getLocalRowEnd(); ++i)
       _input_data[i] = _sampler.getNextLocalRow();
     for (auto & inp : _input_data)
       gatherSum(inp);
   }
   if (_output_data_requested)
   {
     if (!_data)
       mooseError("Output data has been requested, but none was declared in this object.");
     _output_data = *_data;
     _communicator.allgather(_output_data);
   }
 
   // Optional call for before sampler loop
   preNeedSample();
 
   // Dummy value in case _data has not been declared yet
   T dummy;
   // Loop over samples to determine if sample is needed. Replace value in _data
   // (typically only if a sample is not needed). We insert a dummy value in case
   // _data has not been declared.
   for (const auto & i : make_range(_sampler.getNumberOfLocalRows()))
     _need_sample[i] = needSample(_sampler.getNextLocalRow(),
                                  i,
                                  i + _sampler.getLocalRowBegin(),
                                  (_data ? (*_data)[i] : dummy));
 }

◆ 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

inlineprotectedinherited

Definition at line 59 of file ActiveLearningReporterBase.h.

   {
     _input_data_requested = true;
     return _input_data;
   }

◆ getGlobalOutputData()

template<typename T>

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

inlineprotectedinherited

Get a const reference to the output data.

Definition at line 68 of file ActiveLearningReporterBase.h.

   {
     _output_data_requested = true;
     return _output_data;
   }

◆ 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 >

bool ConditionalSampleReporterTempl< T >::needSample	(	const std::vector< Real > &	row,
		dof_id_type	local_ind,
		dof_id_type	global_ind,
		T &	val
	)

overrideprotectedvirtual

This evaluates the inputted function to determine whether a multiapp solve is necessary/allowed, otherwise it replaces the "transferred" quantity with a default value.

Reimplemented from ActiveLearningReporterTempl< T >.

Definition at line 95 of file ConditionalSampleReporter.C.

 {
   // Input sampler values
   for (const auto & p : index_range(_sampler_vars))
     _func_params[p] = row[_sampler_vars[p].second];
   // Input time
   if (_use_time)
     _func_params[_sampler_vars.size()] = this->_t;
 
   // If the function is not zero, then a sample is needed
   if (evaluate(_func_F))
     return true;
   // Otherwise we will set the quantitiy of interest to the default value
   else
   {
     val = _default_value;
     return false;
   }
 }

◆ preNeedSample()

template<typename T>

virtual void ActiveLearningReporterTempl< T >::preNeedSample ( )

inlineprotectedvirtualinherited

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

inlineprotectedinherited

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 ConditionalSampleReporterTempl< T >::validParams ( )

static

Definition at line 16 of file ConditionalSampleReporter.C.

 {
   InputParameters params = ActiveLearningReporterTempl<T>::validParams();
   params += FunctionParserUtils<false>::validParams();
   params.addClassDescription("Evaluates parsed function to determine if sample needs to be "
                              "evaluated, otherwise data is set to a default value.");
 
   params.addRequiredCustomTypeParam<std::string>(
       "function",
       "FunctionExpression",
       "function expression that should evaluate to 0 if sample should NOT be evaluated.");
   params.addRequiredParam<T>("default_value",
                              "Value to replace in data when sample is not evaluated.");
   params.addParam<std::vector<std::string>>(
       "sampler_vars", std::vector<std::string>(), "Vector of variables defined by sampler values.");
   params.addParam<std::vector<unsigned int>>("sampler_var_indices",
                                              std::vector<unsigned int>(),
                                              "Vector of indices defining the sampler column index "
                                              "associated with the variables in 'sampler_vars'.");
   params.addParam<bool>(
       "use_time", true, "Make time (t) variable available in the function expression.");
   return params;
 }

The documentation for this class was generated from the following files:

stochastic_tools/include/reporters/ConditionalSampleReporter.h
stochastic_tools/src/reporters/ConditionalSampleReporter.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

template<typename T> class ConditionalSampleReporterTempl< T >

Constructor & Destructor Documentation

◆ ConditionalSampleReporterTempl()

Member Function Documentation

◆ declareStochasticReporter()

◆ declareStochasticReporterClone()

◆ execute()

◆ finalize()

◆ getGlobalInputData()

◆ getGlobalOutputData()

◆ initialize()

◆ needSample()

◆ preNeedSample()

◆ sampler()

◆ validParams()

Member Data Documentation

◆ _default_value

◆ _func_F

◆ _function

◆ _sampler

◆ _sampler_vars

◆ _use_time

template<typename T>
class ConditionalSampleReporterTempl< T >