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