https://mooseframework.inl.gov
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 | 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
 
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
 
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 ()
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

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
 

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
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Private Member Functions

void load (GaussianProcessSurrogate &model)
 

Detailed Description

Definition at line 15 of file LoadCovarianceDataAction.h.

Constructor & Destructor Documentation

◆ LoadCovarianceDataAction()

LoadCovarianceDataAction::LoadCovarianceDataAction ( const InputParameters &  params)

Definition at line 26 of file LoadCovarianceDataAction.C.

26  : Action(params)
27 {
28 }
Action::Action
Action(const InputParameters &parameters)

Member Function Documentation

◆ act()

void LoadCovarianceDataAction::act ( )
overridevirtual

Implements Action.

Definition at line 31 of file LoadCovarianceDataAction.C.

32 {
33  std::vector<SurrogateModel *> objects;
34  _app.theWarehouse().query().condition<AttribSystem>("SurrogateModel").queryInto(objects);
35  for (auto model_ptr : objects)
36  {
37  auto * gp_gen = dynamic_cast<GaussianProcessSurrogate *>(model_ptr);
38  if (gp_gen && model_ptr->isParamValid("filename"))
39  load(*gp_gen);
40  }
41 }
Action::_app
MooseApp & _app
LoadCovarianceDataAction::load
void load(GaussianProcessSurrogate &model)
Definition: LoadCovarianceDataAction.C:44
TheWarehouse::query
Query query()
MooseApp::theWarehouse
TheWarehouse & theWarehouse()

◆ load()

void LoadCovarianceDataAction::load ( GaussianProcessSurrogate &  model)
private

Definition at line 44 of file LoadCovarianceDataAction.C.

Referenced by act().

45 {
46  // We grab all the necessary information that is needed to reconstruct the
47  // covariance structure for the GP
48  const std::string & covar_type = model.getGP().getCovarType();
49  const std::string & covar_name = model.getGP().getCovarName();
50  const std::map<UserObjectName, std::string> & dep_covar_types =
51  model.getGP().getDependentCovarTypes();
52  const std::vector<UserObjectName> & dep_covar_names = model.getGP().getDependentCovarNames();
53 
54  // This is for the covariance on the very top, the lower-level covariances are
55  // all assumed to have num_outputs=1.
56  const unsigned int num_outputs = model.getGP().getCovarNumOutputs();
57  const std::unordered_map<std::string, Real> & map = model.getGP().getHyperParamMap();
58  const std::unordered_map<std::string, std::vector<Real>> & vec_map =
59  model.getGP().getHyperParamVectorMap();
60 
61  // We start by creating and loading the lower-level covariances if they need
62  // to be present. Right now we can only load a complex covariance which has
63  // a one-level dependency depth.
64  // TODO: Extend this to arbitrary dependency depths. Maybe we could use a graph.
65  for (const auto & it : dep_covar_types)
66  {
67  const auto & name = it.first;
68  const auto & type = it.second;
69  InputParameters covar_params = _factory.getValidParams(type);
70 
71  // We make sure that every required parameter is added so that the object
72  // can be constructed. The non-required hyperparameters (if present in the
73  // parameter maps) will be inserted later.
74  const auto param_list = covar_params.getParametersList();
75  for (const auto & param : param_list)
76  if (covar_params.isParamRequired(param))
77  {
78  const std::string expected_name = name + ":" + param;
79  for (const auto & it_map : map)
80  {
81  const auto pos = it_map.first.find(expected_name);
82  if (pos != std::string::npos)
83  covar_params.set<Real>(param) = it_map.second;
84  }
85  for (const auto & it_map : vec_map)
86  {
87  const auto pos = it_map.first.find(expected_name);
88  if (pos != std::string::npos)
89  covar_params.set<std::vector<Real>>(param) = it_map.second;
90  }
91  }
92 
93  _problem->addObject<CovarianceFunctionBase>(type, name, covar_params, /*threaded=*/false);
94  }
95 
96  InputParameters covar_params = _factory.getValidParams(covar_type);
97  covar_params.set<unsigned int>("num_outputs") = num_outputs;
98  covar_params.set<std::vector<UserObjectName>>("covariance_functions") = dep_covar_names;
99 
100  const auto param_list = covar_params.getParametersList();
101  for (const auto & param : param_list)
102  // We make sure that every required parameter is added so that the object
103  // can be constructed. The non-required hyperparameters (if present in the
104  // parameter maps) will be inserted later.
105  if (covar_params.isParamRequired(param))
106  {
107  const std::string expected_name = covar_name + ":" + param;
108 
109  const auto & map_it = map.find(expected_name);
110  if (map_it != map.end())
111  covar_params.set<Real>(param) = map_it->second;
112 
113  const auto & vec_map_it = vec_map.find(expected_name);
114  if (vec_map_it != vec_map.end())
115  covar_params.set<std::vector<Real>>(param) = vec_map_it->second;
116  }
117 
118  auto covar_object = _problem->addObject<CovarianceFunctionBase>(
119  covar_type, covar_name, covar_params, /* threaded = */ false);
120  covar_object[0]->loadHyperParamMap(map, vec_map);
121 
122  model.setupCovariance(covar_name);
123 }
CovarianceFunctionBase::loadHyperParamMap
void loadHyperParamMap(const std::unordered_map< std::string, Real > &map, const std::unordered_map< std::string, std::vector< Real >> &vec_map)
Load some hyperparameters into the local maps contained in this object.
Definition: CovarianceFunctionBase.C:91
InputParameters::getParametersList
std::set< std::string > getParametersList() const
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
CovarianceFunctionBase
Base class for covariance functions that are used in Gaussian Processes.
Definition: CovarianceFunctionBase.h:19
Action::name
virtual const std::string & name() const
Action::_factory
Factory & _factory
Action::type
const std::string & type() const
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-")
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
InputParameters::isParamRequired
bool isParamRequired(const std::string &name) const
Action::_problem
std::shared_ptr< FEProblemBase > & _problem

◆ validParams()

InputParameters LoadCovarianceDataAction::validParams ( )
static

Definition at line 18 of file LoadCovarianceDataAction.C.

19 {
20  InputParameters params = Action::validParams();
21  params.addClassDescription("Calls load method on SurrogateModel objects contained within the "
22  "`[Surrogates]` input block, if a filename is given.");
23  return params;
24 }
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 Fri Jul 18 2025 12:03:02 for https://mooseframework.inl.gov by   doxygen 1.8.14