10 #ifdef HAVE_GPERFTOOLS 11 #include "gperftools/profiler.h" 12 #include "gperftools/heap-profiler.h" 16 #include "MooseRevision.h" 63 #include "libmesh/exodusII_io.h" 64 #include "libmesh/mesh_refinement.h" 65 #include "libmesh/string_to_enum.h" 66 #include "libmesh/checkpoint_io.h" 67 #include "libmesh/mesh_base.h" 68 #include "libmesh/petsc_solver_exception.h" 71 #ifdef LIBMESH_HAVE_DLOPEN 73 #include <sys/utsname.h> 76 #ifdef MOOSE_LIBTORCH_ENABLED 77 #include <torch/version.h> 83 #include <sys/types.h> 92 #define QUOTE(macro) stringifyName(macro) 98 "app_to_run",
"--app <type>",
"Specify the application type to run (case-sensitive)");
105 "input_file",
"-i <input file(s)>",
"Specify input file(s); multiple files are merged");
116 params.
addCommandLineParam<
bool>(
"display_version",
"-v --version",
"Print application version");
120 "--mesh-only <optional path>",
122 "Build and output the mesh only (Default: \"<input_file_name>_in.e\")");
125 "show_input",
"--show-input",
"Shows the parsed input file before running the simulation");
128 "show_outputs",
"--show-outputs",
"Shows the output execution time information");
131 "show_controls",
"--show-controls",
"Shows the Control logic available and executed");
135 "no_color",
"--no-color",
"Disable coloring of all Console outputs");
140 "color",
"--color <auto,on,off=on>", colors,
"Whether to use color in console output");
147 "Ignore input file and build a minimal application with Transient executioner");
152 "Starts a process to communicate with development tools using the language server protocol");
155 "definition",
"--definition",
"Shows a SON style input definition dump for input validation");
156 params.
addCommandLineParam<
bool>(
"dump",
"--dump",
"Shows a dump of available input file syntax");
159 "--dump-search <search>",
160 "Shows a dump of available input syntax matching a search");
161 params.
addCommandLineParam<
bool>(
"registry",
"--registry",
"Lists all known objects and actions");
163 "registry_hit",
"--registry-hit",
"Lists all known objects and actions in hit format");
165 "use_executor",
"--executor",
"Use the new Executor system instead of Executioners");
168 "show_type",
"--show-type",
"Return the name of the application object");
169 params.
addCommandLineParam<
bool>(
"yaml",
"--yaml",
"Dumps all input file syntax in YAML format");
171 "yaml_search",
"--yaml-search",
"Dumps input file syntax matching a search in YAML format");
172 params.
addCommandLineParam<
bool>(
"json",
"--json",
"Dumps all input file syntax in JSON format");
174 "json_search",
"--json-search",
"Dumps input file syntax matching a search in JSON format");
176 "syntax",
"--syntax",
"Dumps the associated Action syntax paths ONLY");
178 "show_docs",
"--docs",
"Print url/path to the documentation website");
180 "show_capabilities",
"--show-capabilities",
"Dumps the capability registry in JSON format.");
182 "required_capabilities",
183 "--required-capabilities",
184 "A list of conditions that is checked against the registered capabilities (see " 185 "--show-capabilities). The executable will terminate early if the conditions are not met.");
187 "check_capabilities",
188 "--check-capabilities",
189 "A list of conditions that is checked against the registered capabilities. Will exit based " 190 "on whether or not the capaiblities are fulfilled. Does not check dynamically loaded apps.");
193 "Check the input file (i.e. requires -i <filename>) and quit");
197 "--show-copyable-inputs",
198 "Shows the directories able to be copied into a user-writable location");
202 "--copy-inputs <dir>",
203 "Copies installed inputs (e.g. tests, examples, etc.) to a directory <appname>_<dir>");
208 "--run <test harness args>",
210 "Runs the inputs in the current directory copied to a " 211 "user-writable location by \"--copy-inputs\"");
214 "list_constructed_objects",
215 "--list-constructed-objects",
216 "List all moose object type names constructed by the master app factory");
219 "n_threads",
"--n-threads=<n>",
"Runs the specified number of threads per process");
226 "Warn about unused input file options instead of erroring");
229 "error_unused",
"-e --error-unused",
"Error when encountering unused input file options");
233 "-o --error-override",
234 "Error when encountering overridden or parameters supplied multiple times");
237 "error_deprecated",
"--error-deprecated",
"Turn deprecated code messages into Errors");
241 "--distributed-mesh",
242 "Forces the use of a distributed finite element mesh");
249 "--split-mesh <splits>",
250 "Comma-separated list of numbers of chunks to split the mesh into");
254 "split_file",
"--split-file <filename>",
"Name of split mesh file(s) to write/read");
256 params.
addCommandLineParam<
bool>(
"use_split",
"--use-split",
"Use split distributed mesh files");
259 "refinements",
"-r <num refinements>",
"Specify additional initial uniform mesh refinements");
263 "--recover <optional file base>",
265 "Continue the calculation. Without <file base>, the most recent recovery file will be used");
270 "Forcefully load checkpoints despite possible incompatibilities");
276 "Disables the output of the application header.");
280 "test_checkpoint_half_transient",
281 "--test-checkpoint-half-transient",
282 "Run half of a transient with checkpoints enabled; used by the TestHarness");
287 "Test re-running the middle timestep; used by the TestHarness");
292 "Enable floating point exception handling in critical sections of code" 294 " (automatic due to debug build)" 302 "Disable floating point exception handling in critical sections of code" 304 " (unused due to non-debug build)" 311 "no_gdb_backtrace",
"--no-gdb-backtrace",
"Disables gdb backtraces.");
319 "Enable all performance logging for timing; disables screen " 320 "output of performance logs for all Console objects");
323 "no_timing",
"--no-timing",
"Disabled performance logging; overrides -t or --timing");
327 "allow_test_objects",
"--allow-test-objects",
"Register test objects and syntax");
335 "Keep standard output from all processors when running in parallel");
340 "Keep standard output from all processors when running in parallel");
345 "--timpi-sync <type=nbx>",
347 "Changes the sync type used in spare parallel communitations within TIMPI");
352 "--start-in-debugger <debugger>",
353 "Start the application and attach a debugger; this will " 354 "launch xterm windows using <debugger>");
358 "--stop-for-debugger <seconds>",
359 "Pauses the application during startup for <seconds> to allow for connection of debuggers");
362 "perf_graph_live_all",
"--perf-graph-live-all",
"Forces printing of ALL progress messages");
366 "disable_perf_graph_live",
"--disable-perf-graph-live",
"Disables PerfGraph live printing");
370 "automatic_automatic_scaling",
false,
"Whether to turn on automatic scaling by default");
372 const MooseEnum compute_device_type(
"cpu cuda mps hip ceed-cpu ceed-cuda ceed-hip",
"cpu");
377 "The device type we want to run accelerated (libtorch, MFEM) computations on.");
379 #ifdef HAVE_GPERFTOOLS 382 "--gperf-profiler-on <ranks>",
383 "To generate profiling report only on comma-separated list of MPI ranks");
388 "--show-data-params",
390 "Show found paths for all DataFileName parameters in the header");
394 "Show registered data paths for searching in the header");
397 params.
addPrivateParam<std::shared_ptr<Parallel::Communicator>>(
"_comm");
403 params.
addPrivateParam<std::unique_ptr<Backup> *>(
"_initial_backup",
nullptr);
405 #ifdef MOOSE_MFEM_ENABLED 411 "use_legacy_material_output",
413 "Set false to allow material properties to be output on INITIAL, not just TIMESTEP_END.");
415 "use_legacy_initial_residual_evaluation_behavior",
417 "The legacy behavior performs an often times redundant residual evaluation before the " 418 "solution modifying objects are executed prior to the initial (0th nonlinear iteration) " 419 "residual evaluation. The new behavior skips that redundant residual evaluation unless the " 420 "parameter Executioner/use_pre_SMO_residual is set to true.");
425 "Set true to enable data-driven mesh generation, which is an experimental feature");
429 "--parse-neml2-only",
430 "Executes the [NEML2] block to parse the input file and terminate.");
450 _comm(getParam<
std::shared_ptr<
Parallel::Communicator>>(
"_comm")),
451 _file_base_set_by_user(false),
452 _output_position_set(false),
453 _start_time_set(false),
455 _global_time_offset(0.0),
457 _action_factory(*this),
458 _action_warehouse(*this, _syntax, _action_factory),
459 _output_warehouse(*this),
460 _parser(getCheckedPointerParam<
std::shared_ptr<
Parser>>(
"_parser")),
461 _command_line(getCheckedPointerParam<
std::shared_ptr<
CommandLine>>(
"_command_line")),
462 _builder(*this, _action_warehouse, *_parser),
464 _perf_graph(createRecoverablePerfGraph()),
465 _solution_invalidity(createRecoverableSolutionInvalidity()),
466 _rank_map(*_comm, _perf_graph),
467 _use_executor(getParam<bool>(
"use_executor")),
468 _null_executor(NULL),
469 _use_nonlinear(true),
470 _use_eigen_value(false),
471 _enable_unused_check(ERROR_UNUSED),
473 _error_overridden(false),
474 _early_exit_param(
""),
475 _ready_to_exit(false),
477 _initial_from_file(false),
478 _distributed_mesh_on_command_line(false),
482 _use_split(getParam<bool>(
"use_split")),
483 _force_restart(getParam<bool>(
"force_restart")),
489 _test_checkpoint_half_transient(parameters.
get<bool>(
"test_checkpoint_half_transient")),
490 _test_restep(parameters.
get<bool>(
"test_restep")),
491 _check_input(getParam<bool>(
"check_input")),
492 _multiapp_level(isParamValid(
"_multiapp_level") ? getParam<unsigned
int>(
"_multiapp_level")
494 _multiapp_number(isParamValid(
"_multiapp_number") ? getParam<unsigned
int>(
"_multiapp_number")
496 _use_master_mesh(getParam<bool>(
"_use_master_mesh")),
497 _master_mesh(isParamValid(
"_master_mesh") ? getParam<const
MooseMesh *>(
"_master_mesh")
499 _master_displaced_mesh(isParamValid(
"_master_displaced_mesh")
500 ? getParam<const
MooseMesh *>(
"_master_displaced_mesh")
502 _mesh_generator_system(*this),
503 _chain_control_system(*this),
504 _rd_reader(*this, _restartable_data, forceRestart()),
505 _execute_flags(
moose::internal::ExecFlagRegistry::getExecFlagRegistry().getFlags()),
506 _output_buffer_cache(nullptr),
507 _automatic_automatic_scaling(getParam<bool>(
"automatic_automatic_scaling")),
508 _initial_backup(getParam<
std::unique_ptr<
Backup> *>(
"_initial_backup"))
509 #ifdef MOOSE_LIBTORCH_ENABLED
511 _libtorch_device(determineLibtorchDeviceType(getParam<
MooseEnum>(
"compute_device")))
513 #ifdef MOOSE_MFEM_ENABLED
515 _mfem_device(isParamValid(
"_mfem_device")
516 ? getParam<
std::shared_ptr<mfem::Device>>(
"_mfem_device")
518 _mfem_devices(isParamValid(
"_mfem_devices") ? getParam<
std::set<
std::string>>(
"_mfem_devices")
519 :
std::set<
std::string>{})
522 if (¶meters != &_pars)
526 const std::string bad_params =
"(InputParameters parameters)";
527 const std::string good_params =
"(const InputParameters & parameters)";
528 const std::string source_constructor = type() +
"::" + type();
530 " copy-constructs its input parameters.\n\n",
531 "This is deprecated and will not be allowed in the future.\n\n",
553 mooseAssert(_command_line->hasParsed(),
"Command line has not parsed");
554 mooseAssert(_parser->queryRoot() && _parser->queryCommandLineRoot(),
"Parser has not parsed");
557 const auto & timpi_sync = getParam<std::string>(
"timpi_sync");
560 #ifdef HAVE_GPERFTOOLS 561 if (isUltimateMaster())
563 bool has_cpu_profiling =
false;
564 bool has_heap_profiling =
false;
565 static std::string cpu_profile_file;
566 static std::string heap_profile_file;
569 if (std::getenv(
"MOOSE_PROFILE_BASE"))
571 has_cpu_profiling =
true;
573 std::getenv(
"MOOSE_PROFILE_BASE") + std::to_string(_comm->rank()) +
".prof";
576 if (!
name.first.empty())
578 if (processor_id() == 0)
585 if (std::getenv(
"MOOSE_HEAP_BASE"))
587 has_heap_profiling =
true;
588 heap_profile_file = std::getenv(
"MOOSE_HEAP_BASE") + std::to_string(_comm->rank());
591 if (!
name.first.empty())
593 if (processor_id() == 0)
600 if (isParamSetByUser(
"gperf_profiler_on"))
602 auto rankstr = getParam<std::string>(
"gperf_profiler_on");
603 std::vector<processor_id_type> ranks;
606 mooseError(
"Invalid argument for --gperf-profiler-on: '", rankstr,
"'");
607 for (
auto & rank : ranks)
609 if (rank >= _comm->size())
610 mooseError(
"Invalid argument for --gperf-profiler-on: ",
612 " is greater than or equal to ",
614 if (rank == _comm->rank())
616 _cpu_profiling = has_cpu_profiling;
617 _heap_profiling = has_heap_profiling;
623 _cpu_profiling = has_cpu_profiling;
624 _heap_profiling = has_heap_profiling;
628 if (!ProfilerStart(cpu_profile_file.c_str()))
629 mooseError(
"CPU profiler is not started properly");
633 HeapProfilerStart(heap_profile_file.c_str());
634 if (!IsHeapProfilerRunning())
635 mooseError(
"Heap profiler is not started properly");
639 if (std::getenv(
"MOOSE_PROFILE_BASE") || std::getenv(
"MOOSE_HEAP_BASE"))
640 mooseError(
"gperftool is not available for CPU or heap profiling");
644 if (isParamValid(
"language_server") && getParam<bool>(
"language_server"))
645 _output_buffer_cache = Moose::out.rdbuf(
nullptr);
650 _the_warehouse = std::make_unique<TheWarehouse>();
653 _the_warehouse->registerAttribute<
AttribExecOns>(
"exec_ons", 0);
656 _the_warehouse->registerAttribute<
AttribThread>(
"thread", 0);
658 _the_warehouse->registerAttribute<
AttribPreIC>(
"pre_ic", 0);
659 _the_warehouse->registerAttribute<
AttribPreAux>(
"pre_aux");
660 _the_warehouse->registerAttribute<
AttribPostAux>(
"post_aux");
661 _the_warehouse->registerAttribute<
AttribName>(
"name",
"dummy");
662 _the_warehouse->registerAttribute<
AttribSystem>(
"system",
"dummy");
663 _the_warehouse->registerAttribute<
AttribVar>(
"variable", -1);
667 _the_warehouse->registerAttribute<
AttribSorted>(
"sorted");
670 _perf_graph.enableLivePrint();
672 if (_check_input && isParamSetByUser(
"recover"))
673 mooseError(
"Cannot run --check-input with --recover. Recover files might not exist");
675 if (isParamSetByUser(
"start_in_debugger") && isUltimateMaster())
677 auto command = getParam<std::string>(
"start_in_debugger");
679 Moose::out <<
"Starting in debugger using: " << command << std::endl;
683 std::stringstream command_stream;
686 command_stream <<
"xterm -e \"echo 'Rank: " << processor_id() <<
" Hostname: " <<
hostname 687 <<
" PID: " << getpid() <<
"'; echo ''; ";
690 if (command.find(
"lldb") != std::string::npos || command.find(
"gdb") != std::string::npos)
691 command_stream << command <<
" -p " << getpid();
695 "\nIf this is truly what you meant then contact moose-users to have a discussion " 696 "about adding your debugger.");
699 command_stream <<
"\"" 701 std::string command_string = command_stream.str();
702 Moose::out <<
"Running: " << command_string << std::endl;
704 int ret = std::system(command_string.c_str());
708 std::this_thread::sleep_for(std::chrono::seconds(10));
711 if (isParamSetByUser(
"stop_for_debugger") && isUltimateMaster())
713 Moose::out <<
"\nStopping for " << getParam<unsigned int>(
"stop_for_debugger")
714 <<
" seconds to allow attachment from a debugger.\n";
716 Moose::out <<
"\nAll of the processes you can connect to:\n";
717 Moose::out <<
"rank - hostname - pid\n";
724 Moose::err << processor_id() <<
" - " <<
hostname <<
" - " << getpid() <<
"\n";
727 Moose::out <<
"\nWaiting...\n" << std::endl;
730 std::this_thread::sleep_for(std::chrono::seconds(getParam<unsigned int>(
"stop_for_debugger")));
733 if (_master_mesh && isUltimateMaster())
734 mooseError(
"Mesh can be passed in only for sub-apps");
736 if (_master_displaced_mesh && !_master_mesh)
737 mooseError(
"_master_mesh should have been set when _master_displaced_mesh is set");
739 #ifdef MOOSE_MFEM_ENABLED 742 mooseAssert(!isUltimateMaster(),
743 "The MFEM device should only be auto-set for sub-applications");
744 mooseAssert(!_mfem_devices.empty(),
745 "If we are a sub-application and we have an MFEM device object, then we must know " 746 "its configuration string");
756 if (_pars.have_parameter<
bool>(
"use_legacy_dirichlet_bc"))
757 mooseDeprecated(
"The parameter 'use_legacy_dirichlet_bc' is no longer valid.\n\n",
758 "All Dirichlet boundary conditions are preset by default.\n\n",
759 "Remove said parameter in ",
761 " to remove this deprecation warning.");
763 if (_test_restep && _test_checkpoint_half_transient)
764 mooseError(
"Cannot use --test-restep and --test-checkpoint-half-transient together");
766 registerCapabilities();
768 Moose::out << std::flush;
771 std::optional<MooseEnum>
775 return getParam<MooseEnum>(
"compute_device");
783 auto haveCapability = [](
const std::string & capability,
const std::string & doc)
784 {
addCapability(capability,
true, doc +
" is available."); };
786 auto missingCapability =
787 [](
const std::string & capability,
const std::string & doc,
const std::string &
help =
"")
790 auto haveCapabilityVersion =
791 [](
const std::string & capability,
const std::string & doc,
const std::string & version)
792 {
addCapability(capability, version, doc +
" version " + version +
" is available."); };
794 auto petscMissingCapability = [](
const std::string & capability,
const std::string & doc)
797 capability,
false, doc +
" is not available. Check your PETSc configure options.");
800 auto libmeshMissingCapability =
801 [](
const std::string & capability,
const std::string & doc,
const std::string & config_option)
805 doc +
" is not available. It is controlled by the `" + config_option +
806 "` libMesh configure option.");
813 "Trapping floating point exceptions is enabled (in debug mode this " 814 "can be disabled using the --no-trap-fpe option).");
818 "Trapping floating point exceptions is not enabled (enable them using " 819 "the --trap-fpe option or by running a debug mode executable).");
822 const auto doc =
"LibTorch machine learning and parallel tensor algebra library";
823 #ifdef MOOSE_LIBTORCH_ENABLED 826 missingCapability(
"libtorch",
829 "https://mooseframework.inl.gov/moose/getting_started/installation/" 830 "install_libtorch.html for " 831 "instructions on how to configure and build moose with libTorch.");
836 const auto doc =
"MFEM finite element library";
837 #ifdef MOOSE_MFEM_ENABLED 838 haveCapability(
"mfem", doc);
840 missingCapability(
"mfem",
842 "Install mfem using the scripts/update_and_rebuild_mfem.sh script after " 843 "first running scripts/update_and_rebuild_conduit.sh. Finally, configure " 844 "moose with ./configure --with-mfem");
849 const auto doc =
"New Engineering Material model Library, version 2";
851 haveCapability(
"neml2", doc);
853 missingCapability(
"neml2",
855 "Install neml2 using the scripts/update_and_rebuild_neml2.sh script, then " 856 "configure moose with ./configure --with-neml2 --with-libtorch");
861 const auto doc =
"gperftools code performance analysis and profiling library";
862 #ifdef HAVE_GPERFTOOLS 863 haveCapability(
"gperftools", doc);
865 missingCapability(
"gperftools",
867 "Check https://mooseframework.inl.gov/application_development/profiling.html " 868 "for instructions on profiling MOOSE based applications.");
873 const auto doc =
"libPNG portable network graphics format library";
874 #ifdef MOOSE_HAVE_LIBPNG 875 haveCapability(
"libpng", doc);
877 missingCapability(
"libpng",
879 "Install libpng through conda or your distribution and check that it gets " 880 "detected through pkg-config, then reconfigure and rebuild MOOSE.");
885 const auto doc =
"NVIDIA GPU parallel computing platform";
886 #ifdef PETSC_HAVE_CUDA 887 haveCapability(
"cuda", doc);
889 missingCapability(
"cuda", doc,
"Add the CUDA bin directory to your path and rebuild PETSc.");
895 MOOSE_AD_MAX_DOFS_PER_ELEM,
896 "MOOSE was configured and built with a dual number backing store size of " +
898 ". Complex simulations with many variables or contact problems may require larger " 899 "values. Reconfigure MOOSE with the --with-derivative-size=<n> option in the root of the " 902 const std::string method = QUOTE(METHOD);
903 addCapability(
"method", method,
"The executable was built with METHOD=\"" + method +
"\"");
907 const std::string version = QUOTE(LIBMESH_DETECTED_PETSC_VERSION_MAJOR)
"." QUOTE(
908 LIBMESH_DETECTED_PETSC_VERSION_MINOR)
"." QUOTE(LIBMESH_DETECTED_PETSC_VERSION_SUBMINOR);
909 addCapability(
"petsc", version,
"Using PETSc version " + version +
".");
912 #ifdef LIBMESH_PETSC_USE_DEBUG 913 addCapability(
"petsc_debug",
true,
"PETSc was built with debugging options.");
915 addCapability(
"petsc_debug",
false,
"PETSc was built without debugging options.");
919 const auto doc =
"SuperLU direct solver";
920 #ifdef LIBMESH_PETSC_HAVE_SUPERLU_DIST 921 haveCapability(
"superlu", doc);
923 petscMissingCapability(
"superlu", doc);
928 const auto doc =
"MUltifrontal Massively Parallel sparse direct Solver (MUMPS)";
929 #ifdef LIBMESH_PETSC_HAVE_MUMPS 930 haveCapability(
"mumps", doc);
932 petscMissingCapability(
"mumps", doc);
937 const auto doc =
"STRUMPACK - STRUctured Matrix PACKage solver library";
938 #ifdef LIBMESH_PETSC_HAVE_STRUMPACK 939 haveCapability(
"strumpack", doc);
941 petscMissingCapability(
"strumpack", doc);
946 const auto doc =
"Parmetis partitioning library";
947 #if defined(LIBMESH_PETSC_HAVE_PARMETIS) || defined(LIBMESH_HAVE_PARMETIS) 948 haveCapability(
"parmetis", doc);
950 petscMissingCapability(
"parmetis", doc);
955 const auto doc =
"Chaco graph partitioning library";
956 #ifdef LIBMESH_PETSC_HAVE_CHACO 957 haveCapability(
"chaco", doc);
959 petscMissingCapability(
"chaco", doc);
964 const auto doc =
"Party matrix or graph partitioning library";
965 #ifdef LIBMESH_PETSC_HAVE_PARTY 966 haveCapability(
"party", doc);
968 petscMissingCapability(
"party", doc);
973 const auto doc =
"PT-Scotch graph partitioning library";
974 #ifdef LIBMESH_PETSC_HAVE_PTSCOTCH 975 haveCapability(
"ptscotch", doc);
977 petscMissingCapability(
"ptscotch", doc);
982 const auto doc =
"Scalable Library for Eigenvalue Problem Computations (SLEPc)";
983 #ifdef LIBMESH_HAVE_SLEPC 984 const auto version = QUOTE(LIBMESH_DETECTED_SLEPC_VERSION_MAJOR)
"." QUOTE(
985 LIBMESH_DETECTED_SLEPC_VERSION_MINOR)
"." QUOTE(LIBMESH_DETECTED_SLEPC_VERSION_SUBMINOR);
986 haveCapabilityVersion(
"slepc", doc, version);
988 petscMissingCapability(
"slepc", doc);
993 const auto doc =
"Exodus mesh file format library";
994 #ifdef LIBMESH_HAVE_EXODUS_API 995 const std::string version = QUOTE(LIBMESH_DETECTED_EXODUS_VERSION_MAJOR)
"." QUOTE(
996 LIBMESH_DETECTED_EXODUS_VERSION_MINOR);
997 haveCapabilityVersion(
"exodus", doc, version);
999 libmeshMissingCapability(
"exodus", doc,
"--enable-exodus");
1004 const auto doc =
"Netgen meshing library";
1005 #ifdef LIBMESH_HAVE_NETGEN 1006 haveCapability(
"netgen", doc);
1008 libmeshMissingCapability(
"netgen", doc,
"--enable-netgen");
1013 const auto doc =
"Visualization Toolkit (VTK)";
1014 #ifdef LIBMESH_HAVE_VTK 1015 const std::string version = QUOTE(LIBMESH_DETECTED_VTK_VERSION_MAJOR)
"." QUOTE(
1016 LIBMESH_DETECTED_VTK_VERSION_MINOR)
"." QUOTE(LIBMESH_DETECTED_VTK_VERSION_SUBMINOR);
1017 haveCapabilityVersion(
"vtk", doc, version);
1019 libmeshMissingCapability(
"vtk", doc,
"--disable-vtk and --enable-vtk-required");
1024 const auto doc =
"libcurl - the multiprotocol file transfer library";
1025 #ifdef LIBMESH_HAVE_CURL 1026 haveCapability(
"curl", doc);
1028 libmeshMissingCapability(
"curl", doc,
"--enable-curl");
1033 const auto doc =
"Tecplot post-processing tools API";
1034 #ifdef LIBMESH_HAVE_TECPLOT_API 1035 haveCapability(
"tecplot", doc);
1037 libmeshMissingCapability(
"tecplot", doc,
"--enable-tecplot");
1042 const auto doc =
"Boost C++ library";
1043 #ifdef LIBMESH_HAVE_EXTERNAL_BOOST 1044 haveCapability(
"boost", doc);
1046 libmeshMissingCapability(
"boost", doc,
"--with-boost");
1052 const auto doc =
"Adaptive mesh refinement";
1053 #ifdef LIBMESH_ENABLE_AMR 1054 haveCapability(
"amr", doc);
1056 libmeshMissingCapability(
"amr", doc,
"--disable-amr");
1061 const auto doc =
"nanoflann library for Nearest Neighbor (NN) search with KD-trees";
1062 #ifdef LIBMESH_HAVE_NANOFLANN 1063 haveCapability(
"nanoflann", doc);
1065 libmeshMissingCapability(
"nanoflann", doc,
"--disable-nanoflann");
1070 const auto doc =
"sfcurves library for space filling curves (required by geometric " 1071 "partitioners such as SFCurves, Hilbert and Morton - not LGPL compatible)";
1072 #ifdef LIBMESH_HAVE_SFCURVES 1073 haveCapability(
"sfcurves", doc);
1075 libmeshMissingCapability(
"sfcurves", doc,
"--disable-sfc");
1079 #ifdef LIBMESH_HAVE_FPARSER 1080 #ifdef LIBMESH_HAVE_FPARSER_JIT 1081 addCapability(
"fparser",
"jit",
"FParser enabled with just in time compilation support.");
1088 "FParser is disabled, libMesh was likely configured with --disable-fparser.");
1091 #ifdef LIBMESH_HAVE_DLOPEN 1093 "dlopen",
true,
"The dlopen() system call is available to dynamically load libraries.");
1097 "The dlopen() system call is not available. Dynamic library loading is " 1098 "not supported on this system.");
1102 const auto doc =
"LibMesh support for threaded execution";
1103 #ifdef LIBMESH_USING_THREADS 1104 haveCapability(
"threads", doc);
1106 libmeshMissingCapability(
"threads", doc,
"--with-thread-model=tbb,pthread,openmp,auto,none");
1111 const auto doc =
"OpenMP multi-platform shared-memory parallel programming API";
1112 #ifdef LIBMESH_HAVE_OPENMP 1113 haveCapability(
"openmp", doc);
1115 libmeshMissingCapability(
"openmp", doc,
"--with-thread-model=tbb,pthread,openmp,auto,none");
1119 const auto doc =
"oneAPI Threading Building Blocks (TBB) API";
1120 #ifdef LIBMESH_HAVE_TBB_API 1121 haveCapability(
"tbb", doc);
1123 libmeshMissingCapability(
"tbb", doc,
"--with-thread-model=tbb,pthread,openmp,auto,none");
1128 const auto doc =
"libMesh unique ID support";
1129 #ifdef LIBMESH_ENABLE_UNIQUE_ID 1130 haveCapability(
"unique_id", doc);
1132 libmeshMissingCapability(
"unique_id", doc,
"--enable-unique-id");
1137 const auto doc =
"libMesh default mesh mode";
1138 #ifdef LIBMESH_ENABLE_PARMESH 1148 " bytes for storage. This is controlled by the " 1149 "--with-dof-id-bytes=<1|2|4|8> libMesh configure option.");
1153 const auto doc =
"Compiler used to build the MOOSE framework.";
1154 #if defined(__clang__) 1156 #elif defined(__GNUC__) || defined(__GNUG__) 1158 #elif defined(_MSC_VER) 1167 const auto doc =
"Operating system this executable is running on.";
1174 #elif __unix__ // all unices not caught above 1182 #ifdef HAVE_GPERFTOOLS 1209 #ifdef LIBMESH_HAVE_DLOPEN 1212 dlclose(lib_pair.second.library_handle);
1219 return MOOSE_VERSION;
1225 return MOOSE_VERSION;
1237 TIME_SECTION(
"setupOptions", 5,
"Setting Up Options");
1240 if (
header().length() && !getParam<bool>(
"suppress_header"))
1243 if (getParam<bool>(
"error_unused"))
1245 else if (getParam<bool>(
"allow_unused"))
1248 if (getParam<bool>(
"error_override"))
1253 if (getParam<bool>(
"trap_fpe"))
1257 if (getParam<bool>(
"no_trap_fpe"))
1258 mooseError(
"Cannot use both \"--trap-fpe\" and \"--no-trap-fpe\" flags.");
1260 else if (getParam<bool>(
"no_trap_fpe"))
1272 auto color = getParam<MooseEnum>(
"color");
1276 if (getParam<bool>(
"no_color"))
1281 char * c_color = std::getenv(
"MOOSE_COLOR");
1283 color.assign(std::string(c_color),
"While assigning environment variable MOOSE_COLOR");
1287 if (color ==
"auto")
1289 else if (color ==
"on")
1291 else if (color ==
"off")
1294 mooseAssert(
false,
"Should not hit");
1297 if (getParam<bool>(
"no_color"))
1298 mooseDeprecated(
"The --no-color flag is deprecated. Use '--color off' instead.");
1307 #if !LIBMESH_USING_THREADS 1309 mooseError(
"You specified --n-threads > 1, but there is no threading model active!");
1313 if (getParam<bool>(
"minimal"))
1316 else if (getParam<bool>(
"display_version"))
1323 else if (getParam<bool>(
"help"))
1331 const std::string search =
1332 isParamSetByUser(
"dump_search") ? getParam<std::string>(
"dump_search") :
"";
1337 TIME_SECTION(
"dump", 1,
"Building Syntax Tree");
1342 if ((tree.getRoot()).is_object())
1348 Moose::out <<
"\n### START DUMP DATA ###\n" 1349 << formatter.
toString(tree.getRoot()) <<
"\n### END DUMP DATA ###" << std::endl;
1354 mooseError(
"Search parameter '", search,
"' was not found in the registered syntax.");
1356 else if (getParam<bool>(
"registry"))
1360 Moose::out <<
"Label\tType\tName\tClass\tFile\n";
1363 for (
auto & entry : objmap)
1364 for (
auto & obj : entry.second)
1365 Moose::out << entry.first <<
"\tobject\t" << obj->name() <<
"\t" << obj->_classname <<
"\t" 1366 << obj->_file <<
"\n";
1369 for (
auto & entry : actmap)
1371 for (
auto & act : entry.second)
1372 Moose::out << entry.first <<
"\taction\t" << act->_name <<
"\t" << act->_classname <<
"\t" 1373 << act->_file <<
"\n";
1378 else if (getParam<bool>(
"registry_hit"))
1382 Moose::out <<
"### START REGISTRY DATA ###\n";
1384 hit::Section root(
"");
1385 auto sec =
new hit::Section(
"registry");
1387 auto objsec =
new hit::Section(
"objects");
1388 sec->addChild(objsec);
1391 for (
auto & entry : objmap)
1392 for (
auto & obj : entry.second)
1394 auto ent =
new hit::Section(
"entry");
1395 objsec->addChild(ent);
1396 ent->addChild(
new hit::Field(
"label", hit::Field::Kind::String, entry.first));
1397 ent->addChild(
new hit::Field(
"type", hit::Field::Kind::String,
"object"));
1398 ent->addChild(
new hit::Field(
"name", hit::Field::Kind::String, obj->name()));
1399 ent->addChild(
new hit::Field(
"class", hit::Field::Kind::String, obj->_classname));
1400 ent->addChild(
new hit::Field(
"file", hit::Field::Kind::String, obj->_file));
1403 auto actsec =
new hit::Section(
"actions");
1404 sec->addChild(actsec);
1406 for (
auto & entry : actmap)
1407 for (
auto & act : entry.second)
1409 auto ent =
new hit::Section(
"entry");
1410 actsec->addChild(ent);
1411 ent->addChild(
new hit::Field(
"label", hit::Field::Kind::String, entry.first));
1412 ent->addChild(
new hit::Field(
"type", hit::Field::Kind::String,
"action"));
1413 ent->addChild(
new hit::Field(
"task", hit::Field::Kind::String, act->_name));
1414 ent->addChild(
new hit::Field(
"class", hit::Field::Kind::String, act->_classname));
1415 ent->addChild(
new hit::Field(
"file", hit::Field::Kind::String, act->_file));
1418 Moose::out << root.render();
1420 Moose::out <<
"\n### END REGISTRY DATA ###\n";
1424 else if (getParam<bool>(
"definition"))
1431 Moose::out <<
"%-START-SON-DEFINITION-%\n" 1432 << formatter.
toString(tree.
getRoot()) <<
"\n%-END-SON-DEFINITION-%\n";
1438 const std::string search =
1439 isParamSetByUser(
"yaml_search") ? getParam<std::string>(
"yaml_search") :
"";
1450 const std::string search =
1451 isParamSetByUser(
"json_search") ? getParam<std::string>(
"json_search") :
"";
1458 "json",
"**START JSON DATA**\n",
"\n**END JSON DATA**", tree.
getRoot().dump(2));
1462 else if (getParam<bool>(
"syntax"))
1467 std::stringstream ss;
1468 for (
const auto & it :
syntax)
1469 ss << it.first <<
"\n";
1474 else if (getParam<bool>(
"show_type"))
1478 Moose::out <<
"MooseApp Type: " <<
type() << std::endl;
1482 else if (getParam<bool>(
"show_capabilities"))
1486 "**START JSON DATA**\n",
1487 "\n**END JSON DATA**",
1494 const auto & capabilities = getParam<std::string>(
"check_capabilities");
1497 _console <<
"Capabilities '" << capabilities <<
"' are " << (pass ?
"" :
"not ") <<
"fulfilled." 1511 const auto & recover = getParam<std::string>(
"recover");
1522 const auto required_capabilities = getParam<std::string>(
"required_capabilities");
1523 auto [
status, reason, doc] =
1527 mooseInfo(
"Required capabilities '", required_capabilities,
"' not fulfilled.");
1535 required_capabilities,
1536 "' are not specific enough. A comparison test is performed on an undefined " 1537 "capability. Disambiguate this requirement by adding an existence/non-existence " 1538 "requirement. Example: 'unknown<1.2.3' should become 'unknown & unknown<1.2.3' " 1539 "or '!unknown | unknown<1.2.3'");
1543 auto isExclusiveParamSetByUser =
1544 [
this](
const std::vector<std::string> & group,
const std::string & param)
1548 for (
const auto & p : group)
1550 mooseError(
"Parameters '" + p +
"' and '" + param +
1551 "' are mutually exclusive. Please choose only one of them.");
1556 const std::vector<std::string> final_task_params = {
1557 "mesh_only",
"split_mesh",
"parse_neml2_only"};
1558 if (isExclusiveParamSetByUser(final_task_params,
"mesh_only"))
1572 else if (isExclusiveParamSetByUser(final_task_params,
"split_mesh"))
1580 else if (isExclusiveParamSetByUser(final_task_params,
"parse_neml2_only"))
1592 mooseAssert(common_actions.size() <= 1,
"Should not be more than one CommonOutputAction");
1593 const Action * common = common_actions.empty() ? nullptr : *common_actions.begin();
1596 if (common && common->isParamValid(
"file_base"))
1606 size_t pos = base.find_last_of(
'.');
1621 mooseError(
"You specified --check-input, but did not provide an input file. Add -i " 1622 "<inputfile> to your command line.");
1624 mooseError(
"No input files specified. Add -i <inputfile> to your command line.");
1626 else if (
isParamValid(
"language_server") && getParam<bool>(
"language_server"))
1651 Moose::out << std::flush;
1654 const std::vector<std::string> &
1657 mooseAssert(
_parser,
"Parser is not set");
1658 return _parser->getInputFileNames();
1664 mooseAssert(
_parser,
"Parser is not set");
1665 return _parser->getLastInputFileName();
1687 for (
auto & multi_app :
feProblem().getMultiAppWarehouse().getObjects())
1688 multi_app->setAppOutputFileBase();
1696 TIME_SECTION(
"runInputFile", 3);
1719 else if (getParam<bool>(
"list_constructed_objects"))
1724 std::stringstream ss;
1725 for (
const auto & obj :
_factory.getConstructedObjects())
1728 "list_constructed_objects",
"**START OBJECT DATA**\n",
"\n**END OBJECT DATA**", ss.str());
1750 "Something went wrong, we should only get here if _check_input is true.");
1752 "Incompatible command line arguments provided. --check-input cannot be called with ",
1757 mooseError(
"The Executor is being called without being initialized. This is likely " 1759 "incompatible command line arguments");
1763 for (
auto app : apps)
1764 for (
unsigned int i = 0; i < app->numLocalApps(); i++)
1765 app->localApp(i)->errorCheck();
1771 TIME_SECTION(
"executeExecutioner", 3);
1784 if (!result.convergedAll())
1797 mooseError(
"No executioner was specified (go fix your input file)");
1828 "MooseApp::hasRestartRecoverFileBase() instead.");
1839 case RESTARTABLE_FILTER::RECOVERABLE:
1847 std::vector<std::filesystem::path>
1850 TIME_SECTION(
"backup", 2,
"Backing Up Application to File");
1855 return writer.
write(folder_base);
1858 std::unique_ptr<Backup>
1861 TIME_SECTION(
"backup", 2,
"Backing Up Application");
1867 auto backup = std::make_unique<Backup>();
1876 TIME_SECTION(
"restore", 2,
"Restoring Application from File");
1889 TIME_SECTION(
"restore", 2,
"Restoring Application");
1894 mooseError(
"MooseApp::restore(): Provided backup is not initialized");
1897 mooseAssert(
header,
"Header not available");
1899 auto data = std::move(
backup->data);
1900 mooseAssert(data,
"Data not available");
1915 std::unique_ptr<Backup>
1919 mooseError(
"MooseApp::finalizeRestore(): Not currently restoring");
1924 std::unique_ptr<Backup>
backup;
1928 if (
auto header_string_input = dynamic_cast<StringInputStream *>(input_streams.header.get()))
1930 auto data_string_input =
dynamic_cast<StringInputStream *
>(input_streams.data.get());
1931 mooseAssert(data_string_input,
"Should also be a string input");
1933 auto header_sstream = header_string_input->release();
1934 mooseAssert(header_sstream,
"Header not available");
1936 auto data_sstream = data_string_input->release();
1937 mooseAssert(data_sstream,
"Data not available");
1939 backup = std::make_unique<Backup>();
1940 backup->header = std::move(header_sstream);
1941 backup->data = std::move(data_sstream);
1968 const std::string & name,
1974 mooseError(
"an executor with name '", executor->name(),
"' already exists");
1980 const std::string & name,
1989 mooseAssert(
_parser,
"Not set");
1996 return const_cast<Parser &
>(std::as_const(*this).parser());
2001 std::list<std::string> & possible_roots,
2002 std::list<std::string> & current_branch)
2009 if (std::find(current_branch.begin(), current_branch.end(), current_executor_name) !=
2010 current_branch.end())
2012 std::stringstream exec_names_string;
2014 auto branch_it = current_branch.begin();
2016 exec_names_string << *branch_it++;
2018 for (; branch_it != current_branch.end(); ++branch_it)
2019 exec_names_string <<
", " << *branch_it;
2021 exec_names_string <<
", " << current_executor_name;
2023 mooseError(
"Executor cycle detected: ", exec_names_string.str());
2026 current_branch.push_back(current_executor_name);
2031 for (
const auto & param : params)
2033 if (params.have_parameter<ExecutorName>(param.first))
2035 const auto & dependency_name = params.get<ExecutorName>(param.first);
2037 possible_roots.remove(dependency_name);
2039 if (!dependency_name.empty())
2048 current_branch.pop_back();
2059 std::list<std::string> possibly_root;
2062 std::map<std::string, bool> already_built;
2065 std::list<std::string> possible_roots;
2068 std::list<std::string> current_branch;
2072 auto params =
_factory.getValidParams(
"NullExecutor");
2078 const auto &
name = params_entry.first;
2084 possible_roots.emplace_back(
name);
2090 if (possible_roots.size() > 1)
2092 auto root_string_it = possible_roots.begin();
2094 std::stringstream roots_string;
2096 roots_string << *root_string_it++;
2098 for (; root_string_it != possible_roots.end(); ++root_string_it)
2099 roots_string <<
", " << *root_string_it;
2101 mooseError(
"Multiple Executor roots found: ", roots_string.str());
2116 if (fail_if_not_found)
2137 TIME_SECTION(
"run", 3);
2138 if (getParam<bool>(
"show_docs"))
2142 mooseError(
"could not locate installed tests to run (unresolved binary/app name)");
2145 mooseError(
"no installed documentation found");
2151 std::ifstream ifs(docmsgfile);
2152 std::string content((std::istreambuf_iterator<char>(ifs)),
2153 (std::istreambuf_iterator<char>()));
2154 content.replace(content.find(
"$LOCAL_SITE_HOME"), content.length(), docmsg);
2158 Moose::out << docmsg <<
"\n";
2173 TIME_SECTION(
"setup", 2,
"Setting Up");
2179 mooseAssert(
_parser->getThrowOnError(),
"Should be true");
2187 catch (std::exception &
err)
2194 TIME_SECTION(
"execute", 2,
"Executing");
2201 Moose::err <<
"Syntax OK" << std::endl;
2208 if (getParam<bool>(
"show_inputs"))
2211 std::vector<std::string> dirs;
2214 if (installable_inputs ==
"")
2217 <<
"Show inputs has not been overriden in this application.\nContact the developers of " 2218 "this appication and request that they override \"MooseApp::getInstallableInputs\".\n";
2222 mooseAssert(!show_inputs_syntax.empty(),
"show_inputs sytnax should not be empty");
2225 Moose::out <<
"The following directories are installable into a user-writeable directory:\n\n" 2226 << installable_inputs <<
'\n' 2227 <<
"\nTo install one or more directories of inputs, execute the binary with the \"" 2228 << show_inputs_syntax[0] <<
"\" flag. e.g.:\n$ " 2229 <<
_command_line->getExecutableName() <<
' ' << show_inputs_syntax[0] <<
' ' 2248 if (
comm().size() > 1)
2249 mooseError(
"The --copy-inputs option should not be ran in parallel");
2252 auto dir_to_copy = getParam<std::string>(
"copy_inputs");
2254 if (dir_to_copy.empty())
2255 mooseError(
"Error retrieving directory to copy");
2256 if (dir_to_copy.back() !=
'/')
2263 mooseError(
"could not locate installed tests to run (unresolved binary/app name)");
2269 " to get a list of installable directories.");
2273 auto dst_dir =
_command_line->getExecutableNameBase() +
"/" + dir_to_copy;
2275 if (cmdname.find_first_of(
"/") != std::string::npos)
2276 cmdname = cmdname.substr(cmdname.find_first_of(
"/") + 1, std::string::npos);
2280 "The directory \"./",
2282 "\" already exists.\nTo update/recopy the contents of this directory, rename (\"mv ",
2284 " new_dir_name\") or remove (\"rm -r ",
2286 "\") the existing directory.\nThen re-run \"",
2292 std::string cmd =
"mkdir -p " + dst_dir +
"; rsync -av " + src_dir +
" " + dst_dir;
2294 TIME_SECTION(
"copy_inputs", 2,
"Copying Inputs");
2296 mooseAssert(
comm().size() == 1,
"Should be run in serial");
2297 const auto return_value = system(cmd.c_str());
2298 if (!WIFEXITED(return_value))
2302 Moose::out <<
"Directory successfully copied into ./" << dst_dir <<
'\n';
2313 if (
comm().size() > 1)
2314 mooseError(
"The --run option should not be ran in parallel");
2317 const auto find_run_it = std::as_const(*_command_line).findCommandLineParam(
"run");
2318 const auto & cl_entries = std::as_const(*_command_line).getEntries();
2319 mooseAssert(find_run_it != cl_entries.end(),
"Didn't find the option");
2320 std::string test_args;
2321 for (
auto it = std::next(find_run_it); it != cl_entries.end(); ++it)
2322 for (
const auto & arg : it->raw_args)
2324 test_args +=
" " + arg;
2333 mooseError(
"Could not locate binary name relative to installed location");
2337 "Could not locate installed tests from the current working directory:",
2339 ".\nMake sure you are executing this command from within a writable installed inputs ",
2340 "directory.\nRun \"",
2342 " --copy-inputs <dir>\" to copy the contents of <dir> to a \"./",
2344 "_<dir>\" directory.\nChange into that directory and try \"",
2346 " --run <dir>\" again.");
2350 setenv(
"MOOSE_TEST_RUNNER_APP_NAME",
appBinaryName().c_str(),
true);
2353 Moose::out <<
"Working Directory: " << working_dir <<
"\nRunning Command: " << cmd << std::endl;
2354 mooseAssert(
comm().size() == 1,
"Should be run in serial");
2355 const auto return_value = system(cmd.c_str());
2356 if (!WIFEXITED(return_value))
2370 static const std::set<std::string> reserved{
2371 "scale_refine",
"valgrind",
"recover",
"heavy",
"mpi_procs",
"num_threads",
"compute_device"};
2372 if (reserved.count(capability))
2373 ::
mooseError(
"MooseApp::addCapability(): The capability \"",
2375 "\" is reserved and may not be registered by an application.");
2389 std::list<std::string>
2393 std::list<std::string> checkpoint_dirs;
2400 for (
const auto & action : actions)
2404 if (!moose_object_action)
2408 if (moose_object_action->
getParam<std::string>(
"type") ==
"Checkpoint")
2412 const std::string cp_dir =
2415 checkpoint_dirs.push_back(cp_dir +
"_cp");
2418 return checkpoint_dirs;
2421 std::list<std::string>
2456 std::string library_name(app_name);
2459 size_t pos = library_name.find(
"App");
2460 if (pos != library_name.length() - 3)
2461 mooseError(
"Invalid application name: ", library_name);
2462 library_name.erase(pos);
2466 QUOTE(METHOD) +
".la";
2472 std::string app_name(library_name);
2475 if (pcrecpp::RE(
"lib(.+?)(?:-\\w+)?\\.la").Replace(
"\\1", &app_name) == 0)
2476 mooseError(
"Invalid library name: ", app_name);
2487 if (!metaname.empty() && tid != 0)
2489 "The meta data storage for '", metaname,
"' is not threaded, so the tid must be zero.");
2491 mooseAssert(metaname.empty() ||
2493 "The desired meta data name does not exist: " + metaname);
2502 if (data->typeId() != stored_data->
typeId())
2503 mooseError(
"Type mismatch found in RestartableData registration of '",
2505 "'\n\n Stored type: ",
2506 stored_data->
type(),
2511 stored_data = &data_map.addData(std::move(data));
2516 return *stored_data;
2521 std::unique_ptr<RestartableDataValue> data,
2526 mooseDeprecated(
"The use of MooseApp::registerRestartableData with a data name is " 2527 "deprecated.\n\nUse the call without a name instead.");
2529 mooseAssert(
name == data->name(),
"Inconsistent name");
2540 return it->second.first.hasData(
name);
2550 "The meta data storage for '", metaname,
"' is not threaded, so the tid must be zero.");
2556 mooseError(
"Unable to find RestartableDataValue object with name " +
name +
2557 " in RestartableDataMap");
2564 const std::filesystem::path & folder_base)
2572 reader.
setInput(meta_data_folder_base);
2584 std::vector<std::filesystem::path>
2586 const std::filesystem::path & folder_base)
2589 mooseError(
"MooseApp::writeRestartableMetaData(): Should only run on processor 0");
2595 return writer.
write(meta_data_folder_base);
2598 std::vector<std::filesystem::path>
2601 std::vector<std::filesystem::path> paths;
2607 paths.insert(paths.end(), map_paths.begin(), map_paths.end());
2615 std::string library_path,
2616 const std::string & library_name,
2619 #ifdef LIBMESH_HAVE_DLOPEN 2621 params.
set<std::string>(
"app_name") = app_name;
2623 params.
set<std::string>(
"registration_method") = app_name +
"__registerApps";
2624 params.
set<std::string>(
"library_path") = library_path;
2626 const auto effective_library_name =
2628 params.
set<std::string>(
"library_name") = effective_library_name;
2629 params.
set<
bool>(
"library_load_dependencies") = lib_load_deps;
2632 std::ostringstream oss;
2634 auto successfully_loaded =
false;
2636 oss <<
'"' << app_name <<
"\" is not a registered application name.\n" 2637 <<
"No search paths were set. We made no attempts to locate the corresponding library " 2646 oss <<
'"' << app_name <<
"\" is not a registered application name.\n" 2647 <<
"Unable to locate library archive for \"" << app_name
2648 <<
"\".\nWe attempted to locate the library archive \"" << effective_library_name
2649 <<
"\" in the following paths:\n\t";
2650 std::copy(paths.begin(), paths.end(), infix_ostream_iterator<std::string>(oss,
"\n\t"));
2653 successfully_loaded =
true;
2656 if (!successfully_loaded)
2658 oss <<
"\nMake sure you have compiled the library and either set the \"library_path\" " 2659 "variable in your input file or exported \"MOOSE_LIBRARY_PATH\".\n";
2665 libmesh_ignore(app_name, library_path, library_name, lib_load_deps);
2666 mooseError(
"Dynamic Loading is either not supported or was not detected by libMesh configure.");
2675 std::string library_path,
2676 const std::string & library_name)
2678 #ifdef LIBMESH_HAVE_DLOPEN 2680 params.
set<std::string>(
"app_name") = app_name;
2682 params.
set<std::string>(
"registration_method") = app_name +
"__registerAll";
2683 params.
set<std::string>(
"library_path") = library_path;
2684 params.
set<std::string>(
"library_name") =
2690 params.
set<
bool>(
"library_load_dependencies") =
false;
2695 mooseError(
"Dynamic Loading is either not supported or was not detected by libMesh configure.");
2703 const auto library_name = params.
get<std::string>(
"library_name");
2706 for (
const auto & path : paths)
2709 path +
'/' + library_name, params, params.
get<
bool>(
"library_load_dependencies"));
2715 const bool load_dependencies)
2718 std::string dl_lib_filename;
2722 pcrecpp::RE re_deps(
"(/\\S*\\.la)");
2724 std::ifstream la_handle(library_filename.c_str());
2725 if (la_handle.is_open())
2727 while (std::getline(la_handle, line))
2730 if (line.find(
"dlname=") != std::string::npos)
2733 dl_lib_filename = line.substr(8, line.size() - 9);
2735 if (line.find(
"dependency_libs=") != std::string::npos)
2737 if (load_dependencies)
2739 pcrecpp::StringPiece input(line);
2740 pcrecpp::StringPiece depend_library;
2741 while (re_deps.FindAndConsume(&input, &depend_library))
2755 if (dl_lib_filename.empty())
2774 #ifdef LIBMESH_HAVE_DLOPEN 2775 void *
const lib_handle = dlopen(dl_lib_full_path.c_str(), RTLD_LAZY);
2777 void *
const lib_handle =
nullptr;
2783 "\" exists and has proper permissions, but cannot by dynamically loaded.\nThis " 2784 "generally means that the loader was unable to load one or more of the " 2785 "dependencies listed in the supplied library (see otool or ldd).\n",
2792 auto insert_ret =
_lib_handles.insert(std::make_pair(file_name, lib_info));
2793 mooseAssert(insert_ret.second ==
true,
"Error inserting into lib_handles map");
2795 dyn_lib_it = insert_ret.first;
2799 const auto registration_method = params.
get<std::string>(
"registration_method");
2800 auto & entry_sym_from_curr_lib = dyn_lib_it->second.entry_symbols;
2802 if (entry_sym_from_curr_lib.find(registration_method) == entry_sym_from_curr_lib.end())
2808 #ifdef LIBMESH_HAVE_DLOPEN 2809 void * registration_handle =
2810 dlsym(dyn_lib_it->second.library_handle, registration_method.c_str());
2812 void * registration_handle =
nullptr;
2815 if (registration_handle)
2821 using register_app_t =
void (*)();
2822 register_app_t *
const reg_ptr =
reinterpret_cast<register_app_t *
>(®istration_handle);
2829 register_app_t *
const reg_ptr =
reinterpret_cast<register_app_t *
>(®istration_handle);
2839 entry_sym_from_curr_lib.insert(registration_method);
2844 #if defined(DEBUG) && defined(LIBMESH_HAVE_DLOPEN) 2848 if (!registration_handle)
2850 registration_method,
2854 "This doesn't necessarily indicate an error condition unless you believe that " 2855 "the method should exist in that library.\n",
2862 std::set<std::string>
2866 std::set<std::string> paths;
2868 paths.insert(it.first);
2873 std::set<std::string>
2876 std::set<std::string> paths;
2878 if (!library_path.empty())
2880 std::vector<std::string> tmp_paths;
2883 paths.insert(tmp_paths.begin(), tmp_paths.end());
2886 char * moose_lib_path_env = std::getenv(
"MOOSE_LIBRARY_PATH");
2887 if (moose_lib_path_env)
2889 std::string moose_lib_path(moose_lib_path_env);
2890 std::vector<std::string> tmp_paths;
2893 paths.insert(tmp_paths.begin(), tmp_paths.end());
2908 return std::string(
"");
2926 TIME_SECTION(
"createMinimalApp", 3,
"Creating Minimal App");
2932 action_params.
set<std::string>(
"type") =
"GeneratedMesh";
2935 std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<
MooseObjectAction>(
2941 params.set<
unsigned int>(
"nx") = 1;
2951 action_params.
set<std::string>(
"type") =
"Transient";
2954 std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<
MooseObjectAction>(
2959 params.
set<
unsigned int>(
"num_steps") = 1;
2960 params.set<
Real>(
"dt") = 1;
2970 action_params.
set<
bool>(
"_solve") =
false;
2973 std::shared_ptr<Action> action = std::static_pointer_cast<
Action>(
2984 action_params.
set<
bool>(
"console") =
false;
2987 std::shared_ptr<Action> action =
3002 [&
name](
const std::shared_ptr<RelationshipManager> & rm)
3011 auto & existing_for_whom = acceptor.
forWhom();
3014 for (
auto & fw : donor.
forWhom())
3016 if (std::find(existing_for_whom.begin(), existing_for_whom.end(), fw) ==
3017 existing_for_whom.end())
3041 std::set<std::shared_ptr<RelationshipManager>> rms_to_erase;
3045 if (*existing_rm >= *new_rm)
3048 donateForWhom(*new_rm, *existing_rm);
3053 else if (*new_rm >= *existing_rm)
3054 rms_to_erase.emplace(existing_rm);
3060 for (
const auto & rm_to_erase : rms_to_erase)
3062 donateForWhom(*rm_to_erase, *new_rm);
3074 static const std::string suffix =
"-mesh.cpa.gz";
3078 std::filesystem::path
3080 const std::string & map_suffix)
3083 std::filesystem::path(
"meta_data" + map_suffix));
3086 std::filesystem::path
3089 auto folder = folder_base;
3090 folder +=
"-restart-" + std::to_string(
processor_id());
3098 return action->parameters().getHitNode();
3115 mooseError(
"The template rm does not exist in our _template_to_clones map");
3117 auto & mesh_to_clone_map = outer_it->second;
3118 auto inner_it = mesh_to_clone_map.find(&
mesh);
3119 if (inner_it == mesh_to_clone_map.end())
3120 mooseError(
"We should have the mesh key in our mesh");
3122 return *inner_it->second;
3132 const MeshBase *
const undisp_lm_mesh =
mesh->getMeshPtr();
3134 if (undisp_lm_mesh &&
hasRMClone(*rm, *undisp_lm_mesh))
3136 undisp_clone = &
getRMClone(*rm, *undisp_lm_mesh);
3137 const_cast<MeshBase *
>(undisp_lm_mesh)->remove_ghosting_functor(*undisp_clone);
3141 MeshBase *
const disp_lm_mesh = displaced_mesh ? &displaced_mesh->getMesh() :
nullptr;
3143 if (disp_lm_mesh &&
hasRMClone(*rm, *disp_lm_mesh))
3145 disp_clone = &
getRMClone(*rm, *disp_lm_mesh);
3154 problem.removeAlgebraicGhostingFunctor(*undisp_clone);
3155 problem.removeCouplingGhostingFunctor(*undisp_clone);
3158 auto * dp = problem.getDisplacedProblem().get();
3159 if (dp && disp_clone)
3160 dp->removeAlgebraicGhostingFunctor(*disp_clone);
3163 _factory.releaseSharedObjects(*rm);
3171 const DofMap *
const dof_map)
3174 auto it = mesh_to_clone.find(&
mesh);
3175 if (it != mesh_to_clone.end())
3178 auto & clone_rm = *it->second;
3179 if (!clone_rm.dofMap() && dof_map)
3181 clone_rm.init(moose_mesh,
mesh, dof_map);
3182 else if (clone_rm.dofMap() && dof_map && (clone_rm.dofMap() != dof_map))
3183 mooseError(
"Attempting to create and initialize an existing clone with a different DofMap. " 3184 "This should not happen.");
3194 auto pr = mesh_to_clone.emplace(
3195 std::make_pair(&const_cast<const MeshBase &>(
mesh),
3196 dynamic_pointer_cast<RelationshipManager>(template_rm.
clone())));
3197 mooseAssert(pr.second,
"An insertion should have happened");
3198 auto & clone_rm = *pr.first->second;
3199 clone_rm.init(moose_mesh,
mesh, dof_map);
3210 if (rm->attachGeometricEarly())
3223 if (moose_mesh_base != &mesh)
3224 mooseError(
"The MooseMesh MeshBase and the MeshBase we're trying to attach " 3225 "relationship managers to are different");
3238 bool attach_geometric_rm_final)
3242 if (!rm->isType(rm_type))
3256 if (!rm->attachGeometricEarly() && !attach_geometric_rm_final)
3259 mesh->allowRemoteElementRemoval(
false);
3263 const DofMap *
const undisp_sys_dof_map =
3271 attach_geometric_rm_final && disp_moose_mesh)
3274 const DofMap * disp_sys_dof_map =
nullptr;
3281 mooseError(
"The displaced mesh should not yet exist at the time that we are attaching " 3282 "early geometric relationship managers.");
3292 mooseError(
"We must have an executioner by now or else we do not have to data to add " 3293 "algebraic or coupling functors to in MooseApp::attachRelationshipManagers");
3297 auto & undisp_moose_mesh = problem.mesh();
3299 auto & undisp_sys_dof_map = undisp_sys.
dofMap();
3300 auto & undisp_mesh = undisp_moose_mesh.getMesh();
3302 if (rm->useDisplacedMesh() && problem.getDisplacedProblem())
3316 problem.addCouplingGhostingFunctor(
3324 auto & disp_mesh = disp_moose_mesh.getMesh();
3334 problem.addCouplingGhostingFunctor(
3339 problem.addAlgebraicGhostingFunctor(
3351 std::vector<std::pair<std::string, std::string>>
3354 std::vector<std::pair<std::string, std::string>> info_strings;
3359 std::stringstream oss;
3360 oss << rm->getInfo();
3362 auto & for_whom = rm->forWhom();
3364 if (!for_whom.empty())
3368 std::copy(for_whom.begin(), for_whom.end(), infix_ostream_iterator<std::string>(oss,
", "));
3371 info_strings.emplace_back(std::make_pair(
Moose::stringify(rm->getType()), oss.str()));
3382 std::map<std::string, unsigned int> counts;
3390 counts[
demangle(
typeid(*gf).name())]++;
3393 for (
const auto & pair : counts)
3394 info_strings.emplace_back(std::make_pair(
3395 "Default", pair.first + (pair.second > 1 ?
" x " + std::to_string(pair.second) :
"")));
3406 std::map<std::string, unsigned int> counts;
3408 for (
auto & gf :
as_range(d_mesh->getMesh().ghosting_functors_begin(),
3409 d_mesh->getMesh().ghosting_functors_end()))
3414 counts[
demangle(
typeid(*gf).name())]++;
3417 for (
const auto & pair : counts)
3418 info_strings.emplace_back(
3419 std::make_pair(
"Default",
3420 pair.first + (pair.second > 1 ?
" x " + std::to_string(pair.second) :
"") +
3421 " for DisplacedMesh"));
3424 return info_strings;
3436 std::vector<std::string> not_declared;
3438 for (
const auto & data : meta_data)
3439 if (!data.declared())
3440 not_declared.push_back(data.name());
3442 if (!not_declared.empty())
3444 std::ostringstream oss;
3446 not_declared.begin(), not_declared.end(), infix_ostream_iterator<std::string>(oss,
", "));
3450 "' meta-data properties were retrieved but never declared: ",
3464 mooseError(
"Unable to find RestartableDataMap object for the supplied name '",
3466 "', did you call registerRestartableDataMapName in the application constructor?");
3467 return iter->second.first;
3479 if (!suffix.empty())
3480 std::transform(suffix.begin(), suffix.end(), suffix.begin(), ::tolower);
3481 suffix.insert(0,
"_");
3491 mooseError(
"MooseApp::getRestartableDataMapName: The name '",
name,
"' is not registered");
3492 return it->second.second;
3501 std::make_unique<RestartableData<PerfGraph>>(
"perf_graph",
3505 getParam<bool>(
"perf_graph_live_all"),
3506 !getParam<bool>(
"disable_perf_graph_live"));
3518 auto solution_invalidity =
3519 std::make_unique<RestartableData<SolutionInvalidity>>(
"solution_invalidity",
nullptr, *
this);
3533 #ifdef MOOSE_LIBTORCH_ENABLED 3537 const auto pname =
"--compute-device";
3538 if (device_enum ==
"cuda")
3541 if (!torch::cuda::is_available())
3542 mooseError(pname,
"=cuda: CUDA support is not available in the linked libtorch library");
3543 return torch::kCUDA;
3545 mooseError(pname,
"=cuda: CUDA is not supported on your platform");
3548 else if (device_enum ==
"mps")
3551 if (!torch::mps::is_available())
3552 mooseError(pname,
"=mps: MPS support is not available in the linked libtorch library");
3555 mooseError(pname,
"=mps: MPS is not supported on your platform");
3559 else if (device_enum !=
"cpu")
3562 "' is not currently supported by the MOOSE libtorch integration.");
3569 const std::string & start_marker,
3570 const std::string & end_marker,
3571 const std::string & data)
const 3576 Moose::out << start_marker << data << end_marker << std::endl;
3581 const auto & filename = getParam<std::string>(param);
3583 std::ofstream
out(filename.c_str());
3586 std::ofstream
out(filename.c_str());
3587 out << data << std::flush;
3591 mooseError(
"Unable to open file `", filename,
"` for writing ", param,
" data to it.");
3597 const std::string & doc)
3610 #ifdef MOOSE_MFEM_ENABLED 3615 auto string_set = std::set<std::string>(string_vec.begin(), string_vec.end());
3618 _mfem_device = std::make_shared<mfem::Device>(device_string);
3622 else if (!device_string.empty() && string_set !=
_mfem_devices)
3623 mooseError(
"Attempted to configure with MFEM devices '",
3625 "', but we have already configured the MFEM device object with the devices '",
std::string name(const ElemQuality q)
GhostingFunctorIterator ghosting_functors_begin() const
std::list< std::string > getCheckpointFiles() const
Extract all possible checkpoint file names.
virtual bool constructingMeshGenerators() const
Whether this app is constructing mesh generators.
std::list< std::string > getCheckpointDirectories() const
Get all checkpoint directories.
static const std::string & checkpointSuffix()
The file suffix for the checkpoint mesh.
std::string getFileName(bool stripLeadingPath=true) const
Return the primary (first) filename that was parsed Note: When stripLeadingPath is false...
void mooseInfo(Args &&... args) const
std::string docsDir(const std::string &app_name)
Returns the directory of any installed docs/site.
void build()
Parse an input file (or text string if provided) consisting of hit syntax and setup objects in the MO...
void addExecutorParams(const std::string &type, const std::string &name, const InputParameters ¶ms)
Adds the parameters for an Executor to the list of parameters.
virtual std::string getPrintableName() const
Get printable name of the application.
unsigned int _multiapp_level
Level of multiapp, the master is level 0. This used by the Console to indent output.
virtual std::string getInstallableInputs() const
Method to retrieve the installable inputs from a given applications <app>Revision.h file.
void write(std::ostream &header_stream, std::ostream &data_stream)
Writes the restartable data to header stream header_stream and data stream data_stream.
PerfGraph & _perf_graph
The PerfGraph object for this application (recoverable)
bool show_trace
Set to true (the default) to print the stack trace with error and warning messages - false to omit it...
void setOutputPosition(const Point &p)
Tell the app to output in a specific position.
std::string join(Iterator begin, Iterator end, const std::string &delimiter)
Python-like join function for strings over an iterator range.
std::unordered_map< std::string, std::pair< std::string, std::unique_ptr< InputParameters > > > _executor_params
Used in building the Executors Maps the name of the Executor block to the <type, params> ...
bool isUltimateMaster() const
Whether or not this app is the ultimate master app.
std::map< Moose::RelationshipManagerType, std::set< const RelationshipManager * > > _attached_relationship_managers
The relationship managers that have been attached (type -> RMs)
const InputParameters & _pars
The object's parameters.
Reader for restartable data written by the RestartableDataWriter.
std::string _restart_recover_base
The base name to restart/recover from. If blank then we will find the newest checkpoint file...
void dynamicRegistration(const libMesh::Parameters ¶ms)
Helper method for dynamic loading of objects.
void tokenize(const std::string &str, std::vector< T > &elements, unsigned int min_len=1, const std::string &delims="/")
This function will split the passed in string on a set of delimiters appending the substrings to the ...
bool hasRestartableMetaData(const std::string &name, const RestartableDataMapName &metaname) const
virtual void setupOptions()
Setup options based on InputParameters.
PerfGraph & createRecoverablePerfGraph()
Creates a recoverable PerfGraph.
std::shared_ptr< DisplacedProblem > displaced_problem
std::string libNameToAppName(const std::string &library_name) const
Converts a library name to an application name:
const unsigned int invalid_uint
RelationshipManagerType
Main types of Relationship Managers.
void registerCapabilities()
Register all base MooseApp capabilities to the Moose::Capabilities registry.
const std::shared_ptr< Parser > _parser
Parser for parsing the input file (owns the root hit node)
std::string getFrameworkVersion() const
Returns the framework version.
Base class for everything in MOOSE with a name and a type.
const std::multimap< std::string, ActionInfo > & getAssociatedActions() const
Return all Syntax to Action associations.
void setRecover(bool value)
void buildFullTree(const std::string &search_string)
Use MOOSE Factories to construct a full parse tree for documentation or echoing input.
std::vector< std::pair< std::string, std::string > > getRelationshipManagerInfo() const
Returns the Relationship managers info suitable for printing.
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
bool hasRMClone(const RelationshipManager &template_rm, const MeshBase &mesh) const
torch::DeviceType determineLibtorchDeviceType(const MooseEnum &device) const
Function to determine the device which should be used by libtorch on this application.
bool _file_base_set_by_user
Whether or not file base is set through input or setOutputFileBase by MultiApp.
const Action * getCurrentAction() const
bool _output_position_set
Whether or not an output position has been set for this app.
void addDependency(const std::string &task, const std::string &pre_req)
std::unique_ptr< TheWarehouse > _the_warehouse
The combined warehouse for storing any MooseObject based object.
InputParameters getValidParams(const std::string &name)
void setCheckUnusedFlag(bool warn_is_error=false)
Set a flag so that the parser will either warn or error when unused variables are seen after parsing ...
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
bool hasInitialBackup() const
void setInput(std::unique_ptr< std::stringstream > header_stream, std::unique_ptr< std::stringstream > data_stream)
Sets the input stream for reading from the stringstreams header_stream and data_stream for the header...
static std::filesystem::path metaDataFolderBase(const std::filesystem::path &folder_base, const std::string &map_suffix)
The file suffix for meta data (header and data)
bool _warnings_are_errors
Variable to toggle any warning into an error (includes deprecated code warnings)
std::string installedInputsDir(const std::string &app_name, const std::string &dir_name, const std::string &extra_error_msg="")
Returns the directory of any installed inputs or the empty string if none are found.
InputParameterWarehouse & getInputParameterWarehouse()
Get the InputParameterWarehouse for MooseObjects.
bool tokenizeAndConvert(const std::string &str, std::vector< T > &tokenized_vector, const std::string &delimiter=" \\\)
tokenizeAndConvert splits a string using delimiter and then converts to type T.
static const RestartableDataMapName MESH_META_DATA
std::unordered_map< RestartableDataMapName, std::pair< RestartableDataMap, std::string > > _restartable_meta_data
General storage for custom RestartableData that can be added to from outside applications.
void registerTaskName(const std::string &task, bool should_auto_build=false)
Method to register a new task.
virtual const std::type_info & typeId() const =0
The type ID of the underlying data.
std::shared_ptr< MooseMesh > & displacedMesh()
static const std::map< std::string, std::vector< std::shared_ptr< RegistryEntryBase > > > & allActions()
Returns a per-label keyed map of all Actions in the registry.
virtual std::string appBinaryName() const
const InputParameters & parameters() const
Get the parameters of the object.
const std::shared_ptr< MooseMesh > & getMesh() const
std::string getOutputFileBase(bool for_non_moose_build_output=false) const
Get the output file base name.
static void addInputParam(InputParameters ¶ms)
T * get(const std::unique_ptr< T > &u)
The MooseUtils::get() specializations are used to support making forwards-compatible code changes fro...
RelationshipManager & getRMClone(const RelationshipManager &template_rm, const MeshBase &mesh) const
Return the relationship manager clone originally created from the provided template relationship mana...
void setFinalTask(const std::string &task)
bool runInputs()
Handles the run input parameter logic: Checks to see whether a directory exists in user space and lau...
void registerRestartableNameWithFilter(const std::string &name, Moose::RESTARTABLE_FILTER filter)
NOTE: This is an internal function meant for MOOSE use only!
virtual void run()
Run the application.
void removeRelationshipManager(std::shared_ptr< RelationshipManager > relationship_manager)
Purge this relationship manager from meshes and DofMaps and finally from us.
Real _start_time
The time at which to start the simulation.
Writer for restartable data, to be read by the RestartableDataReader.
This attribute describes sorting state.
void createExecutors()
After adding all of the Executor Params - this function will actually cause all of them to be built...
void recursivelyCreateExecutors(const std::string ¤t_executor_name, std::list< std::string > &possible_roots, std::list< std::string > ¤t_branch)
Internal function used to recursively create the executor objects.
bool forceRestart() const
Whether or not we are forcefully restarting (allowing the load of potentially incompatibie checkpoint...
std::filesystem::path restartFolderBase(const std::filesystem::path &folder_base) const
The file suffix for restartable data.
std::pair< std::filesystem::path, std::filesystem::path > splitFileName(const T &full_file)
Function for splitting path and filename.
void remove_ghosting_functor(GhostingFunctor &ghosting_functor)
bool hasRelationshipManager(const std::string &name) const
Returns a Boolean indicating whether a RelationshipManater exists with the same name.
std::list< std::string > getFilesInDirs(const std::list< std::string > &directory_list, const bool files_only=true)
Retrieves the names of all of the files contained within the list of directories passed into the rout...
bool _check_input
true if we want to just check the input file
TODO: delete this later - it is a temporary hack for dealing with inter-system dependencies.
const Parallel::Communicator & comm() const
bool hasRestartableDataMap(const RestartableDataMapName &name) const
void addActionBlock(std::shared_ptr< Action > blk)
This method add an Action instance to the warehouse.
std::set< std::string > _mfem_devices
MFEM supported devices based on user-provided config.
Syntax _syntax
Syntax of the input file.
Syntax & syntax()
Returns a writable reference to the syntax object.
std::map< std::string, std::shared_ptr< Executor > > _executors
Pointers to all of the Executors for this run.
std::vector< std::filesystem::path > writeRestartableMetaData(const RestartableDataMapName &name, const std::filesystem::path &folder_base)
Writes the restartable meta data for name with a folder base of folder_base.
ExecuteMooseObjectWarehouse< MultiApp > & getMultiAppWarehouse()
bool _trap_fpe
Whether or not FPE trapping should be turned on.
int exitCode() const
Get the shell exit code for the application.
GhostingFunctorIterator ghosting_functors_end() const
processor_id_type processor_id() const
Returns the MPI processor ID of the current processor.
static const std::map< std::string, std::vector< std::shared_ptr< RegistryEntryBase > > > & allObjects()
Returns a per-label keyed map of all MooseObjects in the registry.
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
Helper class to hold streams for Backup and Restore operations.
const hit::Node * getCurrentActionHitNode() const
ActionWarehouse _action_warehouse
Where built actions are stored.
std::string realpath(const std::string &path)
Wrapper around PetscGetRealPath, which is a cross-platform replacement for realpath.
RestartableDataReader _rd_reader
void checkMetaDataIntegrity() const
Function to check the integrity of the restartable meta data structure.
const std::list< Action * > & getActionListByName(const std::string &task) const
Retrieve a constant list of Action pointers associated with the passed in task.
virtual const std::vector< std::string > & forWhom() const
The object (or Action) this RelationshipManager was built for.
static InputParameters validParams()
bool isRestarting() const
Whether or not this is a "restart" calculation.
bool isSplitMesh() const
Whether or not this is a split mesh operation.
RestartableDataMap & getRestartableDataMap(const RestartableDataMapName &name)
Return a reference to restartable data for the specific type flag.
Holds the syntax in a Json::Value tree.
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
std::string hostname()
Get the hostname the current process is running on.
FEProblemBase & feProblem() const
std::shared_ptr< Action > create(const std::string &action, const std::string &action_name, InputParameters ¶meters)
MooseApp(const InputParameters ¶meters)
Constructor is protected so that this object is constructed through the AppFactory object...
std::optional< MooseEnum > getComputeDevice() const
Get the device accelerated computations are supposed to be running on.
void allowRemoteElementRemoval(bool allow_removal)
Set whether to allow remote element removal.
std::vector< RestartableDataMap > _restartable_data
Where the restartable data is held (indexed on tid)
std::string camelCaseToUnderscore(const std::string &camel_case_name)
Function for converting a camel case name to a name containing underscores.
RelationshipManager & createRMFromTemplateAndInit(const RelationshipManager &template_rm, MooseMesh &moose_mesh, MeshBase &mesh, const libMesh::DofMap *dof_map=nullptr)
Take an input relationship manager, clone it, and then initialize it with provided mesh and optional ...
void setOutputFileBase(const std::string &output_file_base)
Override the selection of the output file base name.
std::vector< std::string > split(const std::string &str, const std::string &delimiter, std::size_t max_count=std::numeric_limits< std::size_t >::max())
Python like split functions for strings.
This class wraps provides and tracks access to command line parameters.
int _exit_code
The exit code.
Storage for restartable data that is ordered based on insertion order.
CapabilityUtils::Result check(const std::string &requested_capabilities) const
check if the given required capabilities are fulfilled, returns a bool, a reason, and a verbose docum...
std::shared_ptr< MooseMesh > & mesh()
TODO: delete this later - it is a temporary hack for dealing with inter-system dependencies.
MeshGeneratorSystem _mesh_generator_system
The system that manages the MeshGenerators.
void attachRelationshipManagers(Moose::RelationshipManagerType rm_type, bool attach_geometric_rm_final=false)
Attach the relationship managers of the given type Note: Geometric relationship managers that are sup...
const MeshBase * getMeshPtr() const
bool _start_time_set
Whether or not an start time has been set.
virtual libMesh::DofMap & dofMap()
Gets writeable reference to the dof map.
void allow_remote_element_removal(bool allow)
void libmesh_ignore(const Args &...)
void possiblyLoadRestartableMetaData(const RestartableDataMapName &name, const std::filesystem::path &folder_base)
Loads the restartable meta data for name if it is available with the folder base folder_base.
const std::string & name() const
Get the name of the class.
bool showInputs() const
Prints a message showing the installable inputs for a given application (if getInstallableInputs has ...
bool addRelationshipManager(std::shared_ptr< RelationshipManager > relationship_manager)
Transfers ownership of a RelationshipManager to the application for lifetime management.
RestartableDataValue & getRestartableMetaData(const std::string &name, const RestartableDataMapName &metaname, THREAD_ID tid)
std::shared_ptr< NullExecutor > _null_executor
Used to return an executor that does nothing.
const T & get(std::string_view) const
const std::string & getLastInputFileName() const
virtual void preBackup()
Insertion point for other apps that is called before backup()
InputParameters & getObjectParams()
Retrieve the parameters of the object to be created by this action.
void setErrorOverridden()
Set a flag so that the parser will throw an error if overridden parameters are detected.
void resetFileBase()
Resets the file base for all FileOutput objects.
virtual void postRestore(const bool)
Insertion point for other apps that is called after restore()
T command_line_value(const std::string &, T)
void loadLibraryAndDependencies(const std::string &library_filename, const libMesh::Parameters ¶ms, bool load_dependencies=true)
Recursively loads libraries and dependencies in the proper order to fully register a MOOSE applicatio...
virtual std::unique_ptr< Base > create()=0
Tracks the libmesh system number that a MooseObject is associated with.
const std::vector< std::shared_ptr< T > > & getObjects(THREAD_ID tid=0) const
Retrieve complete vector to the all/block/boundary restricted objects for a given thread...
bool _restart
Whether or not this is a restart run.
Real value(unsigned n, unsigned alpha, unsigned beta, Real x)
std::unique_ptr< Backup > backup()
Backs up the application memory in a Backup.
bool _deprecated_is_error
Variable to toggle only deprecated warnings as errors.
Generic AppFactory class for building Application objects.
RESTARTABLE_FILTER
The filter type applied to a particular piece of "restartable" data.
void clearAppParams(const InputParameters ¶ms, const ClearAppParamsKey)
Clears the stored parameters for the given application parameteres.
void mooseDeprecated(Args &&... args) const
void meshChanged()
Calls the meshChanged method for every output object.
void setErrorOnLoadWithDifferentNumberOfProcessors(bool value)
void setActive(bool active)
Turn on or off timing.
RestartableDataValue & registerRestartableData(std::unique_ptr< RestartableDataValue > data, THREAD_ID tid, bool read_only, const RestartableDataMapName &metaname="")
SimpleRange< IndexType > as_range(const std::pair< IndexType, IndexType > &p)
void initSyntaxFormatter(SyntaxFormatterType type, bool dump_mode)
Creates a syntax formatter for printing.
Specialized factory for generic Action System objects.
bool checkFileReadable(const std::string &filename, bool check_line_endings=false, bool throw_on_unreadable=true, bool check_for_git_lfs_pointer=true)
Checks to see if a file is readable (exists and permissions)
void setRestart(bool value)
Sets the restart/recover flags.
AttribBoundaries tracks all boundary IDs associated with an object.
std::shared_ptr< Executioner > _executioner
Pointer to the executioner of this run (typically build by actions)
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
ActionFactory _action_factory
The Factory responsible for building Actions.
std::string runTestsExecutable()
Returns the location of either a local repo run_tests script - or an installed test executor script i...
void disableLivePrint()
Completely disables Live Print (cannot be restarted)
const std::string & type() const
Get the type of this class.
void restoreFromInitialBackup(const bool for_restart)
Restores from a "initial" backup, that is, one set in _initial_backup.
std::string underscoreToCamelCase(const std::string &underscore_name, bool leading_upper_case)
Function for converting an underscore name to a camel case name.
const Parser & parser() const
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
RegistrationType
Enumeration for holding the valid types of dynamic registrations allowed.
Executioners are objects that do the actual work of solving your problem.
enum MooseApp::UNUSED_CHECK _enable_unused_check
bool _recover
Whether or not this is a recovery run.
void buildJsonSyntaxTree(JsonSyntaxTree &tree) const
Use MOOSE Factories to construct a parameter tree for documentation or echoing input.
Point _output_position
The output position.
void mooseDeprecated(Args &&... args)
Emit a deprecated code/feature message with the given stringified, concatenated args.
const std::shared_ptr< CommandLine > _command_line
The CommandLine object.
void errorCheck(const libMesh::Parallel::Communicator &comm, bool warn_unused, bool err_unused)
const nlohmann::json & getRoot() const
Get the root of the tree.
bool _error_overridden
Indicates whether warnings or errors are displayed when overridden parameters are detected...
virtual std::string getVersion() const
Returns the current version of the framework or application (default: framework version).
SolutionInvalidity & createRecoverableSolutionInvalidity()
Creates a recoverable SolutionInvalidity.
bool _heap_profiling
Memory profiling.
std::string getPrimaryFileName(bool stripLeadingPath=true) const
Return the primary (first) filename that was parsed.
TODO: delete this later - it is a temporary hack for dealing with inter-system dependencies.
std::string stringify(const T &t)
conversion to string
Class for storing and utilizing output objects.
std::string demangle(const char *name)
void addForWhom(const std::string &for_whom)
Add another name to for_whom.
Interface for objects interacting with the PerfGraph.
Executioner * getExecutioner() const
Retrieve the Executioner for this App.
std::set< std::string > getLibrarySearchPaths(const std::string &library_path_from_param) const
Return the paths searched by MOOSE when loading libraries.
The SolutionInvalidity will contain all the information about the occurrence(s) of solution invalidit...
std::unordered_map< std::string, DynamicLibraryInfo > _lib_handles
The library archive (name only), registration method and the handle to the method.
void outputMachineReadableData(const std::string ¶m, const std::string &start_marker, const std::string &end_marker, const std::string &data) const
Outputs machine readable data (JSON, YAML, etc.) either to the screen (if no filename was provided as...
static std::filesystem::path restartableDataFolder(const std::filesystem::path &folder_base)
virtual std::string type() const =0
String identifying the type of parameter stored.
static AppFactory & instance()
Get the instance of the AppFactory.
Residual objects have this attribute.
const std::string & getCurrentTaskName() const
const std::string & getRestartableDataMapName(const RestartableDataMapName &name) const
static Capabilities & getCapabilityRegistry()
bool hasRecoverFileBase() const
std::map< const RelationshipManager *, std::map< const MeshBase *, std::unique_ptr< RelationshipManager > > > _template_to_clones
Map from a template relationship manager to a map in which the key-value pairs represent the MeshBase...
bool hasRestartRecoverFileBase() const
Return true if the recovery file base is set.
void registerRestartableDataMapName(const RestartableDataMapName &name, std::string suffix="")
Reserve a location for storing custom RestartableDataMap objects.
static void checkReservedCapability(const std::string &capability)
Helper that reports an error if the given capability is reserved and should not be added via addCapab...
void restore(const std::filesystem::path &folder_base, const bool for_restart)
Restore an application from file.
bool _trap_fpe
Variable indicating whether we will enable FPE trapping for this run.
void loadRestartableMetaData(const std::filesystem::path &folder_base)
Loads all available restartable meta data if it is available with the folder base folder_base...
std::filesystem::path pathjoin(const std::filesystem::path &p)
virtual void executeExecutioner()
Execute the Executioner that was built.
bool _distributed_mesh_on_command_line
This variable indicates that DistributedMesh should be used for the libMesh mesh underlying MooseMesh...
void addExecutor(const std::string &type, const std::string &name, const InputParameters ¶ms)
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual std::shared_ptr< const DisplacedProblem > getDisplacedProblem() const
RelationshipManagers are used for describing what kinds of non-local resources are needed for an obje...
PetscErrorCode petscSetupOutput(CommandLine *cmd_line)
void add_command_line_name(const std::string &name)
Moose::Builder _builder
Builder for building app related parser tree.
const std::shared_ptr< MooseMesh > & getDisplacedMesh() const
std::string RestartableDataMapName
std::set< std::shared_ptr< RelationshipManager > > _relationship_managers
The relationship managers that have been added.
OutputWarehouse _output_warehouse
OutputWarehouse object for this App.
std::string _output_file_base
The output file basename.
std::streambuf * _output_buffer_cache
Cache output buffer so the language server can turn it off then back on.
static void addAppParam(InputParameters ¶ms)
bool _cpu_profiling
CPU profiling.
T & set(const std::string &)
if(!dmm->_nl) SETERRQ(PETSC_COMM_WORLD
Concrete definition of a parameter value for a specified type.
void build()
Builds all auto-buildable tasks.
void registerAll(Factory &f, ActionFactory &af, Syntax &s)
Register objects that are in MOOSE.
virtual void runInputFile()
Actually build everything in the input file.
bool setColorConsole(bool use_color, bool force=false)
Turns color escape sequences on/off for info written to stdout.
std::variant< bool, int, std::string > Type
A capability can have a bool, int, or string value.
virtual std::string header() const
Returns a string to be printed at the beginning of a simulation.
void mooseWarning(Args &&... args) const
Emits a warning prefixed with object name and type.
Holding syntax for parsing input files.
class infix_ostream_iterator if void
std::unordered_set< std::string > DataNames
void mooseError(Args &&... args) const
Emits an error prefixed with object name and type and optionally a file path to the top-level block p...
static const std::string MESH_META_DATA_SUFFIX
SolverSystem & getSolverSystem(unsigned int sys_num)
Get non-constant reference to a solver system.
void executeAllActions()
This method loops over all actions in the warehouse and executes them.
std::unique_ptr< InputParameterWarehouse > _input_parameter_warehouse
Input parameter storage structure; unique_ptr so we can control its destruction order.
virtual std::unique_ptr< GhostingFunctor > clone() const
std::string getCurrentWorkingDir()
Returns the current working directory as a string.
const std::vector< std::string > & getInputFileNames() const
void setMFEMDevice(const std::string &device_string, Moose::PassKey< MFEMProblemSolve >)
Create/configure the MFEM device with the provided device_string.
Tracks whether the object is on the displaced mesh.
static void addCapability(const std::string &capability, CapabilityUtils::Type value, const std::string &doc)
register a new capability
InputStreams clear()
Clears the contents of the reader (header stream, data stream, header)
void makedirs(const std::string &dir_name, bool throw_on_failure=false)
Recursively make directories.
std::unique_ptr< Backup > finalizeRestore()
Finalizes (closes) the restoration process done in restore().
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
bool appendingMeshGenerators() const
Whether or not mesh generators are currently being appended (append_mesh_generator task) ...
static const std::string allow_data_driven_param
The name of the boolean parameter on the MooseApp that will enable data driven generation.
void restore(const DataNames &filter_names={})
Restores the restartable data.
void dynamicAllRegistration(const std::string &app_name, Factory *factory, ActionFactory *action_factory, Syntax *syntax, std::string library_path, const std::string &library_name)
Thes methods are called to register applications or objects on demand.
const DataNames & getRecoverableData() const
Return a reference to the recoverable data object.
void setDeclared(const SetDeclaredKey)
Sets that this restartable value has been declared.
const std::shared_ptr< libMesh::Parallel::Communicator > _comm
The MPI communicator this App is going to use.
std::string getPrintableVersion() const
Non-virtual method for printing out the version string in a consistent format.
std::shared_ptr< mfem::Device > _mfem_device
The MFEM Device object.
std::vector< const T * > getActions()
Retrieve all actions in a specific type ordered by their names.
bool pathExists(const std::string &path)
void createMinimalApp()
Method for creating the minimum required actions for an application (no input file) ...
void setExitCode(const int exit_code)
Sets the exit code that the application will exit with.
Exception to be thrown whenever we have _throw_on_error set and a mooseError() is emitted...
bool isRecovering() const
Whether or not this is a "recover" calculation.
DataNames _recoverable_data_names
Data names that will only be read from the restart file during RECOVERY.
Executor * getExecutor() const
The PerfGraph will hold the master list of all registered performance segments and the head PerfNode...
bool copyInputs()
Handles the copy_inputs input parameter logic: Checks to see whether the passed argument is valid (a ...
bool _throw_on_error
Variable to turn on exceptions during mooseError(), should only be used within MOOSE unit tests or wh...
bool isParamSetByUser(const std::string &name) const
Test if the supplied parameter is set by a user, as opposed to not set or set to default.
void clear()
This method deletes all of the Actions in the warehouse.
A scope guard that guarantees that whatever happens between when it gets created and when it is destr...
void disableCheckUnusedFlag()
Removes warnings and error checks for unrecognized variables in the input file.
void add(const std::string &capability, CapabilityUtils::Type value, const std::string &doc)
register a new capability
bool _split_mesh
Whether or not we are performing a split mesh operation (–split-mesh)
void ErrorVector unsigned int
const bool _use_executor
Indicates whether we are operating in the new/experimental executor mode instead of using the legacy ...
Abstract definition of a RestartableData value.
Class for parsing input files.
Meta-action for creating common output object parameters This action serves two purpose, first it adds common output object parameters.
OutputWarehouse & getOutputWarehouse()
Get the OutputWarehouse objects.
std::string getExecutableName()
Gets the name of the running executable on Mac OS X and linux.
std::string appNameToLibName(const std::string &app_name) const
Converts an application name to a library name: Examples: AnimalApp -> libanimal-oprof.la (assuming METHOD=oprof) ThreeWordAnimalApp -> libthree_word_animal-dbg.la (assuming METHOD=dbg)
static InputParameters validParams()
static char addKnownLabel(const std::string &label)
addKnownLabel whitelists a label as valid for purposes of the checkLabels function.
void setStartTime(Real time)
Set the starting time for the simulation.
std::shared_ptr< Executor > _executor
Pointer to the Executor of this run.
The Executor class directs the execution flow of simulations.
void add_ghosting_functor(GhostingFunctor &ghosting_functor)
std::string findTestRoot()
Searches in the current working directory and then recursively up in each parent directory looking fo...
void errorCheck()
Runs post-initialization error checking that cannot be run correctly unless the simulation has been f...
std::set< std::string > getLoadedLibraryPaths() const
Return the paths of loaded libraries.
std::string _early_exit_param
Indicates if simulation is ready to exit, and keeps track of which param caused it to exit...
static bool isAvailable(const std::filesystem::path &folder_base)
void dynamicAppRegistration(const std::string &app_name, std::string library_path, const std::string &library_name, bool lib_load_deps)
std::unique_ptr< Backup > *const _initial_backup
The backup for use in initial setup; this will get set from the _initial_backup input parameter that ...