A generic reporter to support parallel active learning: re-trains GP and picks the next best batch. More...

#include <GenericActiveLearner.h>

Inheritance diagram for GenericActiveLearnerTempl< SamplerType >:

Public Types
typedef DataFileName	DataFileParameterType

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

template<>
SurrogateModel &	getSurrogateModel (const std::string &name) const

template<>
SurrogateTrainerBase &	getSurrogateTrainer (const std::string &name) const

template<>
SurrogateModel &	getSurrogateModelByName (const UserObjectName &name) const

template<>
SurrogateTrainerBase &	getSurrogateTrainerByName (const UserObjectName &name) const


template<typename T = SurrogateModel>
T &	getSurrogateModel (const std::string &name) const
	Get a SurrogateModel/Trainer with a given name.

template<typename T = SurrogateTrainerBase>
T &	getSurrogateTrainer (const std::string &name) const


template<typename T = SurrogateModel>
T &	getSurrogateModelByName (const UserObjectName &name) const
	Get a sampler with a given name.

template<typename T = SurrogateTrainerBase>
T &	getSurrogateTrainerByName (const UserObjectName &name) 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	setupGPData (const std::vector< Real > &data_out, const DenseMatrix< Real > &data_in)
	Sets up the training data for the GP model.

virtual void	computeGPOutput (std::vector< Real > &eval_outputs)
	Computes the outputs of the trained GP model.

virtual Real	computeConvergenceValue ()
	Computes the convergence value during active learning.

virtual void	evaluateGPTest ()
	Evaluate the GP on all the test samples sent by the Sampler.

virtual void	setupGeneric ()
	Setup the generic variable for acquisition computation (depends on the objective: optimization, UQ, etc.)

virtual void	includeAdditionalInputs ()
	Include additional inputs before evaluating the acquisition function.

virtual void	getAcquisition (std::vector< Real > &acq_new, std::vector< unsigned int > &indices)
	Output the acquisition function values and ordering of the indices.

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, 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)

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)

ParallelAcquisitionFunctionBase &	getParallelAcquisitionFunctionByName (const UserObjectName &name) const
	Lookup a ParallelAcquisitionFunction object by name and return pointer.

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
SamplerType &	_al_sampler
	The base sampler.

unsigned int	_n_dim
	The input dimension for GP, equal to Sampler columns.

dof_id_type	_props
	Storage for the number of parallel proposals.

const std::vector< std::vector< Real > > &	_inputs_test
	Storage for all the proposed samples to test the GP model.

const std::vector< Real > &	_output_value
	Model output value from SubApp.

std::vector< Real > &	_output_comm
	Modified value of model output by this reporter class.

std::vector< unsigned int > &	_sorted_indices
	The selected sample indices to evaluate the subApp.

const ActiveLearningGaussianProcess &	_al_gp
	The active learning GP trainer that permits re-training.

const SurrogateModel &	_gp_eval
	The GP evaluator object that permits re-evaluations.

ParallelAcquisitionFunctionBase &	_acquisition_obj
	Storage for the parallel acquisition object to be utilized.

std::vector< Real > &	_acquisition_value
	The acquistion function values in the current iteration.

Real &	_convergence_value
	For monitoring convergence of active learning.

std::vector< std::vector< Real > >	_inputs_test_modified
	Storage for all the modified proposed samples to test the GP model.

std::vector< std::vector< Real > > &	_inputs_required
	Transmit the required inputs to the json file.

const bool &	_penalize_acquisition
	Penalize acquisition to prevent clustering when operating in parallel.

int	_check_step
	Ensure that the MCMC algorithm proceeds in a sequential fashion.

std::vector< std::vector< Real > >	_gp_inputs
	Storage for the GP re-training inputs.

std::vector< Real >	_gp_outputs
	Storage for the GP re-training outputs.

std::vector< Real >	_gp_outputs_test
	Outputs of GP model for the test samples.

std::vector< Real >	_gp_std_test
	Outputs of GP model standard deviation for the test samples.

std::vector< Real >	_length_scales
	Storage for the length scales after the GP training.

std::vector< Real >	_generic
	A generic parameter to be passed to the acquisition function.

std::vector< Real >	_eval_outputs_current
	The GP outputs from the current iteration before re-training (to evaluate convergence)

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

