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