#include <PolynomialRegressionSurrogate.h>

Inheritance diagram for PolynomialRegressionSurrogate:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PolynomialRegressionSurrogate (const InputParameters &parameters)

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

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

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

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

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

virtual void	evaluate (const std::vector< Real > &x, std::vector< Real > &y, std::vector< Real > &) 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

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.

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

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


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


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.


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

Static Public Member Functions
static InputParameters	validParams ()

static MooseEnum	defaultPredictorTypes ()

static MooseEnum	defaultResponseTypes ()

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)

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

Protected Member Functions
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

Protected Attributes
const std::vector< std::vector< Real > > &	_coeff
	Coefficients of regression model.

const std::vector< std::vector< unsigned int > > &	_power_matrix
	The power matrix for the terms in the polynomial expressions.

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const Parallel::Communicator &	_communicator

Private Member Functions
template<typename P , typename R >
void	evaluateError (P x, R y, bool with_std=false) 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 unsigned int &	_max_degree
	Maximum polynomial degree, limiting the sum of constituent polynomial degrees.

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

const InputParameters &	_si_params

FEProblemBase &	_si_feproblem

THREAD_ID	_si_tid

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.

const MooseObject &	_model_object
	Reference to the MooseObject that uses this interface.

const std::string	_model_meta_data_name
	The model meta data name.

PublicRestartable	_model_restartable
	Member for interfacing with the framework's restartable system.

Detailed Description

Definition at line 14 of file PolynomialRegressionSurrogate.h.

Constructor & Destructor Documentation

◆ PolynomialRegressionSurrogate()

PolynomialRegressionSurrogate::PolynomialRegressionSurrogate ( const InputParameters & parameters )

Definition at line 23 of file PolynomialRegressionSurrogate.C.

  : SurrogateModel(parameters),
    _coeff(getModelData<std::vector<std::vector<Real>>>("_coeff")),
    _power_matrix(getModelData<std::vector<std::vector<unsigned int>>>("_power_matrix")),
    _max_degree(getModelData<unsigned int>("_max_degree"))
{
}

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 73 of file RestartableModelInterface.h.

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

◆ defaultPredictorTypes()

static MooseEnum SurrogateModel::defaultPredictorTypes ( )

inlinestaticinherited

Definition at line 27 of file SurrogateModel.h.

27{ return MooseEnum("real"); }

MooseEnum

◆ defaultResponseTypes()

static MooseEnum SurrogateModel::defaultResponseTypes ( )

inlinestaticinherited

Definition at line 28 of file SurrogateModel.h.

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

Referenced by EvaluateSurrogate::validParams().

◆ evaluate() [1/6]

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

inlinevirtual

Evaluate surrogate model given a row of parameters.

Reimplemented from SurrogateModel.

Definition at line 33 of file SurrogateModel.h.

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

◆ evaluate() [2/6]

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

overridevirtual

Evaluate surrogate model given a row of parameters.

Reimplemented from SurrogateModel.

Definition at line 32 of file PolynomialRegressionSurrogate.C.

{
  // Check whether input point has same dimensionality as training data
  mooseAssert(_power_matrix[0].size() == x.size(),
              "Input point does not match dimensionality of training data.");
 
  Real val(0.0);
  for (unsigned int i = 0; i < _power_matrix.size(); ++i)
  {
    Real tmp_val(1.0);
    for (unsigned int j = 0; j < _power_matrix[i].size(); ++j)
      tmp_val *= MathUtils::pow(x[j], _power_matrix[i][j]);
    val += _coeff[0][i] * tmp_val;
  }
 
  return val;
}

◆ evaluate() [3/6]

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

Definition at line 53 of file SurrogateModel.h.

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

◆ evaluate() [4/6]

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

inlinevirtual

Various evaluate methods that can be overriden.

Reimplemented from SurrogateModel.

Definition at line 43 of file SurrogateModel.h.

  {
    evaluateError(x, y);
  }

◆ evaluate() [5/6]

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

overridevirtual

Various evaluate methods that can be overriden.

Reimplemented from SurrogateModel.

