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