https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
LoadCovarianceDataAction Class Reference

#include <LoadCovarianceDataAction.h>

Inheritance diagram for LoadCovarianceDataAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 LoadCovarianceDataAction (const InputParameters &params)
 
virtual void act () override
 
void timedAct ()
 
virtual void addRelationshipManagers (Moose::RelationshipManagerType when_type)
 
MooseObjectName uniqueActionName () const
 
const std::string & specificTaskName () const
 
const std::set< std::string > & getAllTasks () const
 
void appendTask (const std::string &task)
 
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
 
PerfGraph & perfGraph ()
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () 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)
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string unique_action_name_param
 
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 auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

bool addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
 
void associateWithParameter (const std::string &param_name, InputParameters &params) const
 
void associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) 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
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

std::string _registered_identifier
 
std::string _specific_task_name
 
std::set< std::string > _all_tasks
 
ActionWarehouse & _awh
 
const std::string & _current_task
 
std::shared_ptr< MooseMesh > & _mesh
 
std::shared_ptr< MooseMesh > & _displaced_mesh
 
std::shared_ptr< FEProblemBase > & _problem
 
PerfID _act_timer
 
MooseApp & _app
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Private Member Functions

void load (GaussianProcessSurrogate &model)
 
bool addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)
 
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
 

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 ParallelParamObject & _parent
 
MooseApp & _meta_data_app
 
const MooseObject *const _meta_data_object
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 

Detailed Description

Definition at line 17 of file LoadCovarianceDataAction.h.

Constructor & Destructor Documentation

◆ LoadCovarianceDataAction()

LoadCovarianceDataAction::LoadCovarianceDataAction ( const InputParameters &  params)

Definition at line 82 of file LoadCovarianceDataAction.C.

82 : Action(params)
83{
84}

Member Function Documentation

◆ act()

void LoadCovarianceDataAction::act ( )
overridevirtual

Implements Action.

Definition at line 87 of file LoadCovarianceDataAction.C.

88{
89 std::vector<SurrogateModel *> objects;
90 _app.theWarehouse().query().condition<AttribSystem>("SurrogateModel").queryInto(objects);
91 for (auto model_ptr : objects)
92 {
93 auto * gp_gen = dynamic_cast<GaussianProcessSurrogate *>(model_ptr);
94 if (gp_gen && model_ptr->isParamValid("filename"))
95 load(*gp_gen);
96 else if (gp_gen && _app.isRecovering() && gp_gen->getGP().getCovarFunctionPtr())
97 // After surrogate model data has been restored from checkpoint (load_surrogate_data ran
98 // first), push the recovered hyperparameters into the freshly-constructed covariance object
99 gp_gen->gp().covarFunction().loadHyperParamMap(gp_gen->getGP().getHyperParamMap());
100 }
101}
Action::_app
MooseApp & _app
CovarianceFunctionBase::loadHyperParamMap
void loadHyperParamMap(const HyperParameterMap &map)
Load some hyperparameters into the local map contained in this object.
Definition CovarianceFunctionBase.C:131
GaussianProcessSurrogate::gp
StochasticTools::GaussianProcess & gp()
Definition GaussianProcessSurrogate.h:39
LoadCovarianceDataAction::load
void load(GaussianProcessSurrogate &model)
Definition LoadCovarianceDataAction.C:104
MooseApp::isRecovering
bool isRecovering() const
MooseApp::theWarehouse
TheWarehouse & theWarehouse()
StochasticTools::GaussianProcess::covarFunction
CovarianceFunctionBase & covarFunction()
Definition GaussianProcess.h:216
TheWarehouse::query
Query query()

◆ load()

void LoadCovarianceDataAction::load ( GaussianProcessSurrogate &  model)
private

Definition at line 104 of file LoadCovarianceDataAction.C.

105{
106 // We grab all the necessary information that is needed to reconstruct the
107 // covariance structure for the GP
108 const std::string & covar_type = model.getGP().getCovarType();
109 const std::string & covar_name = model.getGP().getCovarName();
110 const std::map<UserObjectName, std::string> & dep_covar_types =
111 model.getGP().getDependentCovarTypes();
112 const std::vector<UserObjectName> & dep_covar_names = model.getGP().getDependentCovarNames();
113
114 // This is for the covariance on the very top, the lower-level covariances are
115 // all assumed to have num_outputs=1.
116 const unsigned int num_outputs = model.getGP().getCovarNumOutputs();
117 const HyperParameterMap & hyperparameters = model.getGP().getHyperParamMap();
118
119 // We start by creating and loading the lower-level covariances if they need
120 // to be present. Right now we can only load a complex covariance which has
121 // a one-level dependency depth.
122 // TODO: Extend this to arbitrary dependency depths. Maybe we could use a graph.
123 for (const auto & it : dep_covar_types)
124 {
125 const auto & name = it.first;
126 const auto & type = it.second;
127 InputParameters covar_params = _factory.getValidParams(type);
128
129 // We make sure that every required parameter is added so that the object
130 // can be constructed. The non-required hyperparameters (if present in the
131 // parameter maps) will be inserted later.
132 const auto param_list = covar_params.getParametersList();
133 for (const auto & param : param_list)
134 if (covar_params.isParamRequired(param))
135 loadRequiredHyperParameter(covar_params, name, param, hyperparameters);
136
137 _problem->addObject<CovarianceFunctionBase>(type, name, covar_params, /*threaded=*/false);
138 }
139
140 InputParameters covar_params = _factory.getValidParams(covar_type);
141 covar_params.set<unsigned int>("num_outputs") = num_outputs;
142 covar_params.set<std::vector<UserObjectName>>("covariance_functions") = dep_covar_names;
143
144 const auto param_list = covar_params.getParametersList();
145 for (const auto & param : param_list)
146 // We make sure that every required parameter is added so that the object
147 // can be constructed. The non-required hyperparameters (if present in the
148 // parameter maps) will be inserted later.
149 if (covar_params.isParamRequired(param))
150 loadRequiredHyperParameter(covar_params, covar_name, param, hyperparameters);
151
152 auto covar_object = _problem->addObject<CovarianceFunctionBase>(
153 covar_type, covar_name, covar_params, /* threaded = */ false);
154 covar_object[0]->loadHyperParamMap(hyperparameters);
155
156 model.setupCovariance(covar_name);
157}
model
const PertinentGeochemicalSystem model(database, {"H2O", "H+", "HCO3-", "O2(aq)", "Ca++", ">(s)FeOH", "radius_neg1", "radius_neg1.5"}, {"Calcite"}, {}, {"Calcite_asdf"}, {"CH4(aq)"}, {">(s)FeOCa+"}, "O2(aq)", "e-")
Action::_problem
std::shared_ptr< FEProblemBase > & _problem
CovarianceFunctionBase
Base class for covariance functions that are used in Gaussian Processes.
Definition CovarianceFunctionBase.h:21
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
InputParameters::getParametersList
std::set< std::string > getParametersList() const
Action::type
const std::string & type() const
Action::name
const std::string & name() const
Action::_factory
Factory & _factory
libMesh::if
if(subdm)

Referenced by act().

◆ validParams()

InputParameters LoadCovarianceDataAction::validParams ( )
static

Definition at line 74 of file LoadCovarianceDataAction.C.

75{
76 InputParameters params = Action::validParams();
77 params.addClassDescription("Calls load method on SurrogateModel objects contained within the "
78 "`[Surrogates]` input block, if a filename is given.");
79 return params;
80}
Action::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
The documentation for this class was generated from the following files:
Generated on Mon Sep 28 2026 20:40:02 for https://mooseframework.inl.gov by doxygen 1.9.8