Loading [MathJax]/extensions/tex2jax.js
https://mooseframework.inl.gov
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Moose.C
Go to the documentation of this file.
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_NONLINEAR_CONVERGENCE = registerDefaultExecFlag("NONLINEAR_CONVERGENCE");
31 const ExecFlagType EXEC_NONLINEAR = registerDefaultExecFlag("NONLINEAR");
32 const ExecFlagType EXEC_POSTCHECK = registerDefaultExecFlag("POSTCHECK");
33 const ExecFlagType EXEC_TIMESTEP_END = registerDefaultExecFlag("TIMESTEP_END");
34 const ExecFlagType EXEC_TIMESTEP_BEGIN = registerDefaultExecFlag("TIMESTEP_BEGIN");
36  registerDefaultExecFlag("MULTIAPP_FIXED_POINT_END");
38  registerDefaultExecFlag("MULTIAPP_FIXED_POINT_BEGIN");
39 const ExecFlagType EXEC_FINAL = registerDefaultExecFlag("FINAL");
40 const ExecFlagType EXEC_FORCED = registerExecFlag("FORCED");
41 const ExecFlagType EXEC_FAILED = registerExecFlag("FAILED");
42 const ExecFlagType EXEC_CUSTOM = registerDefaultExecFlag("CUSTOM");
43 const ExecFlagType EXEC_SUBDOMAIN = registerExecFlag("SUBDOMAIN");
44 const ExecFlagType EXEC_ALWAYS = registerExecFlag("ALWAYS");
45 const ExecFlagType EXEC_PRE_DISPLACE = registerExecFlag("PRE_DISPLACE");
46 const ExecFlagType EXEC_SAME_AS_MULTIAPP = registerExecFlag("SAME_AS_MULTIAPP");
47 const ExecFlagType EXEC_PRE_MULTIAPP_SETUP = registerExecFlag("PRE_MULTIAPP_SETUP");
48 const ExecFlagType EXEC_TRANSFER = registerExecFlag("TRANSFER");
49 const ExecFlagType EXEC_PRE_KERNELS = registerExecFlag("PRE_KERNELS");
50 
51 namespace Moose
52 {
53 
54 void associateSyntaxInner(Syntax & syntax, ActionFactory & action_factory);
55 
56 void
58 {
59  registerObjects(f, {"MooseApp"});
60  associateSyntaxInner(s, af);
61  registerActions(s, af, {"MooseApp"});
62  registerAppDataFilePath("moose");
63  registerRepository("moose", "github.com/idaholab/moose");
64 }
65 
66 void
68 {
69  mooseDeprecated("use registerAll instead of registerObjects");
70  registerObjects(factory, {"MooseApp"});
71 }
72 
73 void
74 registerObjects(Factory & factory, const std::set<std::string> & obj_labels)
75 {
76  Registry::registerObjectsTo(factory, obj_labels);
77 }
78 
79 void
81 {
94  // clang-format off
95  /**************************/
96  /**** Register Actions ****/
97  /**************************/
98  registerMooseObjectTask("create_problem", Problem, false);
99  registerMooseObjectTask("setup_executioner", Executioner, false);
100  registerMooseObjectTask("read_executor", Executor, false);
101  registerTask("add_executor", true);
102 
103  // TODO Organize these somewhere
104  registerTask("init_physics", false);
105  registerTask("init_component_physics", false);
106  registerTask("meta_action_component", false);
107  registerTask("setup_component", false);
108  // 'list_component' is used to retrieve ActionComponents for the syntax JSON
109  registerTask("list_component", false);
110 
111  // This task does not construct an object, but it needs all of the parameters that
112  // would normally be used to construct an object.
113  registerMooseObjectTask("determine_system_type", Executioner, true);
114 
115  registerMooseObjectTask("setup_mesh", MooseMesh, false);
116  registerMooseObjectTask("set_mesh_base", MooseMesh, false);
117  registerMooseObjectTask("init_mesh", MooseMesh, false);
118  registerMooseObjectTask("add_mesh_generator", MeshGenerator, false);
119  registerTask("create_added_mesh_generators", true);
120  registerMooseObjectTask("append_mesh_generator", MeshGenerator, false);
121 
122  registerMooseObjectTask("add_kernel", Kernel, false);
123  appendMooseObjectTask ("add_kernel", EigenKernel);
124  appendMooseObjectTask ("add_kernel", VectorKernel);
125  appendMooseObjectTask ("add_kernel", ArrayKernel);
126 
127  registerMooseObjectTask("add_variable", MooseVariableBase, false);
128  registerMooseObjectTask("add_aux_variable", MooseVariableBase, false);
129  registerMooseObjectTask("add_elemental_field_variable", MooseVariableBase, false);
130 
131  registerMooseObjectTask("add_nodal_kernel", NodalKernel, false);
132 
133  registerMooseObjectTask("add_functor_material", FunctorMaterial, false);
134  registerMooseObjectTask("add_material", MaterialBase, false);
135  appendDeprecatedMooseObjectTask("add_material", FunctorMaterial);
136  registerMooseObjectTask("add_bc", BoundaryCondition, false);
137 
138  registerMooseObjectTask("add_function", Function, false);
139  registerMooseObjectTask("add_distribution", Distribution, false);
140  registerMooseObjectTask("add_sampler", Sampler, false);
141 
142  registerMooseObjectTask("add_aux_kernel", AuxKernel, false);
143  appendMooseObjectTask ("add_aux_kernel", VectorAuxKernel);
144  appendMooseObjectTask ("add_aux_kernel", ArrayAuxKernel);
145  registerMooseObjectTask("add_bound", Bounds, false);
146 
147  registerMooseObjectTask("add_scalar_kernel", ScalarKernel, false);
148  registerMooseObjectTask("add_aux_scalar_kernel", AuxScalarKernel, false);
149  registerMooseObjectTask("add_dirac_kernel", DiracKernel, false);
150  appendMooseObjectTask ("add_dirac_kernel", VectorDiracKernel);
151  registerMooseObjectTask("add_dg_kernel", DGKernel, false);
152  registerMooseObjectTask("add_fv_kernel", FVKernel, false);
153  registerMooseObjectTask("add_linear_fv_kernel", LinearFVKernel, false);
154  registerMooseObjectTask("add_fv_bc", FVBoundaryCondition, false);
155  registerMooseObjectTask("add_linear_fv_bc", LinearFVBoundaryCondition, false);
156  registerMooseObjectTask("add_fv_ik", FVInterfaceKernel, false);
157  registerMooseObjectTask("add_interface_kernel", InterfaceKernel, false);
158  appendMooseObjectTask ("add_interface_kernel", VectorInterfaceKernel);
159  registerMooseObjectTask("add_constraint", Constraint, false);
160  registerMooseObjectTask("add_hybridized_kernel", HDGKernel, false);
161  registerMooseObjectTask("add_hybridized_integrated_bc", HDGIntegratedBC, false);
162 
163  registerMooseObjectTask("add_ic", InitialCondition, false);
164  appendMooseObjectTask ("add_ic", ScalarInitialCondition);
165 
166  registerMooseObjectTask("add_fv_ic", FVInitialCondition, false);
167 
168  registerMooseObjectTask("add_damper", Damper, false);
169  registerMooseObjectTask("setup_predictor", Predictor, false);
170  registerMooseObjectTask("add_time_steppers", TimeStepper, false);
171  registerMooseObjectTask("add_time_stepper", TimeStepper, false);
172  registerTask ("compose_time_stepper", true);
173  registerMooseObjectTask("setup_time_integrators", TimeIntegrator, false);
174  registerMooseObjectTask("setup_time_integrator", TimeIntegrator, false);
175  registerMooseObjectTask("add_convergence", Convergence, false);
176 
177  registerMooseObjectTask("add_preconditioning", MoosePreconditioner, false);
178  registerMooseObjectTask("add_field_split", Split, false);
179 
180  registerMooseObjectTask("add_mesh_division", MeshDivision, false);
181  registerMooseObjectTask("add_user_object", UserObject, false);
182  appendMooseObjectTask ("add_user_object", Postprocessor);
183  appendDeprecatedMooseObjectTask("add_user_object", Corrector);
184  registerMooseObjectTask("add_corrector", Corrector, false);
185  appendDeprecatedMooseObjectTask("add_user_object", MeshModifier);
186  registerMooseObjectTask("add_mesh_modifier", MeshModifier, false);
187 
188  registerMooseObjectTask("add_postprocessor", Postprocessor, false);
189  registerMooseObjectTask("add_vector_postprocessor", VectorPostprocessor, false);
190  registerMooseObjectTask("add_reporter", Reporter, false);
191  registerMooseObjectTask("add_positions", Positions, false);
192  registerMooseObjectTask("add_times", Times, false);
193 
194  registerMooseObjectTask("add_indicator", Indicator, false);
195  registerMooseObjectTask("add_marker", Marker, false);
196 
197  registerMooseObjectTask("add_multi_app", MultiApp, false);
198  registerMooseObjectTask("add_transfer", Transfer, false);
199 
200  registerMooseObjectTask("add_output", Output, false);
201 
202  registerMooseObjectTask("add_control", Control, false);
203  registerMooseObjectTask("add_chain_control", ChainControl, false);
204  registerMooseObjectTask("add_partitioner", MoosePartitioner, false);
205 
206  // clang-format on
207 
208  registerTask("dynamic_object_registration", false);
209  registerTask("common_output", true);
210  registerTask("setup_recover_file_base", true);
211  registerTask("recover_meta_data", true);
212 
213  registerTask("add_bounds_vectors", false);
214  registerTask("add_periodic_bc", false);
215  registerTask("add_aux_variable", false);
216  registerTask("add_external_aux_variables", true);
217  registerTask("add_variable", false);
218  registerTask("add_mortar_variable", false);
219 
220  registerTask("execute_mesh_generators", true);
221  registerTask("uniform_refine_mesh", false);
222  registerTask("prepare_mesh", false);
223  registerTask("delete_remote_elements_after_late_geometric_ghosting", false);
224  registerTask("setup_mesh_complete", true); // calls prepare
225  registerTask("post_mesh_prepared", false);
226  registerTask("add_geometric_rm", false);
227  registerTask("attach_geometric_rm", true);
228  registerTask("attach_geometric_rm_final", true);
229 
230  registerTask("init_displaced_problem", false);
231 
232  registerTask("add_algebraic_rm", false);
233  registerTask("attach_algebraic_rm", true);
234  registerTask("add_coupling_rm", false);
235  registerTask("attach_coupling_rm", true);
236  registerTask("init_problem", true);
237  registerTask("check_copy_nodal_vars", true);
238  registerTask("copy_nodal_vars", true);
239  registerTask("copy_nodal_aux_vars", true);
240  registerTask("copy_vars_physics", false);
241  registerTask("setup_postprocessor_data", false);
242  registerTask("setup_time_steppers", true);
243 
244  registerTask("setup_dampers", true);
245  registerTask("check_integrity", true);
246  registerTask("resolve_optional_materials", true);
247  registerTask("check_integrity_early", true);
248  registerTask("check_integrity_early_physics", false);
249  registerTask("setup_quadrature", true);
250 
251  registerTask("mesh_modifiers", false);
252 
254  registerTask("no_action", false); // Used for Empty Action placeholders
255  registerTask("set_global_params", false);
256  registerTask("setup_adaptivity", false);
257  registerTask("meta_action", false);
258  registerTask("setup_residual_debug", false);
259  registerTask("setup_oversampling", false);
260  registerTask("deprecated_block", false);
261  registerTask("set_adaptivity_options", false);
262  registerTask("add_mortar_interface", false);
263  registerTask("coupling_functor_check", true);
264  registerTask("add_master_action_material", false);
265  registerTask("setup_projected_properties", false);
266  registerTask("create_application_block", false);
267 
268  // Dummy Actions (useful for sync points in the dependencies)
269  registerTask("setup_function_complete", false);
270  registerTask("setup_variable_complete", false);
271  registerTask("setup_executioner_complete", false);
272  registerTask("ready_to_init", true);
273 
274  // Output related actions
275  registerTask("add_output_aux_variables", true);
276  registerTask("check_output", true);
277  registerTask("declare_late_reporters", true);
278 
279  registerTask("create_problem_default", true);
280  registerTask("create_problem_custom", false);
281  registerTask("create_problem_complete", false);
282 
283  registerTask("add_default_convergence", true);
284 
285  registerTask("chain_control_setup", true);
286 
287  // Action for setting up the signal-based checkpoint
288  registerTask("auto_checkpoint_action", true);
289  /**************************/
290  /****** Dependencies ******/
291  /**************************/
302  // clang-format off
303  syntax.addDependencySets("(meta_action)"
304  "(meta_action_component)"
305  "(dynamic_object_registration)"
306  "(common_output)"
307  "(set_global_params)"
308  "(setup_recover_file_base)"
309  "(check_copy_nodal_vars)"
310  "(setup_mesh)"
311  "(add_geometric_rm)"
312  "(add_partitioner)"
313  "(add_mesh_generator)"
314  "(create_added_mesh_generators)"
315  "(append_mesh_generator)"
316  "(execute_mesh_generators)"
317  "(recover_meta_data)"
318  "(set_mesh_base)"
319  "(attach_geometric_rm)"
320  "(init_mesh)"
321  "(prepare_mesh)"
322  "(add_mortar_interface)"
323  "(uniform_refine_mesh)"
324  "(setup_mesh_complete)"
325  "(post_mesh_prepared)"
326  "(determine_system_type)"
327  "(create_problem)"
328  "(create_problem_custom)"
329  "(create_problem_default)"
330  "(create_problem_complete)"
331  "(init_displaced_problem)" // Problem must be init-ed before we start adding functors
332  "(add_function)" // Functions can depend on scalar variables & PPs, but this dependence can be
333  // added on initialSetup() rather than construction
334  "(init_component_physics)" // components must add their blocks to physics before init_physics
335  "(init_physics)"
336  "(setup_postprocessor_data)"
337  "(setup_time_integrator, setup_time_integrators)"
338  "(setup_executioner)"
339  "(setup_executioner_complete)"
340  "(setup_component)" // no particular reason for that placement
341  "(read_executor)"
342  "(add_executor)"
343  "(check_integrity_early)"
344  "(setup_predictor)"
345  "(add_aux_variable, add_variable, add_elemental_field_variable,"
346  " add_external_aux_variables)"
347  "(add_mortar_variable)"
348  "(setup_variable_complete)"
349  "(check_integrity_early_physics)" // checks that systems and variables are consistent
350  "(setup_quadrature)"
351  "(add_convergence)"
352  "(add_default_convergence)"
353  "(add_periodic_bc)"
354  "(add_user_object, add_corrector, add_mesh_modifier)"
355  "(add_distribution)"
356  "(add_sampler)"
357  "(setup_function_complete)"
358  "(setup_adaptivity)"
359  "(set_adaptivity_options)"
360  "(add_ic, add_fv_ic)"
361  "(add_constraint, add_field_split)"
362  "(add_preconditioning)"
363  "(add_times)"
364  "(add_time_stepper, add_time_steppers)"
365  "(compose_time_stepper)"
366  "(setup_time_steppers)"
367  "(ready_to_init)"
368  "(setup_dampers)"
369  "(setup_residual_debug)"
370  "(add_bounds_vectors)"
371  "(add_positions)"
372  "(add_mesh_division)" // NearestPositionsDivision uses a Positions
373  "(add_multi_app)"
374  "(add_transfer)"
375  "(copy_nodal_vars, copy_nodal_aux_vars, copy_vars_physics)"
376  "(add_material)"
377  "(add_master_action_material)"
378  "(add_functor_material)"
379  "(setup_projected_properties)"
380  "(add_output_aux_variables)"
381  "(add_output)"
382  "(auto_checkpoint_action)"
383  "(add_postprocessor)"
384  "(add_vector_postprocessor)" // MaterialVectorPostprocessor requires this
385  // to be after material objects are created.
386  "(add_reporter)"
387  "(declare_late_reporters)"
388  "(add_aux_kernel, add_bc, add_damper, add_dirac_kernel, add_kernel,"
389  " add_nodal_kernel, add_dg_kernel, add_fv_kernel, add_linear_fv_kernel,"
390  " add_fv_bc, add_linear_fv_bc, add_fv_ik, add_interface_kernel,"
391  " add_scalar_kernel, add_aux_scalar_kernel, add_indicator, add_marker,"
392  " add_bound, add_hybridized_kernel, add_hybridized_integrated_bc)"
393  "(resolve_optional_materials)"
394  "(add_algebraic_rm)"
395  "(add_coupling_rm)"
396  "(attach_geometric_rm_final)"
397  "(attach_algebraic_rm)"
398  "(attach_coupling_rm)"
399  "(coupling_functor_check)"
400  "(delete_remote_elements_after_late_geometric_ghosting)"
401  "(init_problem)"
402  "(add_control, add_chain_control)"
403  "(chain_control_setup)"
404  "(check_output)"
405  "(check_integrity)"
406  "(create_application_block)");
407  // clang-format on
408 
409 #ifdef MOOSE_MFEM_ENABLED
410  registerTask("add_mfem_problem_operator", true);
411  addTaskDependency("add_mfem_problem_operator", "init_mesh");
412  addTaskDependency("add_variable", "add_mfem_problem_operator");
413  addTaskDependency("add_aux_variable", "add_mfem_problem_operator");
414  addTaskDependency("add_elemental_field_variable", "add_mfem_problem_operator");
415  addTaskDependency("add_kernel", "add_mfem_problem_operator");
416 
417  // add FESpaces
418  registerMooseObjectTask("add_mfem_fespaces", MFEMFESpace, false);
419  appendMooseObjectTask("add_mfem_fespaces", MFEMFECollection);
420  addTaskDependency("add_variable", "add_mfem_fespaces");
421  addTaskDependency("add_aux_variable", "add_mfem_fespaces");
422  addTaskDependency("add_elemental_field_variable", "add_mfem_fespaces");
423  addTaskDependency("add_kernel", "add_mfem_fespaces");
424 
425  // set mesh FE space
426  registerTask("set_mesh_fe_space", true);
427  addTaskDependency("set_mesh_fe_space", "add_variable");
428  addTaskDependency("set_mesh_fe_space", "init_mesh");
429 
430  // add preconditioning.
431  registerMooseObjectTask("add_mfem_preconditioner", MFEMSolverBase, false);
432  addTaskDependency("add_mfem_preconditioner", "add_mfem_problem_operator");
433  addTaskDependency("add_mfem_preconditioner", "add_variable");
434 
435  // add solver.
436  registerMooseObjectTask("add_mfem_solver", MFEMSolverBase, true);
437  addTaskDependency("add_mfem_solver", "add_mfem_preconditioner");
438  addTaskDependency("add_mfem_solver", "add_mfem_problem_operator");
439 #endif
440 }
441 
470 void
471 registerActions(Syntax & syntax, ActionFactory & action_factory)
472 {
473  mooseDeprecated("use registerAll instead of registerActions");
474  registerActions(syntax, action_factory, {"MooseApp"});
475 }
476 
477 void
479  ActionFactory & action_factory,
480  const std::set<std::string> & obj_labels)
481 {
482  Registry::registerActionsTo(action_factory, obj_labels);
483 
484  // Add these actions here so they are always executed last, without setting any dependency
485  registerTask("dump_objects", false);
486  registerTask("finish_input_file_output", false);
487 }
488 
489 void
490 associateSyntaxInner(Syntax & syntax, ActionFactory & /*action_factory*/)
491 {
497  registerSyntax("DiffusionCG", "Physics/Diffusion/ContinuousGalerkin/*");
498  registerSyntax("DiffusionFV", "Physics/Diffusion/FiniteVolume/*");
499 
500  registerSyntax("AddActionComponentAction", "ActionComponents/*");
501  registerSyntax("CombineComponentsMeshes", "ActionComponents");
502 
503  registerSyntaxTask("CopyNodalVarsAction", "Variables/*", "check_copy_nodal_vars");
504  registerSyntaxTask("CopyNodalVarsAction", "Variables/*", "copy_nodal_vars");
505  registerSyntaxTask("CopyNodalVarsAction", "AuxVariables/*", "check_copy_nodal_vars");
506  registerSyntaxTask("CopyNodalVarsAction", "AuxVariables/*", "copy_nodal_aux_vars");
507 
508  registerSyntaxTask("AddKernelAction", "Kernels/*", "add_kernel");
509  registerSyntaxTask("AddNodalKernelAction", "NodalKernels/*", "add_nodal_kernel");
510  registerSyntaxTask("AddKernelAction", "AuxKernels/*", "add_aux_kernel");
511 
512  registerSyntaxTask("AddHDGKernelAction", "HDGKernels/*", "add_hybridized_kernel");
513  registerSyntaxTask("AddHDGBCAction", "HDGBCs/*", "add_hybridized_integrated_bc");
514 
515  registerSyntax("AddAuxKernelAction", "AuxVariables/*/AuxKernel");
516 
517  registerSyntaxTask("AddScalarKernelAction", "ScalarKernels/*", "add_scalar_kernel");
518  registerSyntaxTask("AddScalarKernelAction", "AuxScalarKernels/*", "add_aux_scalar_kernel");
519 
520  registerSyntaxTask("AddBCAction", "BCs/*", "add_bc");
521 
522  registerSyntax("CreateProblemAction", "Problem");
523  registerSyntax("DynamicObjectRegistrationAction", "Problem");
524 
525  registerSyntax("SetupMeshAction", "Mesh");
526  registerSyntax("SetupMeshCompleteAction", "Mesh");
527  // Components should be able create a Mesh without a Mesh block
528  registerSyntax("CreateMeshSetupActionsForComponents", "ActionComponents");
529  registerSyntax("CreateDisplacedProblemAction", "Mesh");
530  registerSyntax("DisplayGhostingAction", "Mesh");
531  registerSyntax("AddMeshGeneratorAction", "Mesh/*");
532  registerSyntaxTask("EmptyAction", "Mesh/BatchMeshGeneratorAction", "no_action");
533  registerSyntax("BatchMeshGeneratorAction", "Mesh/BatchMeshGeneratorAction/*");
534  registerSyntax("ElementIDOutputAction", "Mesh");
535  syntax.registerSyntaxType("Mesh/*", "MeshGeneratorName");
536 
537  registerSyntax("AddFunctionAction", "Functions/*");
538  syntax.registerSyntaxType("Functions/*", "FunctionName");
539 
540  registerSyntax("AddMeshDivisionAction", "MeshDivisions/*");
541  syntax.registerSyntaxType("MeshDivisions/*", "MeshDivisionName");
542  registerSyntax("AddConvergenceAction", "Convergence/*");
543  syntax.registerSyntaxType("Convergence/*", "ConvergenceName");
544 
545  registerSyntax("GlobalParamsAction", "GlobalParams");
546 
547  registerSyntax("AddDistributionAction", "Distributions/*");
548  syntax.registerSyntaxType("Distributions/*", "DistributionName");
549 
550  registerSyntax("AddSamplerAction", "Samplers/*");
551  syntax.registerSyntaxType("Samplers/*", "SamplerName");
552 
553  registerSyntax("SetupDebugAction", "Debug");
554  registerSyntax("SetupResidualDebugAction", "Debug");
555 
557  registerSyntax("AddVariableAction", "Variables/*");
558  syntax.registerSyntaxType("Variables/*", "VariableName");
559  syntax.registerSyntaxType("Variables/*", "NonlinearVariableName");
560 
561  registerSyntax("AddICAction", "Variables/*/InitialCondition");
562  registerSyntax("AddFVICAction", "Variables/*/FVInitialCondition");
563 
564  registerSyntax("AddAuxVariableAction", "AuxVariables/*");
565  syntax.registerSyntaxType("AuxVariables/*", "VariableName");
566  syntax.registerSyntaxType("AuxVariables/*", "AuxVariableName");
567 
568  registerSyntax("AddICAction", "AuxVariables/*/InitialCondition");
569  registerSyntax("AddFVICAction", "AuxVariables/*/FVInitialCondition");
570 
571  registerSyntaxTask("EmptyAction", "BCs/Periodic", "no_action"); // placeholder
572  registerSyntax("AddPeriodicBCAction", "BCs/Periodic/*");
573 
574  registerSyntaxTask("AddInitialConditionAction", "ICs/*", "add_ic");
575  registerSyntaxTask("AddFVInitialConditionAction", "FVICs/*", "add_fv_ic");
576 
577  registerSyntax("AddMaterialAction", "Materials/*");
578  syntax.registerSyntaxType("Materials/*", "MaterialName");
579 
580  registerSyntax("AddFunctorMaterialAction", "FunctorMaterials/*");
581  syntax.registerSyntaxType("FunctorMaterials/*", "MaterialName");
582 
583  registerSyntax("AddPostprocessorAction", "Postprocessors/*");
584  syntax.registerSyntaxType("Postprocessors/*", "PostprocessorName");
585  syntax.registerSyntaxType("Postprocessors/*", "UserObjectName");
586 
587  registerSyntax("AddVectorPostprocessorAction", "VectorPostprocessors/*");
588  syntax.registerSyntaxType("VectorPostprocessors/*", "VectorPostprocessorName");
589 
590  registerSyntax("AddReporterAction", "Reporters/*");
591  syntax.registerSyntaxType("Reporters/*", "ReporterName");
592 
593  registerSyntax("AddPositionsAction", "Positions/*");
594  syntax.registerSyntaxType("Positions/*", "PositionsName");
595 
596  registerSyntax("AddTimesAction", "Times/*");
597  syntax.registerSyntaxType("Times/*", "TimesName");
598 
599  registerSyntax("AddDamperAction", "Dampers/*");
600 
601  registerSyntax("AddOutputAction", "Outputs/*");
602  registerSyntax("CommonOutputAction", "Outputs");
603  registerSyntax("MaterialOutputAction", "Outputs");
604  registerSyntax("AutoCheckpointAction", "Outputs");
605  syntax.registerSyntaxType("Outputs/*", "OutputName");
606 
607  // Note: Preconditioner Actions will be built by this setup action
608  registerSyntax("SetupPreconditionerAction", "Preconditioning/*");
609  registerSyntax("AddFieldSplitAction", "Preconditioning/*/*");
610 
611  registerSyntax("CreateExecutionerAction", "Executioner");
612  registerSyntax("ReadExecutorParamsAction", "Executors/*");
613 
614  registerSyntaxTask("AddTimeStepperAction", "Executioner/TimeSteppers/*", "add_time_steppers");
615  registerSyntaxTask("AddTimeStepperAction", "Executioner/TimeStepper", "add_time_stepper");
616  registerSyntaxTask(
617  "ComposeTimeStepperAction", "Executioner/TimeSteppers", "compose_time_stepper");
618  registerSyntaxTask(
619  "SetupTimeIntegratorAction", "Executioner/TimeIntegrators/*", "setup_time_integrators");
620  registerSyntaxTask(
621  "SetupTimeIntegratorAction", "Executioner/TimeIntegrator", "setup_time_integrator");
622  syntax.registerSyntaxType("Executors/*", "ExecutorName");
623 
624  registerSyntax("SetupQuadratureAction", "Executioner/Quadrature");
625  registerSyntax("SetupPredictorAction", "Executioner/Predictor");
626 #ifdef LIBMESH_ENABLE_AMR
627  registerSyntax("AdaptivityAction", "Executioner/Adaptivity");
628 #endif
629 
630  registerSyntax("PartitionerAction", "Mesh/Partitioner");
631 
632  registerSyntax("AddDiracKernelAction", "DiracKernels/*");
633 
634  registerSyntax("AddDGKernelAction", "DGKernels/*");
635  registerSyntax("AddFVKernelAction", "FVKernels/*");
636  registerSyntax("AddFVBCAction", "FVBCs/*");
637  registerSyntax("AddLinearFVBCAction", "LinearFVBCs/*");
638  registerSyntax("AddFVInterfaceKernelAction", "FVInterfaceKernels/*");
639  registerSyntax("CheckFVBCAction", "FVBCs");
640 
641  registerSyntax("AddLinearFVKernelAction", "LinearFVKernels/*");
642 
643  registerSyntax("AddInterfaceKernelAction", "InterfaceKernels/*");
644 
645  registerSyntax("AddConstraintAction", "Constraints/*");
646 
647  registerSyntax("AddControlAction", "Controls/*");
648  registerSyntax("AddChainControlAction", "ChainControls/*");
649  registerSyntax("AddBoundAction", "Bounds/*");
650  registerSyntax("AddBoundsVectorsAction", "Bounds");
651 
652  // UserObject and some derived classes
653  registerSyntax("AddUserObjectAction", "UserObjects/*");
654  syntax.registerSyntaxType("UserObjects/*", "UserObjectName");
655  registerSyntax("AddCorrectorAction", "Correctors/*");
656  syntax.registerSyntaxType("Correctors/*", "UserObjectName");
657  registerSyntax("AddMeshModifiersAction", "MeshModifiers/*");
658  syntax.registerSyntaxType("MeshModifiers/*", "UserObjectName");
659 
660  registerSyntax("AddNodalNormalsAction", "NodalNormals");
661 
662  // Indicator
663  registerSyntax("AddElementalFieldAction", "Adaptivity/Indicators/*");
664  registerSyntax("AddIndicatorAction", "Adaptivity/Indicators/*");
665  syntax.registerSyntaxType("Adaptivity/Indicators/*", "IndicatorName");
666 
667  // Marker
668  registerSyntax("AddElementalFieldAction", "Adaptivity/Markers/*");
669  registerSyntax("AddMarkerAction", "Adaptivity/Markers/*");
670  syntax.registerSyntaxType("Adaptivity/Markers/*", "MarkerName");
671 
672  // New Adaptivity System
673  registerSyntax("SetAdaptivityOptionsAction", "Adaptivity");
674 
675  // Deprecated Block
676  registerSyntax("DeprecatedBlockAction", "DeprecatedBlock");
677 
678  // Multi Apps
679  registerSyntax("AddMultiAppAction", "MultiApps/*");
680  syntax.registerSyntaxType("MultiApps/*", "MultiAppName");
681 
682  // Transfers
683  registerSyntax("AddTransferAction", "Transfers/*");
684 
685  // Material derivative test
686  registerSyntaxTask("EmptyAction", "Debug/MaterialDerivativeTest", "no_action"); // placeholder
687  registerSyntax("MaterialDerivativeTestAction", "Debug/MaterialDerivativeTest/*");
688 
689  registerSyntax("ProjectedStatefulMaterialStorageAction", "ProjectedStatefulMaterialStorage/*");
690 
691  // Application Block System
692  registerSyntax("CreateApplicationBlockAction", "Application");
693 
694 #ifdef MOOSE_MFEM_ENABLED
695  registerSyntaxTask("AddMFEMFESpaceAction", "FESpaces/*", "add_mfem_fespaces");
696  registerSyntaxTask("AddMFEMPreconditionerAction", "Preconditioner/*", "add_mfem_preconditioner");
697  registerSyntaxTask("AddMFEMSolverAction", "Solver", "add_mfem_solver");
698 #endif
699 
700  addActionTypes(syntax);
701 }
702 
703 void
704 associateSyntax(Syntax & syntax, ActionFactory & action_factory)
705 {
706  associateSyntaxInner(syntax, action_factory);
707  registerActions(syntax, action_factory);
708 }
709 
710 void
712 {
713  // May be a touch expensive to create a new DM every time, but probably safer to do it this way
715 }
716 
717 MPI_Comm
718 swapLibMeshComm(MPI_Comm new_comm)
719 {
720  MPI_Comm old_comm = PETSC_COMM_WORLD;
721  PETSC_COMM_WORLD = new_comm;
722  return old_comm;
723 }
724 
725 static bool _color_console = isatty(fileno(stdout));
726 
727 bool
729 {
730  return _color_console;
731 }
732 
733 bool
734 setColorConsole(bool use_color, bool force)
735 {
736  _color_console = (isatty(fileno(stdout)) || force) && use_color;
737  return _color_console;
738 }
739 
740 bool _warnings_are_errors = false;
741 bool _deprecated_is_error = false;
742 bool _throw_on_error = false;
743 bool _throw_on_warning = false;
745 bool show_trace = true;
746 bool show_multiple = false;
747 
748 } // namespace Moose
bool show_trace
Set to true (the default) to print the stack trace with error and warning messages - false to omit it...
Definition: Moose.C:745
Base class for function objects.
Definition: Function.h:36
A kernel for hybridized finite element formulations.
Definition: HDGKernel.h:25
Base class for boundary conditions for linear FV systems.
bool colorConsole()
Returns whether Console coloring is turned on (default: true).
Definition: Moose.C:728
Base class for split-based preconditioners.
Definition: Split.h:25
Base class for finite volume kernels that contribute to a linear systems.
MPI_Comm swapLibMeshComm(MPI_Comm new_comm)
Swap the libMesh MPI communicator out for ours.
Definition: Moose.C:718
const ExecFlagType EXEC_PRE_KERNELS
Definition: Moose.C:49
Generic factory class for build all sorts of objects.
Definition: Factory.h:28
void setSolverDefaults(FEProblemBase &problem)
Definition: Moose.C:711
This is the base class for Samplers as used within the Stochastic Tools module.
Definition: Sampler.h:43
Base class for predictors.
Definition: Predictor.h:28
void petscSetDefaults(FEProblemBase &problem)
Sets the default options for PETSc.
Definition: PetscSupport.C:442
Base class for creating new types of boundary conditions.
bool _warnings_are_errors
Variable to toggle any warning into an error (includes deprecated code warnings)
Definition: Moose.C:740
InterfaceKernel and VectorInterfaceKernel is responsible for interfacing physics across subdomains...
void registerActions(Syntax &syntax, ActionFactory &action_factory)
Multiple Action class can be associated with a single input file section, in which case all associate...
Definition: Moose.C:471
This is a template class that implements the workhorse compute and computeNodal methods.
Base class for all Constraint types.
Definition: Constraint.h:19
const ExecFlagType EXEC_PRE_MULTIAPP_SETUP
Definition: Moose.C:47
Positions objects are under the hood Reporters.
Definition: Positions.h:20
Class that hold the whole problem being solved.
Definition: Problem.h:19
Definition: Marker.h:41
Base class for time stepping.
Definition: TimeStepper.h:22
Times objects are under the hood Reporters, but limited to a vector of Real.
Definition: Times.h:18
void associateSyntax(Syntax &syntax, ActionFactory &action_factory)
Definition: Moose.C:704
static void registerObjectsTo(Factory &f, const std::set< std::string > &labels)
This registers all MooseObjects known to the registry that have the given label(s) with the factory f...
Definition: Registry.C:34
All Distributions should inherit from this class.
Definition: Distribution.h:18
Base class for MeshDivision objects.
Definition: MeshDivision.h:35
Reporter objects allow for the declaration of arbitrary data types that are aggregate values for a si...
Definition: Reporter.h:47
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
void registerObjects(Factory &factory)
Definition: Moose.C:67
Base class for MOOSE preconditioners.
Based class for output objects.
Definition: Output.h:43
FunctorMaterials compute functor material properties.
const ExecFlagType EXEC_ALWAYS
Definition: Moose.C:44
static void registerActionsTo(ActionFactory &f, const std::set< std::string > &labels)
This registers all Actions known to the registry that have the given label(s) with the factory f...
Definition: Registry.C:68
Base class for convergence criteria.
Definition: Convergence.h:21
The DGKernel class is responsible for calculating the residuals for various physics on internal sides...
Definition: DGKernel.h:18
bool _deprecated_is_error
Variable to toggle only deprecated warnings as errors.
Definition: Moose.C:741
static bool _color_console
Definition: Moose.C:725
Base class for making kernels that work on auxiliary scalar variables.
const ExecFlagType EXEC_TRANSFER
Definition: Moose.C:48
An integrated boundary condition for hybridized finite element formulations.
Specialized factory for generic Action System objects.
Definition: ActionFactory.h:50
Base class for creating kernels that interface physics between subdomains.
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:88
const ExecFlagType EXEC_LINEAR
Definition: Moose.C:29
const ExecFlagType EXEC_FAILED
Definition: Moose.C:41
const ExecFlagType EXEC_NONLINEAR
Definition: Moose.C:31
Executioners are objects that do the actual work of solving your problem.
Definition: Executioner.h:30
void mooseDeprecated(Args &&... args)
Emit a deprecated code/feature message with the given stringified, concatenated args.
Definition: MooseError.h:353
Base class for all Postprocessors.
Definition: Postprocessor.h:23
The behavior of this kernel is controlled by one problem-wise global parameter eigen_on_current - boo...
Definition: EigenKernel.h:23
const ExecFlagType EXEC_MULTIAPP_FIXED_POINT_BEGIN
Definition: Moose.C:37
const ExecFlagType EXEC_TIMESTEP_END
Definition: Moose.C:33
InitialConditions are objects that set the initial value of variables.
A DiracKernel is used when you need to add contributions to the residual by means of multiplying some...
Definition: DiracKernel.h:19
Constructs and stores an mfem::ParFiniteElementSpace object.
Definition: MFEMFESpace.h:13
void addDependencySets(const std::string &action_sets)
Adds all dependencies in a single call.
Definition: Syntax.C:69
FVKernel is a base class for all finite volume method kernels.
Definition: FVKernel.h:32
Base class for creating new types of boundary conditions.
Base class for time integrators.
bool show_multiple
Set to false (the default) to display an error message only once for each error call code location (a...
Definition: Moose.C:746
Class for containing MooseEnum item information.
Definition: MooseEnumItem.h:18
Base class for Control objects.
Definition: Control.h:33
bool _throw_on_warning
Variable to turn on exceptions during mooseWarning(), should only be used in MOOSE unit tests...
Definition: Moose.C:743
void registerSyntaxType(const std::string &syntax, const std::string &type)
Register a type with a block.
Definition: Syntax.C:362
void registerAll(Factory &f, ActionFactory &af, Syntax &s)
Register objects that are in MOOSE.
Definition: Moose.C:57
Base class for MOOSE partitioner.
bool setColorConsole(bool use_color, bool force=false)
Turns color escape sequences on/off for info written to stdout.
Definition: Moose.C:734
Base class for wrapping mfem::Solver-derived classes.
Base class for deriving dampers.
Definition: Damper.h:24
Holding syntax for parsing input files.
Definition: Syntax.h:21
const ExecFlagType EXEC_MULTIAPP_FIXED_POINT_END
Definition: Moose.C:35
const ExecFlagType EXEC_CUSTOM
Definition: Moose.C:42
Definition: Kernel.h:15
const ExecFlagType EXEC_SUBDOMAIN
Definition: Moose.C:43
int interrupt_signal_number
Used by the signal handler to determine if we should write a checkpoint file out at any point during ...
Definition: Moose.C:744
const ExecFlagType EXEC_TIMESTEP_BEGIN
Definition: Moose.C:34
const ExecFlagType EXEC_POSTCHECK
Definition: Moose.C:32
const ExecFlagType EXEC_FORCED
Definition: Moose.C:40
MOOSE now contains C++17 code, so give a reasonable error message stating what the user can do to add...
const ExecFlagType EXEC_SAME_AS_MULTIAPP
Definition: Moose.C:46
const ExecFlagType EXEC_FINAL
Definition: Moose.C:39
const ExecFlagType EXEC_INITIAL
Definition: Moose.C:28
const ExecFlagType EXEC_NONE
Definition: Moose.C:27
Base class for creating nodal kernels with hand-coded Jacobians.
Definition: NodalKernel.h:17
A MultiApp represents one or more MOOSE applications that are running simultaneously.
Definition: MultiApp.h:112
Base class for Postprocessors that produce a vector of values.
bool _throw_on_error
Variable to turn on exceptions during mooseError(), should only be used within MOOSE unit tests or wh...
Definition: Moose.C:742
MaterialBases compute MaterialProperties.
Definition: MaterialBase.h:62
MeshGenerators are objects that can modify or add to an existing mesh.
Definition: MeshGenerator.h:32
This is a template class that implements the workhorse compute and computeNodal methods.
Base class for user-specific data.
Definition: UserObject.h:39
void addActionTypes(Syntax &syntax)
Definition: Moose.C:80
The Executor class directs the execution flow of simulations.
Definition: Executor.h:26
const ExecFlagType EXEC_NONLINEAR_CONVERGENCE
Definition: Moose.C:30
void associateSyntaxInner(Syntax &syntax, ActionFactory &action_factory)
Definition: Moose.C:490
Control that additionally provides the capability to produce/consume data values, to allow control op...
Definition: ChainControl.h:21
Base class for all Transfer objects.
Definition: Transfer.h:36
const ExecFlagType EXEC_PRE_DISPLACE
Definition: Moose.C:45