Line data Source code
1 : //* This file is part of the MOOSE framework
2 : //* https://mooseframework.inl.gov
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 "libmesh/petsc_macro.h"
11 : #include "libmesh/libmesh_config.h"
12 :
13 : #include "Moose.h"
14 : #include "MooseApp.h"
15 :
16 : #include "ActionWarehouse.h"
17 : #include "ActionFactory.h"
18 : #include "AuxiliarySystem.h"
19 : #include "Factory.h"
20 : #include "PetscSupport.h"
21 : #include "Syntax.h"
22 : #include "MooseSyntax.h"
23 : #include "ExecFlagRegistry.h"
24 :
25 : #include "hit/parse.h"
26 :
27 : #include <unistd.h>
28 :
29 : const ExecFlagType EXEC_NONE = registerDefaultExecFlag("NONE");
30 : const ExecFlagType EXEC_INITIAL = registerDefaultExecFlag("INITIAL");
31 : const ExecFlagType EXEC_LINEAR = registerDefaultExecFlag("LINEAR");
32 : const ExecFlagType EXEC_LINEAR_CONVERGENCE = registerDefaultExecFlag("LINEAR_CONVERGENCE");
33 : const ExecFlagType EXEC_NONLINEAR = registerDefaultExecFlag("NONLINEAR");
34 : const ExecFlagType EXEC_NONLINEAR_CONVERGENCE = registerDefaultExecFlag("NONLINEAR_CONVERGENCE");
35 : const ExecFlagType EXEC_POSTCHECK = registerDefaultExecFlag("POSTCHECK");
36 : const ExecFlagType EXEC_TIMESTEP_END = registerDefaultExecFlag("TIMESTEP_END");
37 : const ExecFlagType EXEC_TIMESTEP_BEGIN = registerDefaultExecFlag("TIMESTEP_BEGIN");
38 : const ExecFlagType EXEC_MULTIAPP_FIXED_POINT_ITERATION_END =
39 : registerExecFlag("MULTIAPP_FIXED_POINT_ITERATION_END");
40 : const ExecFlagType EXEC_MULTIAPP_FIXED_POINT_END =
41 : registerDefaultExecFlag("MULTIAPP_FIXED_POINT_END");
42 : const ExecFlagType EXEC_MULTIAPP_FIXED_POINT_BEGIN =
43 : registerDefaultExecFlag("MULTIAPP_FIXED_POINT_BEGIN");
44 : const ExecFlagType EXEC_MULTIAPP_FIXED_POINT_CONVERGENCE =
45 : registerDefaultExecFlag("MULTIAPP_FIXED_POINT_CONVERGENCE");
46 : const ExecFlagType EXEC_FINAL = registerDefaultExecFlag("FINAL");
47 : const ExecFlagType EXEC_FORCED = registerExecFlag("FORCED");
48 : const ExecFlagType EXEC_FAILED = registerExecFlag("FAILED");
49 : const ExecFlagType EXEC_CUSTOM = registerDefaultExecFlag("CUSTOM");
50 : const ExecFlagType EXEC_SUBDOMAIN = registerExecFlag("SUBDOMAIN");
51 : const ExecFlagType EXEC_ALWAYS = registerExecFlag("ALWAYS");
52 : const ExecFlagType EXEC_PRE_DISPLACE = registerExecFlag("PRE_DISPLACE");
53 : const ExecFlagType EXEC_SAME_AS_MULTIAPP = registerExecFlag("SAME_AS_MULTIAPP");
54 : const ExecFlagType EXEC_PRE_MULTIAPP_SETUP = registerExecFlag("PRE_MULTIAPP_SETUP");
55 : const ExecFlagType EXEC_TRANSFER = registerExecFlag("TRANSFER");
56 : const ExecFlagType EXEC_PRE_KERNELS = registerExecFlag("PRE_KERNELS");
57 : #ifdef LIBMESH_ENABLE_AMR
58 : const ExecFlagType EXEC_POST_ADAPTIVITY = registerExecFlag("POST_ADAPTIVITY");
59 : #endif
60 :
61 : namespace Moose
62 : {
63 :
64 : void associateSyntaxInner(Syntax & syntax, ActionFactory & action_factory);
65 :
66 : void
67 70207 : registerAll(Factory & f, ActionFactory & af, Syntax & s)
68 : {
69 70207 : registerObjects(f, {"MooseApp"});
70 70207 : associateSyntaxInner(s, af);
71 70207 : registerActions(s, af, {"MooseApp"});
72 280828 : registerAppDataFilePath("moose");
73 210621 : registerRepository("moose", "github.com/idaholab/moose");
74 70207 : }
75 :
76 : void
77 70207 : registerObjects(Factory & factory, const std::set<std::string> & obj_labels)
78 : {
79 70207 : Registry::registerObjectsTo(factory, obj_labels);
80 70207 : }
81 :
82 : void
83 70207 : addActionTypes(Syntax & syntax)
84 : {
85 : /**
86 : * The (optional) last param here indicates whether the task should trigger an Action auto-build.
87 : * If a task is marked as "true". Then MOOSE will attempt to build the associated Action if one is
88 : * not supplied by some other means (usually through the input file or custom Action). Only
89 : * Actions that do not have required parameters and have defaults for all optional parameters can
90 : * be built automatically (See ActionWarehouse.C).
91 : *
92 : * Note: Many of the actions in the "Minimal Problem" section are marked as false. However, we
93 : * can generally force creation of these "Action"s as needed by registering them to syntax that we
94 : * expect to see even if those "Action"s don't normally pick up parameters from the input file.
95 : */
96 :
97 : // clang-format off
98 : /**************************/
99 : /**** Register Actions ****/
100 : /**************************/
101 280828 : registerMooseObjectTask("create_problem", Problem, false);
102 280828 : registerMooseObjectTask("setup_executioner", Executioner, false);
103 280828 : registerMooseObjectTask("read_executor", Executor, false);
104 140414 : registerTask("add_executor", true);
105 :
106 : // TODO Organize these somewhere
107 140414 : registerTask("init_physics", false);
108 140414 : registerTask("init_component_physics", false);
109 140414 : registerTask("meta_action_component", false);
110 140414 : registerTask("setup_component", false);
111 : // 'list_component' is used to retrieve ActionComponents for the syntax JSON
112 140414 : registerTask("list_component", false);
113 :
114 : // This task does not construct an object, but it needs all of the parameters that
115 : // would normally be used to construct an object.
116 280828 : registerMooseObjectTask("determine_system_type", Executioner, true);
117 :
118 280828 : registerMooseObjectTask("setup_mesh", MooseMesh, false);
119 280828 : registerMooseObjectTask("set_mesh_base", MooseMesh, false);
120 280828 : registerMooseObjectTask("init_mesh", MooseMesh, false);
121 280828 : registerMooseObjectTask("add_mesh_generator", MeshGenerator, false);
122 140414 : registerTask("create_added_mesh_generators", true);
123 280828 : registerMooseObjectTask("append_mesh_generator", MeshGenerator, false);
124 :
125 280828 : registerMooseObjectTask("add_kernel", Kernel, false);
126 280828 : appendMooseObjectTask ("add_kernel", EigenKernel);
127 280828 : appendMooseObjectTask ("add_kernel", VectorKernel);
128 280828 : appendMooseObjectTask ("add_kernel", ArrayKernel);
129 :
130 280828 : registerMooseObjectTask("add_variable", MooseVariableBase, false);
131 280828 : registerMooseObjectTask("add_aux_variable", MooseVariableBase, false);
132 280828 : registerMooseObjectTask("add_elemental_field_variable", MooseVariableBase, false);
133 :
134 280828 : registerMooseObjectTask("add_nodal_kernel", NodalKernel, false);
135 :
136 280828 : registerMooseObjectTask("add_functor_material", FunctorMaterial, false);
137 280828 : registerMooseObjectTask("add_material", MaterialBase, false);
138 280828 : appendDeprecatedMooseObjectTask("add_material", FunctorMaterial);
139 :
140 280828 : registerMooseObjectTask("add_bc", BoundaryCondition, false);
141 :
142 280828 : registerMooseObjectTask("add_function", Function, false);
143 :
144 280828 : registerMooseObjectTask("add_distribution", Distribution, false);
145 280828 : registerMooseObjectTask("add_sampler", Sampler, false);
146 :
147 280828 : registerMooseObjectTask("add_aux_kernel", AuxKernel, false);
148 280828 : appendMooseObjectTask ("add_aux_kernel", VectorAuxKernel);
149 280828 : appendMooseObjectTask ("add_aux_kernel", ArrayAuxKernel);
150 :
151 280828 : registerMooseObjectTask("add_bound", Bounds, false);
152 :
153 280828 : registerMooseObjectTask("add_scalar_kernel", ScalarKernel, false);
154 280828 : registerMooseObjectTask("add_aux_scalar_kernel", AuxScalarKernel, false);
155 280828 : registerMooseObjectTask("add_dirac_kernel", DiracKernel, false);
156 280828 : appendMooseObjectTask ("add_dirac_kernel", VectorDiracKernel);
157 280828 : registerMooseObjectTask("add_dg_kernel", DGKernel, false);
158 280828 : registerMooseObjectTask("add_fv_kernel", FVKernel, false);
159 280828 : registerMooseObjectTask("add_linear_fv_kernel", LinearFVKernel, false);
160 280828 : registerMooseObjectTask("add_fv_bc", FVBoundaryCondition, false);
161 280828 : registerMooseObjectTask("add_linear_fv_bc", LinearFVBoundaryCondition, false);
162 280828 : registerMooseObjectTask("add_fv_ik", FVInterfaceKernel, false);
163 280828 : registerMooseObjectTask("add_interface_kernel", InterfaceKernel, false);
164 280828 : appendMooseObjectTask ("add_interface_kernel", VectorInterfaceKernel);
165 280828 : registerMooseObjectTask("add_constraint", Constraint, false);
166 280828 : registerMooseObjectTask("add_hybridized_kernel", HDGKernel, false);
167 280828 : registerMooseObjectTask("add_hybridized_integrated_bc", HDGIntegratedBC, false);
168 :
169 280828 : registerMooseObjectTask("add_ic", InitialCondition, false);
170 280828 : appendMooseObjectTask ("add_ic", ScalarInitialCondition);
171 :
172 280828 : registerMooseObjectTask("add_fv_ic", FVInitialCondition, false);
173 :
174 280828 : registerMooseObjectTask("add_damper", Damper, false);
175 280828 : registerMooseObjectTask("setup_predictor", Predictor, false);
176 280828 : registerMooseObjectTask("add_time_steppers", TimeStepper, false);
177 280828 : registerMooseObjectTask("add_time_stepper", TimeStepper, false);
178 140414 : registerTask ("compose_time_stepper", true);
179 280828 : registerMooseObjectTask("setup_time_integrators", TimeIntegrator, false);
180 280828 : registerMooseObjectTask("setup_time_integrator", TimeIntegrator, false);
181 280828 : registerMooseObjectTask("add_convergence", Convergence, false);
182 :
183 280828 : registerMooseObjectTask("add_preconditioning", MoosePreconditioner, false);
184 280828 : registerMooseObjectTask("add_field_split", Split, false);
185 :
186 280828 : registerMooseObjectTask("add_mesh_division", MeshDivision, false);
187 280828 : registerMooseObjectTask("add_user_object", UserObject, false);
188 280828 : appendMooseObjectTask ("add_user_object", Postprocessor);
189 280828 : appendDeprecatedMooseObjectTask("add_user_object", Corrector);
190 280828 : registerMooseObjectTask("add_corrector", Corrector, false);
191 280828 : appendDeprecatedMooseObjectTask("add_user_object", MeshModifier);
192 280828 : registerMooseObjectTask("add_mesh_modifier", MeshModifier, false);
193 :
194 280828 : registerMooseObjectTask("add_postprocessor", Postprocessor, false);
195 280828 : registerMooseObjectTask("add_vector_postprocessor", VectorPostprocessor, false);
196 280828 : registerMooseObjectTask("add_reporter", Reporter, false);
197 280828 : registerMooseObjectTask("add_positions", Positions, false);
198 280828 : registerMooseObjectTask("add_times", Times, false);
199 :
200 280828 : registerMooseObjectTask("add_indicator", Indicator, false);
201 280828 : registerMooseObjectTask("add_marker", Marker, false);
202 :
203 280828 : registerMooseObjectTask("add_multi_app", MultiApp, false);
204 280828 : registerMooseObjectTask("add_transfer", Transfer, false);
205 :
206 280828 : registerMooseObjectTask("add_output", Output, false);
207 :
208 280828 : registerMooseObjectTask("add_control", Control, false);
209 280828 : registerMooseObjectTask("add_chain_control", ChainControl, false);
210 280828 : registerMooseObjectTask("add_partitioner", MoosePartitioner, false);
211 :
212 : // clang-format on
213 :
214 140414 : registerTask("dynamic_object_registration", false);
215 140414 : registerTask("common_output", true);
216 140414 : registerTask("setup_recover_file_base", true);
217 140414 : registerTask("recover_meta_data", true);
218 :
219 140414 : registerTask("add_bounds_vectors", false);
220 140414 : registerTask("add_periodic_bc", false);
221 140414 : registerTask("add_aux_variable", false);
222 140414 : registerTask("add_external_aux_variables", true);
223 140414 : registerTask("add_variable", false);
224 140414 : registerTask("add_mortar_variable", false);
225 :
226 140414 : registerTask("execute_mesh_generators", true);
227 140414 : registerTask("uniform_refine_mesh", false);
228 140414 : registerTask("prepare_mesh", false);
229 140414 : registerTask("delete_remote_elements_after_late_geometric_ghosting", false);
230 140414 : registerTask("setup_mesh_complete", true); // calls prepare
231 140414 : registerTask("post_mesh_prepared", false);
232 140414 : registerTask("add_geometric_rm", false);
233 140414 : registerTask("attach_geometric_rm", true);
234 140414 : registerTask("attach_geometric_rm_final", true);
235 :
236 140414 : registerTask("init_displaced_problem", false);
237 :
238 140414 : registerTask("add_algebraic_rm", false);
239 140414 : registerTask("attach_algebraic_rm", true);
240 140414 : registerTask("add_coupling_rm", false);
241 140414 : registerTask("attach_coupling_rm", true);
242 140414 : registerTask("init_problem", true);
243 140414 : registerTask("check_copy_nodal_vars", true);
244 140414 : registerTask("copy_nodal_vars", true);
245 140414 : registerTask("copy_nodal_aux_vars", true);
246 140414 : registerTask("copy_vars_physics", false);
247 140414 : registerTask("setup_postprocessor_data", false);
248 140414 : registerTask("setup_time_steppers", true);
249 :
250 140414 : registerTask("setup_dampers", true);
251 140414 : registerTask("check_integrity", true);
252 140414 : registerTask("resolve_optional_materials", true);
253 140414 : registerTask("check_integrity_early", true);
254 140414 : registerTask("check_integrity_early_physics", false);
255 140414 : registerTask("setup_quadrature", true);
256 140414 : registerTask("create_tagged_matrices", true);
257 :
258 140414 : registerTask("mesh_modifiers", false);
259 :
260 : /// Additional Actions
261 140414 : registerTask("no_action", false); // Used for Empty Action placeholders
262 140414 : registerTask("set_global_params", false);
263 140414 : registerTask("setup_adaptivity", false);
264 140414 : registerTask("meta_action", false);
265 140414 : registerTask("setup_residual_debug", false);
266 140414 : registerTask("setup_oversampling", false);
267 140414 : registerTask("deprecated_block", false);
268 140414 : registerTask("set_adaptivity_options", false);
269 140414 : registerTask("add_mortar_interface", false);
270 140414 : registerTask("coupling_functor_check", true);
271 140414 : registerTask("add_master_action_material", false);
272 140414 : registerTask("setup_projected_properties", false);
273 140414 : registerTask("create_application_block", false);
274 :
275 : // Dummy Actions (useful for sync points in the dependencies)
276 140414 : registerTask("setup_function_complete", false);
277 140414 : registerTask("setup_variable_complete", false);
278 140414 : registerTask("setup_executioner_complete", false);
279 140414 : registerTask("ready_to_init", true);
280 :
281 : // Output related actions
282 140414 : registerTask("add_output_aux_variables", true);
283 140414 : registerTask("check_output", true);
284 140414 : registerTask("declare_late_reporters", true);
285 :
286 140414 : registerTask("create_problem_default", true);
287 140414 : registerTask("create_problem_custom", false);
288 140414 : registerTask("create_problem_complete", false);
289 :
290 140414 : registerTask("add_default_nonlinear_convergence", true);
291 140414 : registerTask("add_default_multiapp_fixed_point_convergence", true);
292 140414 : registerTask("add_default_steady_state_convergence", true);
293 :
294 140414 : registerTask("chain_control_setup", true);
295 140414 : registerTask("start_webservercontrol", true);
296 :
297 : // Action for setting up the signal-based checkpoint
298 140414 : registerTask("auto_checkpoint_action", true);
299 : /**************************/
300 : /****** Dependencies ******/
301 : /**************************/
302 : /**
303 : * The following is the default set of action dependencies for a basic MOOSE problem. The
304 : * formatting of this string is important. Each line represents a set of dependencies that depend
305 : * on the previous line. Items on the same line have equal weight and can be executed in any
306 : * order.
307 : *
308 : * Additional dependencies can be inserted later inside of user applications with calls to
309 : * ActionWarehouse::addDependency("task", "pre_req")
310 : */
311 :
312 : // clang-format off
313 140414 : syntax.addDependencySets("(meta_action)"
314 : "(meta_action_component)"
315 : "(dynamic_object_registration)"
316 : "(common_output)"
317 : "(set_global_params)"
318 : "(setup_recover_file_base)"
319 : "(check_copy_nodal_vars)"
320 : "(setup_mesh)"
321 : "(add_geometric_rm)"
322 : "(add_partitioner)"
323 : "(add_mesh_generator)"
324 : "(create_added_mesh_generators)"
325 : "(append_mesh_generator)"
326 : "(execute_mesh_generators)"
327 : "(recover_meta_data)"
328 : "(set_mesh_base)"
329 : "(attach_geometric_rm)"
330 : "(init_mesh)"
331 : "(prepare_mesh)"
332 : "(add_mortar_interface)"
333 : "(uniform_refine_mesh)"
334 : "(setup_mesh_complete)"
335 : "(post_mesh_prepared)"
336 : "(determine_system_type)"
337 : "(create_problem)"
338 : "(create_problem_custom)"
339 : "(create_problem_default)"
340 : "(create_problem_complete)"
341 : "(init_displaced_problem)" // Problem must be init-ed before we start adding functors
342 : "(add_function)" // Functions can depend on scalar variables & PPs, but this dependence can be
343 : // added on initialSetup() rather than construction
344 : "(init_component_physics)" // components must add their blocks to physics before init_physics
345 : "(init_physics)"
346 : "(setup_postprocessor_data)"
347 : "(setup_time_integrator, setup_time_integrators)"
348 : "(setup_executioner)"
349 : "(setup_executioner_complete)"
350 : "(setup_component)" // no particular reason for that placement
351 : "(read_executor)"
352 : "(add_executor)"
353 : "(check_integrity_early)"
354 : "(setup_predictor)"
355 : "(add_aux_variable, add_variable, add_elemental_field_variable,"
356 : " add_external_aux_variables)"
357 : "(add_mortar_variable)"
358 : "(setup_variable_complete)"
359 : "(check_integrity_early_physics)" // checks that systems and variables are consistent
360 : "(setup_quadrature)"
361 : "(add_convergence)"
362 : "(add_default_nonlinear_convergence,"
363 : " add_default_multiapp_fixed_point_convergence,"
364 : " add_default_steady_state_convergence)"
365 : "(add_positions)"
366 : "(add_periodic_bc)"
367 : "(add_user_object, add_corrector, add_mesh_modifier)"
368 : "(add_field_split)" // split objects required before field split preconditioner itself
369 : "(add_preconditioning)" // preconditioner may introduce objects such as static condensation which influence the underlying types of tagged matrices
370 : "(create_tagged_matrices)"
371 : "(add_distribution)"
372 : "(add_sampler)"
373 : "(setup_function_complete)"
374 : "(setup_adaptivity)"
375 : "(set_adaptivity_options)"
376 : "(add_ic, add_fv_ic)"
377 : "(add_constraint)"
378 : "(add_times)"
379 : "(add_time_stepper, add_time_steppers)"
380 : "(compose_time_stepper)"
381 : "(setup_time_steppers)"
382 : "(ready_to_init)"
383 : "(setup_dampers)"
384 : "(setup_residual_debug)"
385 : "(add_bounds_vectors)"
386 : "(add_mesh_division)" // NearestPositionsDivision uses a Positions
387 : "(add_multi_app)"
388 : "(add_transfer)"
389 : "(copy_nodal_vars, copy_nodal_aux_vars, copy_vars_physics)"
390 : "(add_material)"
391 : "(add_master_action_material)"
392 : "(add_functor_material)"
393 : "(setup_projected_properties)"
394 : "(add_output_aux_variables)"
395 : "(add_output)"
396 : "(auto_checkpoint_action)"
397 : "(add_postprocessor)"
398 : "(add_vector_postprocessor)" // MaterialVectorPostprocessor requires this
399 : // to be after material objects are created.
400 : "(add_reporter)"
401 : "(declare_late_reporters)"
402 : "(add_aux_kernel, add_bc, add_damper, add_dirac_kernel, add_kernel,"
403 : " add_nodal_kernel, add_dg_kernel, add_fv_kernel, add_linear_fv_kernel,"
404 : " add_fv_bc, add_linear_fv_bc, add_fv_ik, add_interface_kernel,"
405 : " add_scalar_kernel, add_aux_scalar_kernel, add_indicator, add_marker,"
406 : " add_bound, add_hybridized_kernel, add_hybridized_integrated_bc)"
407 : "(resolve_optional_materials)"
408 : "(add_algebraic_rm)"
409 : "(add_coupling_rm)"
410 : "(attach_geometric_rm_final)"
411 : "(attach_algebraic_rm)"
412 : "(attach_coupling_rm)"
413 : "(coupling_functor_check)"
414 : "(delete_remote_elements_after_late_geometric_ghosting)"
415 : "(init_problem)"
416 : "(add_control, add_chain_control)"
417 : "(chain_control_setup)"
418 : "(start_webservercontrol)"
419 : "(check_output)"
420 : "(check_integrity)"
421 : "(create_application_block)");
422 : // clang-format on
423 :
424 : #ifdef MOOSE_MFEM_ENABLED
425 92754 : registerTask("add_mfem_problem_operator", true);
426 185508 : addTaskDependency("add_mfem_problem_operator", "init_mesh");
427 185508 : addTaskDependency("add_variable", "add_mfem_problem_operator");
428 185508 : addTaskDependency("add_aux_variable", "add_mfem_problem_operator");
429 185508 : addTaskDependency("add_elemental_field_variable", "add_mfem_problem_operator");
430 185508 : addTaskDependency("add_bc", "add_mfem_problem_operator");
431 185508 : addTaskDependency("add_kernel", "add_mfem_problem_operator");
432 :
433 : // add SubMeshes
434 185508 : registerMooseObjectTask("add_mfem_submeshes", MFEMSubMesh, false);
435 185508 : addTaskDependency("add_mfem_submeshes", "create_problem_complete");
436 :
437 : // add SubMesh transfers
438 185508 : appendMooseObjectTask("add_transfer", MFEMSubMeshTransfer);
439 :
440 : // add FESpaces
441 185508 : registerMooseObjectTask("add_mfem_fespaces", MFEMFESpace, false);
442 185508 : appendMooseObjectTask("add_mfem_fespaces", MFEMFECollection);
443 185508 : addTaskDependency("add_mfem_fespaces", "add_mfem_submeshes");
444 185508 : addTaskDependency("add_variable", "add_mfem_fespaces");
445 185508 : addTaskDependency("add_aux_variable", "add_mfem_fespaces");
446 185508 : addTaskDependency("add_elemental_field_variable", "add_mfem_fespaces");
447 185508 : addTaskDependency("add_kernel", "add_mfem_fespaces");
448 :
449 : // set mesh FE space
450 92754 : registerTask("set_mesh_fe_space", true);
451 185508 : addTaskDependency("set_mesh_fe_space", "add_variable");
452 185508 : addTaskDependency("set_mesh_fe_space", "init_mesh");
453 :
454 : // add preconditioning.
455 185508 : registerMooseObjectTask("add_mfem_preconditioner", MFEMSolverBase, false);
456 185508 : addTaskDependency("add_mfem_preconditioner", "add_mfem_problem_operator");
457 185508 : addTaskDependency("add_mfem_preconditioner", "add_variable");
458 :
459 : // add solver.
460 185508 : registerMooseObjectTask("add_mfem_solver", MFEMSolverBase, true);
461 185508 : addTaskDependency("add_mfem_solver", "add_mfem_preconditioner");
462 185508 : addTaskDependency("add_mfem_solver", "add_mfem_problem_operator");
463 : #endif
464 :
465 140414 : registerTask("parse_neml2", /*required=*/false);
466 280828 : addTaskDependency("add_material", "parse_neml2");
467 210621 : addTaskDependency("add_user_object", "parse_neml2");
468 70207 : }
469 :
470 : /**
471 : * Multiple Action class can be associated with a single input file section, in which case all
472 : * associated Actions will be created and "acted" on when the associated input file section is
473 : * seen.*
474 : *
475 : * Example:
476 : * "setup_mesh" <-----------> SetupMeshAction <---------
477 : * \
478 : * [Mesh]
479 : * /
480 : * "setup_mesh_complete" <---> SetupMeshCompleteAction <-
481 : *
482 : *
483 : * Action classes can also be registered to act on more than one input file section for a different
484 : * task if similar logic can work in multiple cases
485 : *
486 : * Example:
487 : * "add_variable" <----- -> [Variables/ *]
488 : * \ /
489 : * CopyNodalVarsAction
490 : * / \
491 : * "add_aux_variable" <- -> [AuxVariables/ *]
492 : *
493 : *
494 : * Note: Placeholder "no_action" actions must be put in places where it is possible to match an
495 : * object with a star or a more specific parent later on. (i.e. where one needs to negate the
496 : * '*' matching prematurely).
497 : */
498 : void
499 0 : registerActions(Syntax & syntax, ActionFactory & action_factory)
500 : {
501 0 : mooseDeprecated("use registerAll instead of registerActions");
502 0 : registerActions(syntax, action_factory, {"MooseApp"});
503 0 : }
504 :
505 : void
506 70207 : registerActions(Syntax & syntax,
507 : ActionFactory & action_factory,
508 : const std::set<std::string> & obj_labels)
509 : {
510 70207 : Registry::registerActionsTo(action_factory, obj_labels);
511 :
512 : // Add these actions here so they are always executed last, without setting any dependency
513 140414 : registerTask("dump_objects", false);
514 70207 : registerTask("finish_input_file_output", false);
515 70207 : }
516 :
517 : void
518 70207 : associateSyntaxInner(Syntax & syntax, ActionFactory & /*action_factory*/)
519 : {
520 : /**
521 : * Note: the optional third parameter is used to differentiate which task is
522 : * satisfied based on the syntax encountered for classes which are registered
523 : * to satisfy more than one task
524 : */
525 561656 : registerSyntax("DiffusionCG", "Physics/Diffusion/ContinuousGalerkin/*");
526 561656 : registerSyntax("DiffusionFV", "Physics/Diffusion/FiniteVolume/*");
527 :
528 561656 : registerSyntax("AddActionComponentAction", "ActionComponents/*");
529 561656 : registerSyntax("CombineComponentsMeshes", "ActionComponents");
530 :
531 561656 : registerSyntaxTask("CopyNodalVarsAction", "Variables/*", "check_copy_nodal_vars");
532 561656 : registerSyntaxTask("CopyNodalVarsAction", "Variables/*", "copy_nodal_vars");
533 561656 : registerSyntaxTask("CopyNodalVarsAction", "AuxVariables/*", "check_copy_nodal_vars");
534 561656 : registerSyntaxTask("CopyNodalVarsAction", "AuxVariables/*", "copy_nodal_aux_vars");
535 :
536 561656 : registerSyntaxTask("AddKernelAction", "Kernels/*", "add_kernel");
537 561656 : registerSyntaxTask("AddNodalKernelAction", "NodalKernels/*", "add_nodal_kernel");
538 561656 : registerSyntaxTask("AddKernelAction", "AuxKernels/*", "add_aux_kernel");
539 :
540 561656 : registerSyntaxTask("AddHDGKernelAction", "HDGKernels/*", "add_hybridized_kernel");
541 :
542 561656 : registerSyntax("AddAuxKernelAction", "AuxVariables/*/AuxKernel");
543 :
544 561656 : registerSyntaxTask("AddScalarKernelAction", "ScalarKernels/*", "add_scalar_kernel");
545 561656 : registerSyntaxTask("AddScalarKernelAction", "AuxScalarKernels/*", "add_aux_scalar_kernel");
546 :
547 561656 : registerSyntaxTask("AddBCAction", "BCs/*", "add_bc");
548 :
549 561656 : registerSyntax("CreateProblemAction", "Problem");
550 561656 : registerSyntax("DynamicObjectRegistrationAction", "Problem");
551 :
552 561656 : registerSyntax("SetupMeshAction", "Mesh");
553 561656 : registerSyntax("SetupMeshCompleteAction", "Mesh");
554 : // Components should be able create a Mesh without a Mesh block
555 561656 : registerSyntax("CreateMeshSetupActionsForComponents", "ActionComponents");
556 561656 : registerSyntax("CreateDisplacedProblemAction", "Mesh");
557 561656 : registerSyntax("DisplayGhostingAction", "Mesh");
558 561656 : registerSyntax("AddMeshGeneratorAction", "Mesh/*");
559 561656 : registerSyntaxTask("EmptyAction", "Mesh/BatchMeshGeneratorAction", "no_action");
560 561656 : registerSyntax("BatchMeshGeneratorAction", "Mesh/BatchMeshGeneratorAction/*");
561 561656 : registerSyntax("ElementIDOutputAction", "Mesh");
562 280828 : syntax.registerSyntaxType("Mesh/*", "MeshGeneratorName");
563 :
564 561656 : registerSyntax("AddFunctionAction", "Functions/*");
565 280828 : syntax.registerSyntaxType("Functions/*", "FunctionName");
566 :
567 561656 : registerSyntax("AddMeshDivisionAction", "MeshDivisions/*");
568 280828 : syntax.registerSyntaxType("MeshDivisions/*", "MeshDivisionName");
569 561656 : registerSyntax("AddConvergenceAction", "Convergence/*");
570 280828 : syntax.registerSyntaxType("Convergence/*", "ConvergenceName");
571 :
572 561656 : registerSyntax("GlobalParamsAction", "GlobalParams");
573 :
574 561656 : registerSyntax("AddDistributionAction", "Distributions/*");
575 280828 : syntax.registerSyntaxType("Distributions/*", "DistributionName");
576 :
577 561656 : registerSyntax("AddSamplerAction", "Samplers/*");
578 280828 : syntax.registerSyntaxType("Samplers/*", "SamplerName");
579 :
580 561656 : registerSyntax("SetupDebugAction", "Debug");
581 561656 : registerSyntax("SetupResidualDebugAction", "Debug");
582 :
583 : /// Variable/AuxVariable Actions
584 561656 : registerSyntax("AddVariableAction", "Variables/*");
585 280828 : syntax.registerSyntaxType("Variables/*", "VariableName");
586 280828 : syntax.registerSyntaxType("Variables/*", "NonlinearVariableName");
587 :
588 561656 : registerSyntax("AddICAction", "Variables/*/InitialCondition");
589 561656 : registerSyntax("AddFVICAction", "Variables/*/FVInitialCondition");
590 :
591 561656 : registerSyntax("AddAuxVariableAction", "AuxVariables/*");
592 280828 : syntax.registerSyntaxType("AuxVariables/*", "VariableName");
593 280828 : syntax.registerSyntaxType("AuxVariables/*", "AuxVariableName");
594 :
595 561656 : registerSyntax("AddICAction", "AuxVariables/*/InitialCondition");
596 561656 : registerSyntax("AddFVICAction", "AuxVariables/*/FVInitialCondition");
597 :
598 561656 : registerSyntaxTask("EmptyAction", "BCs/Periodic", "no_action"); // placeholder
599 561656 : registerSyntax("AddPeriodicBCAction", "BCs/Periodic/*");
600 :
601 561656 : registerSyntaxTask("AddInitialConditionAction", "ICs/*", "add_ic");
602 561656 : registerSyntaxTask("AddFVInitialConditionAction", "FVICs/*", "add_fv_ic");
603 :
604 561656 : registerSyntax("AddMaterialAction", "Materials/*");
605 280828 : syntax.registerSyntaxType("Materials/*", "MaterialName");
606 :
607 561656 : registerSyntax("AddFunctorMaterialAction", "FunctorMaterials/*");
608 280828 : syntax.registerSyntaxType("FunctorMaterials/*", "MaterialName");
609 :
610 561656 : registerSyntax("AddPostprocessorAction", "Postprocessors/*");
611 280828 : syntax.registerSyntaxType("Postprocessors/*", "PostprocessorName");
612 280828 : syntax.registerSyntaxType("Postprocessors/*", "UserObjectName");
613 :
614 561656 : registerSyntax("AddVectorPostprocessorAction", "VectorPostprocessors/*");
615 280828 : syntax.registerSyntaxType("VectorPostprocessors/*", "VectorPostprocessorName");
616 :
617 561656 : registerSyntax("AddReporterAction", "Reporters/*");
618 280828 : syntax.registerSyntaxType("Reporters/*", "ReporterName");
619 :
620 561656 : registerSyntax("AddPositionsAction", "Positions/*");
621 280828 : syntax.registerSyntaxType("Positions/*", "PositionsName");
622 :
623 561656 : registerSyntax("AddTimesAction", "Times/*");
624 280828 : syntax.registerSyntaxType("Times/*", "TimesName");
625 :
626 561656 : registerSyntax("AddDamperAction", "Dampers/*");
627 :
628 561656 : registerSyntax("AddOutputAction", "Outputs/*");
629 561656 : registerSyntax("CommonOutputAction", "Outputs");
630 561656 : registerSyntax("MaterialOutputAction", "Outputs");
631 561656 : registerSyntax("AutoCheckpointAction", "Outputs");
632 280828 : syntax.registerSyntaxType("Outputs/*", "OutputName");
633 :
634 : // Note: Preconditioner Actions will be built by this setup action
635 561656 : registerSyntax("SetupPreconditionerAction", "Preconditioning/*");
636 561656 : registerSyntax("AddFieldSplitAction", "Preconditioning/*/*");
637 :
638 561656 : registerSyntax("CreateExecutionerAction", "Executioner");
639 561656 : registerSyntax("ReadExecutorParamsAction", "Executors/*");
640 :
641 561656 : registerSyntaxTask("AddTimeStepperAction", "Executioner/TimeSteppers/*", "add_time_steppers");
642 561656 : registerSyntaxTask("AddTimeStepperAction", "Executioner/TimeStepper", "add_time_stepper");
643 561656 : registerSyntaxTask(
644 : "ComposeTimeStepperAction", "Executioner/TimeSteppers", "compose_time_stepper");
645 561656 : registerSyntaxTask(
646 : "SetupTimeIntegratorAction", "Executioner/TimeIntegrators/*", "setup_time_integrators");
647 561656 : registerSyntaxTask(
648 : "SetupTimeIntegratorAction", "Executioner/TimeIntegrator", "setup_time_integrator");
649 280828 : syntax.registerSyntaxType("Executors/*", "ExecutorName");
650 :
651 561656 : registerSyntax("SetupQuadratureAction", "Executioner/Quadrature");
652 561656 : registerSyntax("SetupPredictorAction", "Executioner/Predictor");
653 : #ifdef LIBMESH_ENABLE_AMR
654 561656 : registerSyntax("AdaptivityAction", "Executioner/Adaptivity");
655 : #endif
656 :
657 561656 : registerSyntax("PartitionerAction", "Mesh/Partitioner");
658 :
659 561656 : registerSyntax("AddDiracKernelAction", "DiracKernels/*");
660 :
661 561656 : registerSyntax("AddDGKernelAction", "DGKernels/*");
662 561656 : registerSyntax("AddFVKernelAction", "FVKernels/*");
663 561656 : registerSyntax("AddFVBCAction", "FVBCs/*");
664 561656 : registerSyntax("AddLinearFVBCAction", "LinearFVBCs/*");
665 561656 : registerSyntax("AddFVInterfaceKernelAction", "FVInterfaceKernels/*");
666 561656 : registerSyntax("CheckFVBCAction", "FVBCs");
667 :
668 561656 : registerSyntax("AddLinearFVKernelAction", "LinearFVKernels/*");
669 :
670 561656 : registerSyntax("AddInterfaceKernelAction", "InterfaceKernels/*");
671 :
672 561656 : registerSyntax("AddConstraintAction", "Constraints/*");
673 :
674 561656 : registerSyntax("AddControlAction", "Controls/*");
675 561656 : registerSyntax("AddChainControlAction", "ChainControls/*");
676 561656 : registerSyntax("AddBoundAction", "Bounds/*");
677 561656 : registerSyntax("AddBoundsVectorsAction", "Bounds");
678 :
679 : // UserObject and some derived classes
680 561656 : registerSyntax("AddUserObjectAction", "UserObjects/*");
681 280828 : syntax.registerSyntaxType("UserObjects/*", "UserObjectName");
682 561656 : registerSyntax("AddCorrectorAction", "Correctors/*");
683 280828 : syntax.registerSyntaxType("Correctors/*", "UserObjectName");
684 561656 : registerSyntax("AddMeshModifiersAction", "MeshModifiers/*");
685 280828 : syntax.registerSyntaxType("MeshModifiers/*", "UserObjectName");
686 :
687 561656 : registerSyntax("AddNodalNormalsAction", "NodalNormals");
688 :
689 : // Indicator
690 561656 : registerSyntax("AddElementalFieldAction", "Adaptivity/Indicators/*");
691 561656 : registerSyntax("AddIndicatorAction", "Adaptivity/Indicators/*");
692 280828 : syntax.registerSyntaxType("Adaptivity/Indicators/*", "IndicatorName");
693 :
694 : // Marker
695 561656 : registerSyntax("AddElementalFieldAction", "Adaptivity/Markers/*");
696 561656 : registerSyntax("AddMarkerAction", "Adaptivity/Markers/*");
697 280828 : syntax.registerSyntaxType("Adaptivity/Markers/*", "MarkerName");
698 :
699 : // New Adaptivity System
700 561656 : registerSyntax("SetAdaptivityOptionsAction", "Adaptivity");
701 :
702 : // Deprecated Block
703 561656 : registerSyntax("DeprecatedBlockAction", "DeprecatedBlock");
704 :
705 : // Multi Apps
706 561656 : registerSyntax("AddMultiAppAction", "MultiApps/*");
707 280828 : syntax.registerSyntaxType("MultiApps/*", "MultiAppName");
708 :
709 : // Transfers
710 561656 : registerSyntax("AddTransferAction", "Transfers/*");
711 :
712 : // Material derivative test
713 561656 : registerSyntaxTask("EmptyAction", "Debug/MaterialDerivativeTest", "no_action"); // placeholder
714 561656 : registerSyntax("MaterialDerivativeTestAction", "Debug/MaterialDerivativeTest/*");
715 :
716 561656 : registerSyntax("ProjectedStatefulMaterialStorageAction", "ProjectedStatefulMaterialStorage/*");
717 :
718 : // Application Block System
719 561656 : registerSyntax("CreateApplicationBlockAction", "Application");
720 :
721 : #ifdef MOOSE_MFEM_ENABLED
722 371016 : registerSyntaxTask("AddMFEMSubMeshAction", "SubMeshes/*", "add_mfem_submeshes");
723 371016 : registerSyntaxTask("AddMFEMFESpaceAction", "FESpaces/*", "add_mfem_fespaces");
724 371016 : registerSyntaxTask("AddMFEMPreconditionerAction", "Preconditioner/*", "add_mfem_preconditioner");
725 371016 : registerSyntaxTask("AddMFEMSolverAction", "Solver", "add_mfem_solver");
726 : #endif
727 :
728 561656 : registerSyntax("NEML2ActionCommon", "NEML2");
729 491449 : registerSyntax("NEML2Action", "NEML2/*");
730 :
731 70207 : addActionTypes(syntax);
732 70207 : }
733 :
734 : void
735 0 : associateSyntax(Syntax & syntax, ActionFactory & action_factory)
736 : {
737 0 : associateSyntaxInner(syntax, action_factory);
738 0 : registerActions(syntax, action_factory);
739 0 : }
740 :
741 : void
742 0 : setSolverDefaults(FEProblemBase & problem)
743 : {
744 : // May be a touch expensive to create a new DM every time, but probably safer to do it this way
745 0 : Moose::PetscSupport::petscSetDefaults(problem);
746 0 : }
747 :
748 : MPI_Comm
749 1324353 : swapLibMeshComm(MPI_Comm new_comm)
750 : {
751 1324353 : MPI_Comm old_comm = PETSC_COMM_WORLD;
752 1324353 : PETSC_COMM_WORLD = new_comm;
753 1324353 : return old_comm;
754 : }
755 :
756 : static bool _color_console = isatty(fileno(stdout));
757 :
758 : bool
759 11919724 : colorConsole()
760 : {
761 11919724 : return _color_console;
762 : }
763 :
764 : bool
765 57511 : setColorConsole(bool use_color, bool force)
766 : {
767 57511 : _color_console = (isatty(fileno(stdout)) || force) && use_color;
768 57511 : return _color_console;
769 : }
770 :
771 2795794 : ScopedThrowOnError::ScopedThrowOnError(const bool throw_on_error)
772 2795794 : : _throw_on_error_before(Moose::_throw_on_error)
773 : {
774 : mooseAssert(!libMesh::Threads::in_threads, "Cannot be used in threads");
775 2795794 : Moose::_throw_on_error = throw_on_error;
776 2795794 : }
777 :
778 2795794 : ScopedThrowOnError::ScopedThrowOnError() : ScopedThrowOnError(true) {}
779 :
780 2795794 : ScopedThrowOnError::~ScopedThrowOnError() { Moose::_throw_on_error = _throw_on_error_before; }
781 :
782 : std::string
783 17686 : hitMessagePrefix(const hit::Node & node)
784 : {
785 : // Strip meaningless line and column number for CLI args
786 17686 : if (node.filename() == "CLI_ARGS")
787 1478 : return "CLI_ARGS:\n";
788 : // If using the root node, don't add line info
789 16947 : if (node.isRoot())
790 4 : return node.filename() + ":\n";
791 16943 : return node.fileLocation() + ":\n";
792 : }
793 :
794 : bool _warnings_are_errors = false;
795 : bool _deprecated_is_error = false;
796 : bool _throw_on_error = false;
797 : bool _throw_on_warning = false;
798 : int interrupt_signal_number = 0;
799 : bool show_trace = true;
800 : bool show_multiple = false;
801 :
802 : } // namespace Moose
|
