GaussianProcessSurrogate

Computes and evaluates Gaussian Process surrogate model.

The theory and use this object is provided within a discussion of the GaussianProcessTrainer training object.

A desirable aspect of Gaussian process modeling is that in addition to returning a predicted value at the evaluation point, it can also provide a measure of uncertainty in the form of a standard deviation. To facilitate this an overloaded evaluate() function which sets the standard deviation by reference is provided.

GaussianProcessSurrogate::evaluate(const std::vector<Real> & x, Real & std_dev) const
(contrib/moose/modules/stochastic_tools/src/surrogates/GaussianProcessSurrogate.C)

Evaluation of multi-output Gaussian Processes

For Gaussian Processes that predict multiple outputs the user can evaluate the the mean and standard deviation estimates using the following function:

void
GaussianProcessSurrogate::evaluate(const std::vector<Real> & x,
                                   std::vector<Real> & y,
                                   std::vector<Real> & std) const
(contrib/moose/modules/stochastic_tools/src/surrogates/GaussianProcessSurrogate.C)

Input Parameters

  • filenameThe name of the file which will be associated with the saved/loaded data.

    C++ Type:FileName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name of the file which will be associated with the saved/loaded data.

  • trainerThe SurrogateTrainer object. If this is specified the trainer data is automatically gathered and available in this SurrogateModel object.

    C++ Type:UserObjectName

    Unit:(no unit assumed)

    Controllable:No

    Description:The SurrogateTrainer object. If this is specified the trainer data is automatically gathered and available in this SurrogateModel object.

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Set the enabled status of the MooseObject.

Advanced Parameters