SurrogateModelInterface Class Reference

Interface for objects that need to use samplers. More...

#include <SurrogateModelInterface.h>

Inheritance diagram for SurrogateModelInterface:

Public Member Functions
	SurrogateModelInterface (const MooseObject *moose_object)
template<>
SurrogateModel &	getSurrogateModelByName (const UserObjectName &name) const
template<>
SurrogateModel &	getSurrogateModel (const std::string &name) const
template<>
SurrogateTrainerBase &	getSurrogateTrainerByName (const UserObjectName &name) const
template<>
SurrogateTrainerBase &	getSurrogateTrainer (const std::string &name) 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

Static Public Member Functions
static InputParameters	validParams ()

Private Attributes
const InputParameters &	_smi_params
	Parameters of the object with this interface. More...
FEProblemBase &	_smi_feproblem
	Reference to FEProblemBase instance. More...
const THREAD_ID	_smi_tid
	Thread ID. More...

Detailed Description

Interface for objects that need to use samplers.

This practically adds two methods for getting SurrogateModel objects:

1. Call getSurrogateModel or getSurrogateModelByName without a template parameter and you will get a SurrogateModel base object (see SurrogateModelInterface.C for the template specialization).
2. Call getSurrogateModel<MySurrogateModel> or getSurrogateModelByName<MySurrogateModel> to perform a cast to the desired type, as done for UserObjects.

Definition at line 31 of file SurrogateModelInterface.h.

Constructor & Destructor Documentation

SurrogateModelInterface()

SurrogateModelInterface::SurrogateModelInterface

(

const MooseObject *

moose_object

)

Parameters

params

The parameters used by the object being instantiated. This class needs them so it can get the sampler named in the input file, but the object calling getSurrogateModel only needs to use the name on the left hand side of the statement "sampler = sampler_name"

Definition at line 22 of file SurrogateModelInterface.C.

  : _smi_params(moose_object->parameters()),
    _smi_feproblem(*_smi_params.get<FEProblemBase *>("_fe_problem_base")),
    _smi_tid(_smi_params.have_parameter<THREAD_ID>("_tid") ? _smi_params.get<THREAD_ID>("_tid") : 0)
{
}

Member Function Documentation

getSurrogateModel() [1/2]

template<>

SurrogateModel& SurrogateModelInterface::getSurrogateModel

(

const std::string &

name

)

const

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

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

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

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

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

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

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

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

validParams()

InputParameters SurrogateModelInterface::validParams ( )

static

Definition at line 17 of file SurrogateModelInterface.C.

Referenced by GaussianProcessData::validParams(), SurrogateModelScalarAux::validParams(), DRLRewardReporter::validParams(), LibtorchNeuralNetControlTransfer::validParams(), EvaluateSurrogate::validParams(), PODSurrogateTester::validParams(), SurrogateModel::validParams(), and SurrogateModelAuxKernelTempl< ComputeValueType >::validParams().

{
  return emptyInputParameters();
}

Member Data Documentation

_smi_feproblem

FEProblemBase& SurrogateModelInterface::_smi_feproblem

private

Reference to FEProblemBase instance.

Definition at line 73 of file SurrogateModelInterface.h.

Referenced by getSurrogateModelByName(), and getSurrogateTrainerByName().

_smi_params

const InputParameters& SurrogateModelInterface::_smi_params

private

Parameters of the object with this interface.

Definition at line 70 of file SurrogateModelInterface.h.

Referenced by getSurrogateModel(), and getSurrogateTrainer().

_smi_tid

const THREAD_ID SurrogateModelInterface::_smi_tid

private

Thread ID.

Definition at line 76 of file SurrogateModelInterface.h.

Referenced by getSurrogateTrainerByName().

---

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

• stochastic_tools/include/interfaces/SurrogateModelInterface.h
• stochastic_tools/src/interfaces/SurrogateModelInterface.C