#include <SurrogateModel.h>

Inheritance diagram for SurrogateModel:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	SurrogateModel (const InputParameters &parameters)

virtual Real	evaluate (const std::vector< Real > &x) const
	Evaluate surrogate model given a row of parameters. More...

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

T &	getSampler (const std::string &name)

Sampler &	getSampler (const std::string &name)

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

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

const std::string &	modelMetaDataName () const
	Accessor for the name of the model meta data. More...

const FileName &	getModelDataFileName () const
	Get the associated filename. More...

bool	hasModelData () const
	Check if we need to load model data (if the filename parameter is used) More...


virtual void	evaluate (const std::vector< Real > &x, std::vector< Real > &y) const
	Various evaluate methods that can be overriden. More...


virtual Real	evaluate (const std::vector< Real > &x, Real &std) const
	Evaluate methods that also return predicted standard deviation (see GaussianProcess.h) More...

virtual void	evaluate (const std::vector< Real > &x, std::vector< Real > &y, std::vector< Real > &) const


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

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

template<typename T = SurrogateTrainerBase>
T &	getSurrogateTrainerByName (const UserObjectName &name) const


template<typename T , typename... Args>
T &	declareModelData (const std::string &data_name, Args &&... args)
	Declare model data for loading from file as well as restart. More...


template<typename T , typename... Args>
const T &	getModelData (const std::string &data_name, Args &&... args) const
	Retrieve model data from the interface. More...

Static Public Member Functions
static InputParameters	validParams ()

static MooseEnum	defaultPredictorTypes ()

static MooseEnum	defaultResponseTypes ()

Public Attributes
const ConsoleStream	_console

Protected Attributes
const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const Parallel::Communicator &	_communicator

Private Member Functions
template<typename P , typename R >
void	evaluateError (P x, R y, bool with_std=false) const

Detailed Description

Definition at line 18 of file SurrogateModel.h.

Constructor & Destructor Documentation

◆ SurrogateModel()

SurrogateModel::SurrogateModel ( const InputParameters & parameters )

Definition at line 31 of file SurrogateModel.C.

   : MooseObject(parameters),
     SamplerInterface(this),
     SurrogateModelInterface(this),
     RestartableModelInterface(*this,
                               /*read_only=*/true,
                               isParamValid("trainer")
                                   ? getSurrogateTrainer("trainer").modelMetaDataName()
                                   : _type + "_" + name())
 {
 }

Member Function Documentation

◆ declareModelData()

template<typename T , typename... Args>

T & RestartableModelInterface::declareModelData	(	const std::string &	data_name,
		Args &&...	args
	)

inherited

Declare model data for loading from file as well as restart.

Definition at line 78 of file RestartableModelInterface.h.

 {
   return _model_restartable.declareRestartableData<T>(data_name, std::forward<Args>(args)...);
 }

◆ defaultPredictorTypes()

static MooseEnum SurrogateModel::defaultPredictorTypes ( )

inlinestatic

Definition at line 27 of file SurrogateModel.h.

27 { return MooseEnum("real"); }

MooseEnum

◆ defaultResponseTypes()

static MooseEnum SurrogateModel::defaultResponseTypes ( )

inlinestatic

Definition at line 28 of file SurrogateModel.h.

Referenced by EvaluateSurrogate::validParams().

28 { return MooseEnum("real vector_real"); }

MooseEnum

◆ evaluate() [1/4]

virtual Real SurrogateModel::evaluate ( const std::vector< Real > & x ) const

inlinevirtual

Evaluate surrogate model given a row of parameters.

Reimplemented in LibtorchANNSurrogate, PolynomialChaos, GaussianProcessSurrogate, PolynomialRegressionSurrogate, and NearestPointSurrogate.

Definition at line 33 of file SurrogateModel.h.

Referenced by SurrogateModelScalarAux::computeValue(), SurrogateTrainer::evaluateModelError(), BiFidelityActiveLearningGPDecision::facilitateDecision(), and ActiveLearningGPDecision::facilitateDecision().

   {
     evaluateError(x, Real());
     return 0.0;
   };

◆ evaluate() [2/4]

virtual void SurrogateModel::evaluate	(	const std::vector< Real > &	x,
		std::vector< Real > &	y
	)		const

inlinevirtual

Various evaluate methods that can be overriden.

Reimplemented in GaussianProcessSurrogate, PolynomialRegressionSurrogate, and NearestPointSurrogate.

Definition at line 43 of file SurrogateModel.h.

   {
     evaluateError(x, y);
   }

◆ evaluate() [3/4]

virtual Real SurrogateModel::evaluate	(	const std::vector< Real > &	x,
		Real &	std
	)		const

inlinevirtual

Evaluate methods that also return predicted standard deviation (see GaussianProcess.h)

Reimplemented in GaussianProcessSurrogate.

Definition at line 53 of file SurrogateModel.h.

   {
     evaluateError(x, std, true);
     return 0.0;
   }