FEProblemBase &	_parallelacquisition_feproblem
	Reference to FEProblemBase instance.

const InputParameters &	_smi_params
	Parameters of the object with this interface.

FEProblemBase &	_smi_feproblem
	Reference to FEProblemBase instance.

const THREAD_ID	_smi_tid
	Thread ID.

Detailed Description

template<typename SamplerType>
class GenericActiveLearnerTempl< SamplerType >

A generic reporter to support parallel active learning: re-trains GP and picks the next best batch.

Definition at line 34 of file GenericActiveLearner.h.

Constructor & Destructor Documentation

◆ GenericActiveLearnerTempl()

template<typename SamplerType >

GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl ( const InputParameters & parameters )

Definition at line 198 of file GenericActiveLearner.h.

  : GeneralReporter(parameters),
    ParallelAcquisitionInterface(parameters),
    SurrogateModelInterface(this),
    _al_sampler(getSampler<SamplerType>("sampler")),
    _n_dim(_al_sampler.getNumberOfCols()),
    _props(_al_sampler.getNumParallelProposals()),
    _inputs_test(_al_sampler.getSampleTries()),
    _output_value(getReporterValue<std::vector<Real>>("output_value", REPORTER_MODE_DISTRIBUTED)),
    _output_comm(declareValue<std::vector<Real>>("outputs_required")),
    _sorted_indices(declareValue<std::vector<unsigned int>>("sorted_indices")),
    _al_gp(getUserObject<ActiveLearningGaussianProcess>("al_gp")),
    _gp_eval(getSurrogateModel<GaussianProcessSurrogate>("gp_evaluator")),
    _acquisition_obj(getParallelAcquisitionFunctionByName(getParam<UserObjectName>("acquisition"))),
    _acquisition_value(declareValue<std::vector<Real>>("acquisition_function")),
    _convergence_value(declareValue<Real>("convergence_value")),
    _inputs_required(declareValue<std::vector<std::vector<Real>>>("inputs")),
    _penalize_acquisition(getParam<bool>("penalize_acquisition")),
    _check_step(std::numeric_limits<int>::max())
{
  // Setting up the variable sizes to facilitate active learning.
  _gp_outputs_test.resize(_inputs_test.size());
  _gp_std_test.resize(_inputs_test.size());
  _acquisition_value.resize(_props);
  _length_scales.resize(_n_dim);
  _eval_outputs_current.resize(_props);
  _generic.resize(1);
  _inputs_required.resize(_props, std::vector<Real>(_n_dim, 0.0));
  _sorted_indices.resize(_props, 1u);
}

Member Function Documentation

◆ computeConvergenceValue()

template<typename SamplerType >

Real GenericActiveLearnerTempl< SamplerType >::computeConvergenceValue ( )

protectedvirtual

Computes the convergence value during active learning.

Reimplemented in BayesianActiveLearner.

Definition at line 284 of file GenericActiveLearner.h.

{
  Real convergence_value = 0.0;
  for (unsigned int ii = 0; ii < _output_comm.size(); ++ii)
    convergence_value += Utility::pow<2>(_output_comm[ii] - _eval_outputs_current[ii]);
  convergence_value = std::sqrt(convergence_value) / _output_comm.size();
  return convergence_value;
}

◆ computeGPOutput()

template<typename SamplerType >

void GenericActiveLearnerTempl< SamplerType >::computeGPOutput ( std::vector< Real > & eval_outputs )

protectedvirtual

Computes the outputs of the trained GP model.

Parameters

eval_outputs The outputs predicted by the GP model

Definition at line 246 of file GenericActiveLearner.h.

{
  for (unsigned int i = 0; i < eval_outputs.size(); ++i)
    eval_outputs[i] = _gp_eval.evaluate(_gp_inputs[i]);
}

◆ evaluateGPTest()

template<typename SamplerType >

void GenericActiveLearnerTempl< SamplerType >::evaluateGPTest ( )

protectedvirtual

Evaluate the GP on all the test samples sent by the Sampler.

Reimplemented in BayesianActiveLearner.

Definition at line 295 of file GenericActiveLearner.h.

{
  for (unsigned int i = 0; i < _gp_outputs_test.size(); ++i)
    _gp_outputs_test[i] = _gp_eval.evaluate(_inputs_test[i], _gp_std_test[i]);
}

