www.mooseframework.org
StochasticToolsApp.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "StochasticToolsApp.h"
11 #include "Moose.h"
12 #include "AppFactory.h"
13 #include "MooseSyntax.h"
14 
17 {
19 
20  params.set<bool>("use_legacy_material_output") = false;
21 
22  return params;
23 }
24 
25 registerKnownLabel("StochasticToolsApp");
26 
28 {
30 }
31 
33 
34 void
36 {
37  Registry::registerObjectsTo(f, {"StochasticToolsApp"});
38  Registry::registerActionsTo(af, {"StochasticToolsApp"});
39 
40  // Adds [Trainers] block
41  registerSyntaxTask("AddSurrogateAction", "Trainers/*", "add_trainer");
42  registerMooseObjectTask("add_trainer", SurrogateTrainer, false);
43  addTaskDependency("add_trainer", "add_sampler");
44 
45  // Adds [Surrogates] block
46  registerSyntaxTask("AddSurrogateAction", "Surrogates/*", "add_surrogate");
47  registerMooseObjectTask("add_surrogate", SurrogateModel, false);
48  addTaskDependency("add_surrogate", "add_trainer");
49 
50  // Adds action for loading Surrogate data
51  registerTask("load_surrogate_data", true);
52  addTaskDependency("load_surrogate_data", "add_surrogate");
53 
54  // Adds action for loading mapping data
55  registerTask("load_mapping_data", true);
56  addTaskDependency("load_mapping_data", "add_variable_mapping");
57 
58  // General StochasticTools action
59  registerTask("auto_create_mesh", false);
60  registerTask("auto_create_problem", false);
61  registerTask("auto_create_executioner", false);
62  registerSyntaxTask("StochasticToolsAction", "StochasticTools", "auto_create_mesh");
63  registerSyntaxTask("StochasticToolsAction", "StochasticTools", "auto_create_problem");
64  registerSyntaxTask("StochasticToolsAction", "StochasticTools", "auto_create_executioner");
65 
66  // StochasticResults
67  registerTask("declare_stochastic_results_vectors", true);
68  addTaskDependency("declare_stochastic_results_vectors", "add_vector_postprocessor");
69  addTaskDependency("add_reporter", "declare_stochastic_results_vectors");
70 
71  // Covariance functions (Gaussian Process)
72  registerSyntaxTask("AddCovarianceAction", "Covariance/*", "add_covariance");
73  registerMooseObjectTask("add_covariance", CovarianceFunctionBase, false);
74  addTaskDependency("add_covariance", "add_user_object");
75  addTaskDependency("add_distribution", "add_covariance");
76  // Mapping objects
77  registerSyntaxTask("AddVariableMappingAction", "VariableMappings/*", "add_variable_mapping");
78  registerMooseObjectTask("add_variable_mapping", VariableMappingBase, false);
79  addTaskDependency("add_variable_mapping", "add_reporter");
80  // Adds action for loading Covariance data in model
81  registerTask("load_covariance_data", true);
82  addTaskDependency("load_covariance_data", "load_surrogate_data");
83  addTaskDependency("setup_function_complete", "load_covariance_data");
84  addTaskDependency("setup_mesh", "auto_create_mesh");
85  addTaskDependency("create_problem", "auto_create_problem");
86  addTaskDependency("setup_executioner", "auto_create_executioner");
87  // Likelihood functions (Bayesian inference)
88  registerSyntaxTask("AddLikelihoodAction", "Likelihood/*", "add_likelihood");
89  registerMooseObjectTask("add_likelihood", LikelihoodFunctionBase, false);
90  addTaskDependency("add_likelihood", "add_user_object");
91  addTaskDependency("add_distribution", "add_likelihood");
92 
93  registerSyntaxTask("AdaptiveSamplerAction", "Samplers", "add_user_object");
94  registerSyntaxTask("AdaptiveSamplerAction", "Samplers", "add_postprocessor");
95 
96  // Adds [ParameterStudy] block
97  registerSyntax("ParameterStudyAction", "ParameterStudy");
98 }
99 
100 void
102 {
103  registerApp(StochasticToolsApp);
104 }
105 
106 void
108 {
109  mooseDeprecated("use registerAll instead of registerObjects");
110  Registry::registerObjectsTo(factory, {"StochasticToolsApp"});
111 }
112 
113 void
115 {
116  mooseDeprecated("use registerAll instead of associateSyntax");
117  Registry::registerActionsTo(action_factory, {"StochasticToolsApp"});
118 }
119 
120 void
122 #ifndef LIBTORCH_ENABLED
123  obj
124 #endif
125 )
126 {
127 #ifndef LIBTORCH_ENABLED
128  obj.mooseError("PyTorch C++ API (libtorch) must be installed to use this object, see "
129  "https://mooseframework.inl.gov/modules/stochastic_tools/install_pytorch.html for "
130  "instruction.");
131 #endif
132 }
133 
134 void
136 {
137  mooseDeprecated("Do not use registerExecFlags, apps no longer require flag registration");
138 }
139 
140 extern "C" void
142 {
144 }
145 extern "C" void
147 {
149 }
All Likelihoods should inherit from this class.
void StochasticToolsApp__registerAll(Factory &f, ActionFactory &af, Syntax &s)
T & set(const std::string &name, bool quiet_mode=false)
static void registerAll(Factory &f, ActionFactory &af, Syntax &s)
static void associateSyntax(Syntax &syntax, ActionFactory &action_factory)
static void requiresTorch(const MooseObject &obj)
static void registerObjectsTo(Factory &f, const std::set< std::string > &labels)
Syntax _syntax
static InputParameters validParams()
static void registerActionsTo(ActionFactory &f, const std::set< std::string > &labels)
Real f(Real x)
Test function for Brents method.
registerKnownLabel("StochasticToolsApp")
ActionFactory _action_factory
static void registerApps()
void mooseDeprecated(Args &&... args)
static void registerExecFlags(Factory &factory)
StochasticToolsApp(InputParameters parameters)
This is the main trainer base class.
void StochasticToolsApp__registerApps()
static InputParameters validParams()
static void registerObjects(Factory &factory)
Factory _factory
This is an abstract base class for objects that provide mapping between a full-order and a latent spa...