◆ evaluate() [4/4]

virtual void SurrogateModel::evaluate	(	const std::vector< Real > &	x,
		std::vector< Real > &	y,
		std::vector< Real > &
	)		const

inlinevirtual

Reimplemented in GaussianProcessSurrogate.

Definition at line 59 of file SurrogateModel.h.

   {
     evaluateError(x, y, true);
   }

◆ evaluateError()

template<typename P , typename R >

void SurrogateModel::evaluateError	(	P	x,
		R	y,
		bool	with_std = `false`
	)		const

private

Definition at line 72 of file SurrogateModel.h.

Referenced by evaluate().

 {
   std::stringstream ss;
   ss << "Evaluate method";
   if (with_std)
     ss << " (including standard deviation computation)";
   ss << " with predictor type " << MooseUtils::prettyCppType<P>();
   ss << " and response type " << MooseUtils::prettyCppType<R>();
   ss << " has not been implemented.";
   mooseError(ss.str());
 }

◆ getModelData()

template<typename T , typename... Args>

const T & RestartableModelInterface::getModelData	(	const std::string &	data_name,
		Args &&...	args
	)		const

inherited

Retrieve model data from the interface.

Definition at line 85 of file RestartableModelInterface.h.

 {
   return _model_restartable.getRestartableData<T>(data_name, std::forward<Args>(args)...);
 }

◆ getModelDataFileName()

const FileName & RestartableModelInterface::getModelDataFileName ( ) const

inherited

Get the associated filename.

Definition at line 33 of file RestartableModelInterface.C.

 {
   return _model_object.getParam<FileName>("filename");
 }

◆ getSurrogateModel() [1/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));
 }

◆ getSurrogateModel() [2/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.

Referenced by SurrogateTrainer::initialize().

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

◆ getSurrogateModelByName() [1/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]);
 }

◆ getSurrogateModelByName() [2/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.

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

 {
   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]);
 }

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

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

inherited

Definition at line 53 of file SurrogateModelInterface.C.

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

◆ getSurrogateTrainerByName() [2/2]

template<typename T >

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

inherited

Definition at line 111 of file SurrogateModelInterface.h.

Referenced by SurrogateTrainerOutput::output().

 {
   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;
 }

◆ hasModelData()

bool RestartableModelInterface::hasModelData ( ) const

inherited

Check if we need to load model data (if the filename parameter is used)

Definition at line 39 of file RestartableModelInterface.C.

 {
   return _model_object.isParamValid("filename");
 }

◆ modelMetaDataName()

const std::string& RestartableModelInterface::modelMetaDataName ( ) const

inlineinherited

Accessor for the name of the model meta data.

Definition at line 47 of file RestartableModelInterface.h.

Referenced by SurrogateTrainerOutput::output(), and MappingOutput::output().

47 { return _model_meta_data_name; }

RestartableModelInterface::_model_meta_data_name

const std::string _model_meta_data_name

The model meta data name.

Definition: RestartableModelInterface.h:61

◆ validParams()

InputParameters SurrogateModel::validParams ( )

static

Definition at line 16 of file SurrogateModel.C.

Referenced by NearestPointSurrogate::validParams(), PODReducedBasisSurrogate::validParams(), PolynomialRegressionSurrogate::validParams(), GaussianProcessSurrogate::validParams(), PolynomialChaos::validParams(), and LibtorchANNSurrogate::validParams().

 {
   InputParameters params = MooseObject::validParams();
   params += SamplerInterface::validParams();
   params += SurrogateModelInterface::validParams();
   params += RestartableModelInterface::validParams();
   params.addParam<UserObjectName>(
       "trainer",
       "The SurrogateTrainer object. If this is specified the trainer data is automatically "
       "gathered and available in this SurrogateModel object.");
   params.registerBase("SurrogateModel");
   params.registerSystemAttributeName("SurrogateModel");
   return params;
 }

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

stochastic_tools/include/surrogates/SurrogateModel.h
stochastic_tools/src/surrogates/SurrogateModel.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SurrogateModel()

Member Function Documentation

◆ declareModelData()

◆ defaultPredictorTypes()

◆ defaultResponseTypes()

◆ evaluate() [1/4]

◆ evaluate() [2/4]

◆ evaluate() [3/4]

◆ evaluate() [4/4]

◆ evaluateError()

◆ getModelData()

◆ getModelDataFileName()

◆ getSurrogateModel() [1/2]

◆ getSurrogateModel() [2/2]

◆ getSurrogateModelByName() [1/2]

◆ getSurrogateModelByName() [2/2]

◆ getSurrogateTrainer() [1/2]

◆ getSurrogateTrainer() [2/2]

◆ getSurrogateTrainerByName() [1/2]

◆ getSurrogateTrainerByName() [2/2]

◆ hasModelData()

◆ modelMetaDataName()

◆ validParams()