Definition at line 51 of file PolynomialRegressionSurrogate.C.

{
  // Check whether input point has same dimensionality as training data
  mooseAssert(_power_matrix[0].size() == x.size(),
              "Input point does not match dimensionality of training data.");
 
  y.assign(_coeff.size(), 0.0);
  for (unsigned int i = 0; i < _power_matrix.size(); ++i)
  {
    Real tmp_val(1.0);
    for (unsigned int j = 0; j < _power_matrix[i].size(); ++j)
      tmp_val *= MathUtils::pow(x[j], _power_matrix[i][j]);
    for (unsigned int r = 0; r < _coeff.size(); ++r)
      y[r] += _coeff[r][i] * tmp_val;
  }
}

◆ evaluate() [6/6]

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

inlinevirtual

Reimplemented from SurrogateModel.

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

privateinherited

Definition at line 72 of file SurrogateModel.h.

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

Referenced by SurrogateModel::evaluate(), SurrogateModel::evaluate(), SurrogateModel::evaluate(), and SurrogateModel::evaluate().

◆ 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 80 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<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);
}

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

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

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

◆ validParams()

InputParameters PolynomialRegressionSurrogate::validParams ( )

static

Definition at line 15 of file PolynomialRegressionSurrogate.C.

{
  InputParameters params = SurrogateModel::validParams();
  params.addClassDescription("Evaluates polynomial regression model with coefficients computed "
                             "from PolynomialRegressionTrainer.");
  return params;
}

Member Data Documentation

◆ _coeff

const std::vector<std::vector<Real> >& PolynomialRegressionSurrogate::_coeff

protected

Coefficients of regression model.

Definition at line 27 of file PolynomialRegressionSurrogate.h.

Referenced by evaluate(), and evaluate().

◆ _max_degree

const unsigned int& PolynomialRegressionSurrogate::_max_degree

private

Maximum polynomial degree, limiting the sum of constituent polynomial degrees.

Definition at line 34 of file PolynomialRegressionSurrogate.h.

◆ _model_meta_data_name

const std::string RestartableModelInterface::_model_meta_data_name

privateinherited

The model meta data name.

This is used to store the restartable data within the RestartableDataMap.

Definition at line 61 of file RestartableModelInterface.h.

Referenced by RestartableModelInterface::modelMetaDataName(), and RestartableModelInterface::RestartableModelInterface().

◆ _model_object

const MooseObject& RestartableModelInterface::_model_object

privateinherited

Reference to the MooseObject that uses this interface.

Definition at line 57 of file RestartableModelInterface.h.

Referenced by RestartableModelInterface::getModelDataFileName(), RestartableModelInterface::hasModelData(), and RestartableModelInterface::RestartableModelInterface().

◆ _model_restartable

PublicRestartable RestartableModelInterface::_model_restartable

privateinherited

Member for interfacing with the framework's restartable system.

We need this because we would like to have the capability to handle the model data separately from the other data members used for checkpointing.

Definition at line 68 of file RestartableModelInterface.h.

Referenced by RestartableModelInterface::declareModelData(), and RestartableModelInterface::getModelData().

◆ _power_matrix

const std::vector<std::vector<unsigned int> >& PolynomialRegressionSurrogate::_power_matrix

protected

The power matrix for the terms in the polynomial expressions.

Definition at line 30 of file PolynomialRegressionSurrogate.h.

Referenced by evaluate(), and evaluate().

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

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PolynomialRegressionSurrogate()

Member Function Documentation

◆ declareModelData()

◆ defaultPredictorTypes()

◆ defaultResponseTypes()

◆ evaluate() [1/6]

◆ evaluate() [2/6]

◆ evaluate() [3/6]

◆ evaluate() [4/6]

◆ evaluate() [5/6]

◆ evaluate() [6/6]

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

Member Data Documentation

◆ _coeff

◆ _max_degree

◆ _model_meta_data_name

◆ _model_object

◆ _model_restartable

◆ _power_matrix

◆ _smi_feproblem

◆ _smi_params

◆ _smi_tid