◆ execute()

template<typename SamplerType >

void GenericActiveLearnerTempl< SamplerType >::execute ( )

overridevirtual

Implements GeneralReporter.

Definition at line 303 of file GenericActiveLearner.h.

{
  if (_al_sampler.getNumberOfLocalRows() == 0 || _check_step == _t_step)
  {
    _check_step = _t_step;
    return;
  }
 
  DenseMatrix<Real> data_in(_al_sampler.getNumberOfRows(), _al_sampler.getNumberOfCols());
  for (dof_id_type ss = _al_sampler.getLocalRowBegin(); ss < _al_sampler.getLocalRowEnd(); ++ss)
  {
    const auto data = _al_sampler.getNextLocalRow();
    for (unsigned int j = 0; j < _al_sampler.getNumberOfCols(); ++j)
      data_in(ss, j) = data[j];
  }
  _communicator.sum(data_in.get_values());
  _output_comm = _output_value;
  _communicator.allgather(_output_comm);
 
  if (_t_step > 1)
  {
    // Setup the GP training data
    setupGPData(_output_comm, data_in);
 
    // Compute the convergence value before re-training the GP
    if (_t_step > 2)
    {
      computeGPOutput(_eval_outputs_current);
      _convergence_value = computeConvergenceValue();
    }
 
    // Retrain the GP and get the length scales
    _al_gp.reTrain(_gp_inputs, _gp_outputs);
    _length_scales = _al_gp.getLengthScales();
 
    // Evaluate the GP on all the test samples sent by the Sampler
    evaluateGPTest();
 
    // Setup the generic variable for acquisition computation (depends on the objective:
    // optimization, UQ, etc.)
    setupGeneric();
 
    // Get the acquisition function values and ordering of indices as per the acquisition
    std::vector<Real> acq_new;
    std::vector<unsigned int> indices;
    indices.resize(_inputs_test.size());
    getAcquisition(acq_new, indices);
 
    // Output the acquisition function values and the best ordering of the indices
    std::copy_n(indices.begin(), _props, _sorted_indices.begin());
    std::copy_n(acq_new.begin(), _props, _acquisition_value.begin());
  }
  else
    std::iota(_sorted_indices.begin(), _sorted_indices.end(), 0);
 
  // Track the current step
  _check_step = _t_step;
}

◆ finalize()

template<typename SamplerType >

virtual void GenericActiveLearnerTempl< SamplerType >::finalize ( )

inlineoverridevirtual

Implements GeneralReporter.

Definition at line 43 of file GenericActiveLearner.h.

43{}

◆ getAcquisition()

template<typename SamplerType >

void GenericActiveLearnerTempl< SamplerType >::getAcquisition	(	std::vector< Real > &	acq_new,
		std::vector< unsigned int > &	indices
	)

protectedvirtual

Output the acquisition function values and ordering of the indices.

Parameters

acq_new	The computed values of the acquisition function
indices	The indices ordered according to the acqusition values to be sent to Sampler

Definition at line 268 of file GenericActiveLearner.h.

{
  std::vector<Real> acq;
  acq.resize(_inputs_test.size());
  includeAdditionalInputs();
  _acquisition_obj.computeAcquisition(
      acq, _gp_outputs_test, _gp_std_test, _inputs_test_modified, _gp_inputs, _generic);
  acq_new = acq;
  if (_penalize_acquisition)
    _acquisition_obj.penalizeAcquisition(
        acq_new, indices, acq, _length_scales, _inputs_test_modified);
}

◆ getParallelAcquisitionFunctionByName()

ParallelAcquisitionFunctionBase & ParallelAcquisitionInterface::getParallelAcquisitionFunctionByName ( const UserObjectName & name ) const

protectedinherited

Lookup a ParallelAcquisitionFunction object by name and return pointer.

Definition at line 24 of file ParallelAcquisitionInterface.C.

{
  std::vector<ParallelAcquisitionFunctionBase *> models;
  _parallelacquisition_feproblem.theWarehouse()
      .query()
      .condition<AttribName>(name)
      .condition<AttribSystem>("ParallelAcquisitionFunctionBase")
      .queryInto(models);
 
  if (models.empty())
    mooseError("Unable to find a ParallelAcquisitionFunction object with the name '" + name + "'");
 
  return *models.front();
}

