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