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