◆ getSurrogateModel() [1/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateModel ( const std::string & name ) const

inherited

Get a SurrogateModel/Trainer with a given name.

Parameters

name	The name of the parameter key of the sampler to retrieve

Returns: The sampler with name associated with the parameter 'name'

Definition at line 81 of file SurrogateModelInterface.h.

{
  return getSurrogateModelByName<T>(_smi_params.get<UserObjectName>(name));
}

Referenced by SurrogateTrainer::initialize().

◆ getSurrogateModel() [2/2]

template<>

SurrogateModel & SurrogateModelInterface::getSurrogateModel ( const std::string & name ) const

inherited

Definition at line 46 of file SurrogateModelInterface.C.

{
  return getSurrogateModelByName<SurrogateModel>(_smi_params.get<UserObjectName>(name));
}

◆ getSurrogateModelByName() [1/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateModelByName ( const UserObjectName & name ) const

inherited

Get a sampler with a given name.

Parameters

name	The name of the sampler to retrieve

Returns: The sampler with name 'name'

Definition at line 88 of file SurrogateModelInterface.h.

{
  std::vector<T *> models;
  _smi_feproblem.theWarehouse()
      .query()
      .condition<AttribName>(name)
      .condition<AttribSystem>("SurrogateModel")
      .queryInto(models);
  if (models.empty())
    mooseError("Unable to find a SurrogateModel object of type " + std::string(typeid(T).name()) +
               " with the name '" + name + "'");
  return *(models[0]);
}

Referenced by CrossValidationScores::CrossValidationScores(), EvaluateSurrogate::EvaluateSurrogate(), and InverseMapping::initialSetup().

◆ getSurrogateModelByName() [2/2]

template<>

SurrogateModel & SurrogateModelInterface::getSurrogateModelByName ( const UserObjectName & name ) const

inherited

Definition at line 31 of file SurrogateModelInterface.C.

{
  std::vector<SurrogateModel *> models;
  _smi_feproblem.theWarehouse()
      .query()
      .condition<AttribName>(name)
      .condition<AttribSystem>("SurrogateModel")
      .queryInto(models);
  if (models.empty())
    mooseError("Unable to find a SurrogateModel object with the name '" + name + "'");
  return *(models[0]);
}

◆ getSurrogateTrainer() [1/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateTrainer ( const std::string & name ) const

inherited

Definition at line 104 of file SurrogateModelInterface.h.

{
  return getSurrogateTrainerByName<T>(_smi_params.get<UserObjectName>(name));
}

◆ getSurrogateTrainer() [2/2]

template<>

SurrogateTrainerBase & SurrogateModelInterface::getSurrogateTrainer ( const std::string & name ) const

inherited

Definition at line 60 of file SurrogateModelInterface.C.

{
  return getSurrogateTrainerByName<SurrogateTrainerBase>(_smi_params.get<UserObjectName>(name));
}

◆ getSurrogateTrainerByName() [1/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateTrainerByName ( const UserObjectName & name ) const

inherited

Definition at line 111 of file SurrogateModelInterface.h.

{
  SurrogateTrainerBase * base_ptr =
      &_smi_feproblem.getUserObject<SurrogateTrainerBase>(name, _smi_tid);
  T * obj_ptr = dynamic_cast<T *>(base_ptr);
  if (!obj_ptr)
    mooseError("Failed to find a SurrogateTrainer object of type " + std::string(typeid(T).name()) +
                   " with the name '",
               name,
               "' for the desired type.");
  return *obj_ptr;
}

Referenced by SurrogateTrainerOutput::output().

◆ getSurrogateTrainerByName() [2/2]

template<>

SurrogateTrainerBase & SurrogateModelInterface::getSurrogateTrainerByName ( const UserObjectName & name ) const

inherited

Definition at line 53 of file SurrogateModelInterface.C.

{
  return _smi_feproblem.getUserObject<SurrogateTrainerBase>(name);
}

◆ includeAdditionalInputs()

template<typename SamplerType >

void GenericActiveLearnerTempl< SamplerType >::includeAdditionalInputs ( )

protectedvirtual

Include additional inputs before evaluating the acquisition function.

Has trivial function in base, but can be modified in derived if necessary depending upon the objective of active learning (i.e., forward UQ, inverse UQ, optimization, etc.)

Reimplemented in BayesianActiveLearner.

Definition at line 261 of file GenericActiveLearner.h.

{
  _inputs_test_modified = _inputs_test;
}

◆ initialize()

template<typename SamplerType >

virtual void GenericActiveLearnerTempl< SamplerType >::initialize ( )

inlineoverridevirtual

Implements GeneralReporter.

Definition at line 42 of file GenericActiveLearner.h.

42{}

◆ setupGeneric()

template<typename SamplerType >

void GenericActiveLearnerTempl< SamplerType >::setupGeneric ( )

protectedvirtual

Setup the generic variable for acquisition computation (depends on the objective: optimization, UQ, etc.)

Definition at line 254 of file GenericActiveLearner.h.

{
  _generic = _gp_outputs;
}

◆ setupGPData()

template<typename SamplerType >

void GenericActiveLearnerTempl< SamplerType >::setupGPData	(	const std::vector< Real > &	data_out,
		const DenseMatrix< Real > &	data_in
	)

protectedvirtual

Sets up the training data for the GP model.

Parameters

data_out	The data vector containing the outputs to train the GP
data_in	The data matrix containing the inputs to train the GP

Reimplemented in BayesianActiveLearner.

Definition at line 232 of file GenericActiveLearner.h.

{
  for (unsigned int i = 0; i < data_out.size(); ++i)
  {
    for (unsigned int j = 0; j < _n_dim; ++j)
      _inputs_required[i][j] = data_in(i, j);
    _gp_inputs.push_back(_inputs_required[i]);
    _gp_outputs.push_back(data_out[i]);
  }
}

◆ validParams()

template<typename SamplerType >

InputParameters GenericActiveLearnerTempl< SamplerType >::validParams ( )

static

Definition at line 162 of file GenericActiveLearner.h.

{
  InputParameters params = GeneralReporter::validParams();
  params += ParallelAcquisitionInterface::validParams();
  params.addClassDescription("A generic reporter to support parallel active learning: re-trains GP "
                             "and picks the next best batch.");
  params.addRequiredParam<ReporterName>("output_value",
                                        "Value of the model output from the SubApp.");
  params.addParam<ReporterValueName>(
      "outputs_required",
      "outputs_required",
      "Modified value of the model output from this reporter class.");
  params.addRequiredParam<SamplerName>("sampler", "The sampler object.");
  params.addRequiredParam<UserObjectName>("al_gp", "Active learning GP trainer.");
  params.addRequiredParam<UserObjectName>("gp_evaluator", "Evaluator for the trained GP.");
  params.addParam<ReporterValueName>(
      "sorted_indices",
      "sorted_indices",
      "The sorted sample indices in order of importance to evaluate the subApp.");
  params.addParam<ReporterValueName>(
      "acquisition_function",
      "acquisition_function",
      "The values of the acquistion function in the current iteration.");
  params.addParam<ReporterValueName>(
      "convergence_value", "convergence_value", "Value to measure convergence of active learning.");
  params.addParam<ReporterValueName>(
      "inputs", "inputs", "Modified value of the model inputs from this reporter class.");
  params.addRequiredParam<UserObjectName>("acquisition", "Name of the acquisition function.");
  params.addParam<bool>(
      "penalize_acquisition",
      true,
      "Set true to prevent clustering of the best batch inputs when operating in parallel.");
  return params;
}

Referenced by BayesianActiveLearner::validParams().

Member Data Documentation

◆ _acquisition_obj

template<typename SamplerType >

ParallelAcquisitionFunctionBase& GenericActiveLearnerTempl< SamplerType >::_acquisition_obj

protected

Storage for the parallel acquisition object to be utilized.

Definition at line 118 of file GenericActiveLearner.h.

◆ _acquisition_value

template<typename SamplerType >

std::vector<Real>& GenericActiveLearnerTempl< SamplerType >::_acquisition_value

protected

The acquistion function values in the current iteration.

Definition at line 121 of file GenericActiveLearner.h.

Referenced by GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl().

◆ _al_gp

template<typename SamplerType >

const ActiveLearningGaussianProcess& GenericActiveLearnerTempl< SamplerType >::_al_gp

protected

The active learning GP trainer that permits re-training.

Definition at line 112 of file GenericActiveLearner.h.

◆ _al_sampler

template<typename SamplerType >

SamplerType& GenericActiveLearnerTempl< SamplerType >::_al_sampler

protected

The base sampler.

Definition at line 91 of file GenericActiveLearner.h.

◆ _check_step

template<typename SamplerType >

int GenericActiveLearnerTempl< SamplerType >::_check_step

protected

Ensure that the MCMC algorithm proceeds in a sequential fashion.

Definition at line 136 of file GenericActiveLearner.h.

◆ _convergence_value

template<typename SamplerType >

Real& GenericActiveLearnerTempl< SamplerType >::_convergence_value

protected

For monitoring convergence of active learning.

Definition at line 124 of file GenericActiveLearner.h.

◆ _eval_outputs_current

template<typename SamplerType >

std::vector<Real> GenericActiveLearnerTempl< SamplerType >::_eval_outputs_current

protected

The GP outputs from the current iteration before re-training (to evaluate convergence)

Definition at line 157 of file GenericActiveLearner.h.

Referenced by GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl().

◆ _generic

template<typename SamplerType >

std::vector<Real> GenericActiveLearnerTempl< SamplerType >::_generic

protected

A generic parameter to be passed to the acquisition function.

Definition at line 154 of file GenericActiveLearner.h.

Referenced by GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl().

◆ _gp_eval

template<typename SamplerType >

const SurrogateModel& GenericActiveLearnerTempl< SamplerType >::_gp_eval

protected

The GP evaluator object that permits re-evaluations.

Definition at line 115 of file GenericActiveLearner.h.

◆ _gp_inputs

template<typename SamplerType >

std::vector<std::vector<Real> > GenericActiveLearnerTempl< SamplerType >::_gp_inputs

protected

Storage for the GP re-training inputs.

Definition at line 139 of file GenericActiveLearner.h.

◆ _gp_outputs

template<typename SamplerType >

std::vector<Real> GenericActiveLearnerTempl< SamplerType >::_gp_outputs

protected

Storage for the GP re-training outputs.

Definition at line 142 of file GenericActiveLearner.h.

◆ _gp_outputs_test

template<typename SamplerType >

std::vector<Real> GenericActiveLearnerTempl< SamplerType >::_gp_outputs_test

protected

Outputs of GP model for the test samples.

Definition at line 145 of file GenericActiveLearner.h.

Referenced by GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl().

◆ _gp_std_test

template<typename SamplerType >

std::vector<Real> GenericActiveLearnerTempl< SamplerType >::_gp_std_test

protected

Outputs of GP model standard deviation for the test samples.

Definition at line 148 of file GenericActiveLearner.h.

Referenced by GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl().

◆ _inputs_required

template<typename SamplerType >

std::vector<std::vector<Real> >& GenericActiveLearnerTempl< SamplerType >::_inputs_required

protected

Transmit the required inputs to the json file.

Definition at line 130 of file GenericActiveLearner.h.

Referenced by GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl().

◆ _inputs_test

template<typename SamplerType >

const std::vector<std::vector<Real> >& GenericActiveLearnerTempl< SamplerType >::_inputs_test

protected

Storage for all the proposed samples to test the GP model.

Definition at line 100 of file GenericActiveLearner.h.

Referenced by GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl().

◆ _inputs_test_modified

template<typename SamplerType >

std::vector<std::vector<Real> > GenericActiveLearnerTempl< SamplerType >::_inputs_test_modified

protected

Storage for all the modified proposed samples to test the GP model.

Definition at line 127 of file GenericActiveLearner.h.

◆ _length_scales

template<typename SamplerType >

std::vector<Real> GenericActiveLearnerTempl< SamplerType >::_length_scales

protected

Storage for the length scales after the GP training.

Definition at line 151 of file GenericActiveLearner.h.

Referenced by GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl().

◆ _n_dim

template<typename SamplerType >

unsigned int GenericActiveLearnerTempl< SamplerType >::_n_dim

protected

The input dimension for GP, equal to Sampler columns.

Definition at line 94 of file GenericActiveLearner.h.

Referenced by GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl().

◆ _output_comm

template<typename SamplerType >

std::vector<Real>& GenericActiveLearnerTempl< SamplerType >::_output_comm

protected

Modified value of model output by this reporter class.

Definition at line 106 of file GenericActiveLearner.h.

◆ _output_value

template<typename SamplerType >

const std::vector<Real>& GenericActiveLearnerTempl< SamplerType >::_output_value

protected

Model output value from SubApp.

Definition at line 103 of file GenericActiveLearner.h.

◆ _parallelacquisition_feproblem

FEProblemBase& ParallelAcquisitionInterface::_parallelacquisition_feproblem

privateinherited

Reference to FEProblemBase instance.

Definition at line 30 of file ParallelAcquisitionInterface.h.

Referenced by ParallelAcquisitionInterface::getParallelAcquisitionFunctionByName().

◆ _penalize_acquisition

template<typename SamplerType >

const bool& GenericActiveLearnerTempl< SamplerType >::_penalize_acquisition

protected

Penalize acquisition to prevent clustering when operating in parallel.

Definition at line 133 of file GenericActiveLearner.h.

◆ _props

template<typename SamplerType >

dof_id_type GenericActiveLearnerTempl< SamplerType >::_props

protected

Storage for the number of parallel proposals.

Definition at line 97 of file GenericActiveLearner.h.

Referenced by GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl().

◆ _smi_feproblem

FEProblemBase& SurrogateModelInterface::_smi_feproblem

privateinherited

Reference to FEProblemBase instance.

Definition at line 73 of file SurrogateModelInterface.h.

Referenced by SurrogateModelInterface::getSurrogateModelByName(), and SurrogateModelInterface::getSurrogateTrainerByName().

◆ _smi_params

const InputParameters& SurrogateModelInterface::_smi_params

privateinherited

Parameters of the object with this interface.

Definition at line 70 of file SurrogateModelInterface.h.

Referenced by SurrogateModelInterface::getSurrogateModel(), and SurrogateModelInterface::getSurrogateTrainer().

◆ _smi_tid

const THREAD_ID SurrogateModelInterface::_smi_tid

privateinherited

Thread ID.

Definition at line 76 of file SurrogateModelInterface.h.

Referenced by SurrogateModelInterface::getSurrogateTrainerByName().

◆ _sorted_indices

template<typename SamplerType >

std::vector<unsigned int>& GenericActiveLearnerTempl< SamplerType >::_sorted_indices

protected

The selected sample indices to evaluate the subApp.

Definition at line 109 of file GenericActiveLearner.h.

Referenced by GenericActiveLearnerTempl< SamplerType >::GenericActiveLearnerTempl().

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

stochastic_tools/include/reporters/GenericActiveLearner.h

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

Detailed Description

Constructor & Destructor Documentation

◆ GenericActiveLearnerTempl()

Member Function Documentation

◆ computeConvergenceValue()

◆ computeGPOutput()

◆ evaluateGPTest()

◆ execute()

◆ finalize()

◆ getAcquisition()

◆ getParallelAcquisitionFunctionByName()

◆ getSurrogateModel() [1/2]

◆ getSurrogateModel() [2/2]

◆ getSurrogateModelByName() [1/2]

◆ getSurrogateModelByName() [2/2]

◆ getSurrogateTrainer() [1/2]

◆ getSurrogateTrainer() [2/2]

◆ getSurrogateTrainerByName() [1/2]

◆ getSurrogateTrainerByName() [2/2]

◆ includeAdditionalInputs()

◆ initialize()

◆ setupGeneric()

◆ setupGPData()

◆ validParams()

Member Data Documentation

◆ _acquisition_obj

◆ _acquisition_value

◆ _al_gp

◆ _al_sampler

◆ _check_step

◆ _convergence_value

◆ _eval_outputs_current

◆ _generic

◆ _gp_eval

◆ _gp_inputs

◆ _gp_outputs

◆ _gp_outputs_test

◆ _gp_std_test

◆ _inputs_required

◆ _inputs_test

◆ _inputs_test_modified

◆ _length_scales

◆ _n_dim

◆ _output_comm

◆ _output_value

◆ _parallelacquisition_feproblem

◆ _penalize_acquisition

◆ _props

◆ _smi_feproblem

◆ _smi_params

◆ _smi_tid

◆ _sorted_indices