Base class for MOOSE-based applications. More...
#include <MooseApp.h>
Classes | |
struct | DynamicLibraryInfo |
struct | FixedPointConfig |
Stores configuration options relating to the fixed-point solving capability. More... | |
struct | InterfaceRegistryObjects |
struct | InterfaceRegistryObjectsBase |
Public Member Functions | |
torch::DeviceType | getLibtorchDevice () const |
Get the device torch is supposed to be running on. More... | |
virtual | ~MooseApp () |
TheWarehouse & | theWarehouse () |
virtual std::string | getPrintableName () const |
Get printable name of the application. More... | |
virtual std::string | appBinaryName () const |
int | exitCode () const |
Get the shell exit code for the application. More... | |
void | setExitCode (const int exit_code) |
Sets the exit code that the application will exit with. More... | |
InputParameters & | parameters () |
Get the parameters of the object. More... | |
const RankMap & | rankMap () |
The RankMap is a useful object for determining how the processes are laid out on the physical nodes of the cluster. More... | |
PerfGraph & | perfGraph () |
Get the PerfGraph for this app. More... | |
template<typename T > | |
const T & | getRenamedParam (const std::string &old_name, const std::string &new_name) const |
Retrieve a renamed parameter for the object. More... | |
bool | isParamValid (const std::string &name) const |
bool | isParamSetByUser (const std::string &nm) const |
virtual void | run () |
Run the application. More... | |
std::string | getFrameworkVersion () const |
Returns the framework version. More... | |
virtual std::string | getVersion () const |
Returns the current version of the framework or application (default: framework version). More... | |
std::string | getPrintableVersion () const |
Non-virtual method for printing out the version string in a consistent format. More... | |
virtual void | setupOptions () |
Setup options based on InputParameters. More... | |
ActionWarehouse & | actionWarehouse () |
Return a writable reference to the ActionWarehouse associated with this app. More... | |
const ActionWarehouse & | actionWarehouse () const |
Return a const reference to the ActionWarehouse associated with this app. More... | |
Moose::Builder & | builder () |
Returns a writable reference to the builder. More... | |
Syntax & | syntax () |
Returns a writable reference to the syntax object. More... | |
const std::vector< std::string > & | getInputFileNames () const |
const std::string & | getLastInputFileName () const |
void | setOutputFileBase (const std::string &output_file_base) |
Override the selection of the output file base name. More... | |
std::string | getOutputFileBase (bool for_non_moose_build_output=false) const |
Get the output file base name. More... | |
void | setOutputPosition (const Point &p) |
Tell the app to output in a specific position. More... | |
std::list< std::string > | getCheckpointDirectories () const |
Get all checkpoint directories. More... | |
std::list< std::string > | getCheckpointFiles () const |
Extract all possible checkpoint file names. More... | |
bool | hasOutputPosition () const |
Whether or not an output position has been set. More... | |
Point | getOutputPosition () const |
Get the output position. More... | |
void | setStartTime (Real time) |
Set the starting time for the simulation. More... | |
bool | hasStartTime () const |
Real | getStartTime () const |
void | setGlobalTimeOffset (Real offset) |
Each App has it's own local time. More... | |
Real | getGlobalTimeOffset () const |
Each App has it's own local time. More... | |
std::string | getFileName (bool stripLeadingPath=true) const |
Return the primary (first) filename that was parsed Note: When stripLeadingPath is false, this function returns the same name as getInputFileName() method when the input file is not a link. More... | |
void | setErrorOverridden () |
Set a flag so that the parser will throw an error if overridden parameters are detected. More... | |
void | disableCheckUnusedFlag () |
Removes warnings and error checks for unrecognized variables in the input file. More... | |
Executioner * | getExecutioner () const |
Retrieve the Executioner for this App. More... | |
Executor * | getExecutor () const |
NullExecutor * | getNullExecutor () const |
bool | useExecutor () const |
FEProblemBase & | feProblem () const |
void | setExecutioner (std::shared_ptr< Executioner > &&executioner) |
Set the Executioner for this App. More... | |
void | setExecutor (std::shared_ptr< Executor > &&executor) |
void | addExecutor (const std::string &type, const std::string &name, const InputParameters ¶ms) |
void | addExecutorParams (const std::string &type, const std::string &name, const InputParameters ¶ms) |
Adds the parameters for an Executor to the list of parameters. More... | |
Parser & | parser () |
void | createExecutors () |
After adding all of the Executor Params - this function will actually cause all of them to be built. More... | |
Executor & | getExecutor (const std::string &name, bool fail_if_not_found=true) |
Get an Executor. More... | |
FixedPointConfig & | fixedPointConfig () |
This info is stored here because we need a "globalish" place to put it in order to allow communication between a multiapp and solver-specific internals (i.e. More... | |
bool & | useNonlinear () |
Returns a writable Boolean indicating whether this app will use a Nonlinear or Eigen System. More... | |
bool & | useEigenvalue () |
Returns a writable Boolean indicating whether this app will use an eigenvalue executioner. More... | |
Factory & | getFactory () |
Retrieve a writable reference to the Factory associated with this App. More... | |
ActionFactory & | getActionFactory () |
Retrieve a writable reference to the ActionFactory associated with this App. More... | |
processor_id_type | processor_id () const |
Returns the MPI processor ID of the current processor. More... | |
std::shared_ptr< CommandLine > | commandLine () const |
Get the command line. More... | |
void | setExodusFileRestart (bool flag) |
Set the flag to indicate whether or not we need to use a separate Exodus reader to read the mesh BEFORE we create the mesh. More... | |
bool | getExodusFileRestart () const |
Whether or not we need to use a separate Exodus reader to read the mesh BEFORE we create the mesh. More... | |
void | setExReaderForRestart (std::shared_ptr< libMesh::ExodusII_IO > &&exreader) |
Set the Exodus reader to restart variables from an Exodus mesh file. More... | |
libMesh::ExodusII_IO * | getExReaderForRestart () const |
Get the Exodus reader to restart variables from an Exodus mesh file. More... | |
virtual void | runInputFile () |
Actually build everything in the input file. More... | |
virtual void | executeExecutioner () |
Execute the Executioner that was built. More... | |
bool | getDistributedMeshOnCommandLine () const |
Returns true if the user specified –distributed-mesh (or –parallel-mesh, for backwards compatibility) on the command line and false otherwise. More... | |
bool | isRecovering () const |
Whether or not this is a "recover" calculation. More... | |
bool | isRestarting () const |
Whether or not this is a "restart" calculation. More... | |
bool | isSplitMesh () const |
Whether or not this is a split mesh operation. More... | |
void | setRestartRecoverFileBase (const std::string &file_base) |
mutator for recover_base (set by RecoverBaseAction) More... | |
bool | testCheckpointHalfTransient () const |
Whether or not this simulation should only run half its transient (useful for testing recovery) More... | |
void | setOutputFileNumbers (const std::map< std::string, unsigned int > &numbers) |
Store a map of outputter names and file numbers The MultiApp system requires this to get the file numbering to propagate down through the Multiapps. More... | |
const std::map< std::string, unsigned int > & | getOutputFileNumbers () const |
Store a map of outputter names and file numbers The MultiApp system requires this to get the file numbering to propogate down through the multiapps. More... | |
OutputWarehouse & | getOutputWarehouse () |
Get the OutputWarehouse objects. More... | |
const OutputWarehouse & | getOutputWarehouse () const |
const SystemInfo * | getSystemInfo () const |
Get SystemInfo object. More... | |
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) More... | |
std::string | libNameToAppName (const std::string &library_name) const |
Converts a library name to an application name: More... | |
std::set< std::string > | getLoadedLibraryPaths () const |
Return the paths of loaded libraries. More... | |
std::set< std::string > | getLibrarySearchPaths (const std::string &library_path_from_param) const |
Return the paths searched by MOOSE when loading libraries. More... | |
InputParameterWarehouse & | getInputParameterWarehouse () |
Get the InputParameterWarehouse for MooseObjects. More... | |
RestartableDataValue & | registerRestartableData (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid, bool read_only, const RestartableDataMapName &metaname="") |
RestartableDataValue & | registerRestartableData (const std::string &name, std::unique_ptr< RestartableDataValue > data, THREAD_ID tid, bool read_only, const RestartableDataMapName &metaname="") |
bool | hasRestartableMetaData (const std::string &name, const RestartableDataMapName &metaname) const |
RestartableDataValue & | getRestartableMetaData (const std::string &name, const RestartableDataMapName &metaname, THREAD_ID tid) |
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 . More... | |
void | loadRestartableMetaData (const std::filesystem::path &folder_base) |
Loads all available restartable meta data if it is available with the folder base folder_base . More... | |
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 . More... | |
std::vector< std::filesystem::path > | writeRestartableMetaData (const std::filesystem::path &folder_base) |
Writes all available restartable meta data with a file base of file_base . More... | |
RestartableDataMap & | getRestartableDataMap (const RestartableDataMapName &name) |
Return a reference to restartable data for the specific type flag. More... | |
bool | hasRestartableDataMap (const RestartableDataMapName &name) const |
void | registerRestartableDataMapName (const RestartableDataMapName &name, std::string suffix="") |
Reserve a location for storing custom RestartableDataMap objects. More... | |
const std::string & | getRestartableDataMapName (const RestartableDataMapName &name) const |
const DataNames & | getRecoverableData () const |
Return a reference to the recoverable data object. More... | |
std::vector< std::filesystem::path > | backup (const std::filesystem::path &folder_base) |
Backs up the application to the folder folder_base . More... | |
std::unique_ptr< Backup > | backup () |
Backs up the application memory in a Backup. More... | |
virtual void | preBackup () |
Insertion point for other apps that is called before backup() More... | |
void | restore (const std::filesystem::path &folder_base, const bool for_restart) |
Restore an application from file. More... | |
void | restore (std::unique_ptr< Backup > backup, const bool for_restart) |
Restore an application from the backup backup . More... | |
virtual void | postRestore (const bool) |
Insertion point for other apps that is called after restore() More... | |
void | restoreFromInitialBackup (const bool for_restart) |
Restores from a "initial" backup, that is, one set in _initial_backup. More... | |
std::unique_ptr< Backup > | finalizeRestore () |
Finalizes (closes) the restoration process done in restore(). More... | |
virtual std::string | header () const |
Returns a string to be printed at the beginning of a simulation. More... | |
unsigned int | multiAppLevel () const |
The MultiApp Level. More... | |
unsigned int | multiAppNumber () const |
The MultiApp number. More... | |
bool | isUltimateMaster () const |
Whether or not this app is the ultimate master app. More... | |
const MooseMesh * | masterMesh () const |
Returns a pointer to the master mesh. More... | |
const MooseMesh * | masterDisplacedMesh () const |
Returns a pointer to the master displaced mesh. More... | |
MeshGeneratorSystem & | getMeshGeneratorSystem () |
Gets the system that manages the MeshGenerators. More... | |
ChainControlDataSystem & | getChainControlDataSystem () |
Gets the system that manages the ChainControls. More... | |
void | addMeshGenerator (const std::string &type, const std::string &name, const InputParameters ¶ms) |
Add a mesh generator that will act on the meshes in the system. More... | |
bool | hasMeshGenerator (const MeshGeneratorName &name) const |
const MeshGenerator & | getMeshGenerator (const std::string &name) const |
std::unique_ptr< MeshBase > | getMeshGeneratorMesh () |
std::vector< std::string > | getMeshGeneratorNames () const |
const MeshGenerator & | appendMeshGenerator (const std::string &type, const std::string &name, InputParameters params) |
Append a mesh generator that will act on the final mesh generator in the system. More... | |
virtual bool | constructingMeshGenerators () const |
Whether this app is constructing mesh generators. More... | |
bool | checkInput () const |
Returns whether the Application is running in check input mode. More... | |
bool | getFPTrapFlag () const |
Returns whether FPE trapping is turned on (either because of debug or user requested) More... | |
bool | hasRelationshipManager (const std::string &name) const |
Returns a Boolean indicating whether a RelationshipManater exists with the same name. More... | |
bool | addRelationshipManager (std::shared_ptr< RelationshipManager > relationship_manager) |
Transfers ownership of a RelationshipManager to the application for lifetime management. More... | |
std::filesystem::path | restartFolderBase (const std::filesystem::path &folder_base) const |
The file suffix for restartable data. More... | |
const hit::Node * | getCurrentActionHitNode () const |
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 supposed to be attached late will be attached when Algebraic are attached. More... | |
void | attachRelationshipManagers (MeshBase &mesh, MooseMesh &moose_mesh) |
Attach geometric relationship managers to the given MeshBase object. More... | |
const std::vector< std::shared_ptr< RelationshipManager > > & | getReleationshipManagers () |
Retrieve the relationship managers. More... | |
std::vector< std::pair< std::string, std::string > > | getRelationshipManagerInfo () const |
Returns the Relationship managers info suitable for printing. More... | |
const ExecFlagEnum & | getExecuteOnEnum () const |
Return the app level ExecFlagEnum, this contains all the available flags for the app. More... | |
bool | hasInitialBackup () const |
bool | defaultAutomaticScaling () const |
Whether to enable automatic scaling by default. More... | |
const std::shared_ptr< libMesh::Parallel::Communicator > | getCommunicator () const |
const std::set< std::shared_ptr< RelationshipManager > > & | relationshipManagers () const |
Return the container of relationship managers. More... | |
void | checkMetaDataIntegrity () const |
Function to check the integrity of the restartable meta data structure. More... | |
virtual bool | errorOnJacobianNonzeroReallocation () const |
Whether this application should by default error on Jacobian nonzero reallocations. More... | |
template<class T > | |
void | registerInterfaceObject (T &interface) |
Registers an interface object for accessing with getInterfaceObjects. More... | |
template<class T > | |
const std::vector< T * > & | getInterfaceObjects () const |
Gets the registered interface objects for a given interface. More... | |
const Parallel::Communicator & | comm () const |
processor_id_type | n_processors () const |
MooseApp & | getMooseApp () const |
Get the MooseApp this class is associated with. More... | |
const std::string & | type () const |
Get the type of this class. More... | |
virtual const std::string & | name () const |
Get the name of the class. More... | |
std::string | typeAndName () const |
Get the class's combined type and name; useful in error handling. More... | |
std::string | errorPrefix (const std::string &error_type) const |
void | callMooseError (std::string msg, const bool with_prefix) const |
Calls moose error with the message msg . More... | |
SolutionInvalidity & | solutionInvalidity () |
Get the SolutionInvalidity for this app. More... | |
const SolutionInvalidity & | solutionInvalidity () const |
template<typename T > | |
const T & | getParam (const std::string &name) |
Retrieve a parameter for the object. More... | |
template<typename T > | |
const T & | getParam (const std::string &name) const |
bool | hasRestartRecoverFileBase () const |
Return true if the recovery file base is set. More... | |
bool | hasRecoverFileBase () const |
std::string | getRestartRecoverFileBase () const |
The file_base for the recovery file. More... | |
std::string | getRecoverFileBase () const |
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. More... | |
void | dynamicAppRegistration (const std::string &app_name, std::string library_path, const std::string &library_name, bool lib_load_deps) |
const std::vector< RestartableDataMap > & | getRestartableData () const |
Return reference to the restartable data object. More... | |
std::vector< RestartableDataMap > & | getRestartableData () |
void | setRestart (bool value) |
Sets the restart/recover flags. More... | |
void | setRecover (bool value) |
auto | getRestartableDataMapBegin () |
Iterator based access to the extra RestartableDataMap objects; see Checkpoint.C for use case. More... | |
auto | getRestartableDataMapEnd () |
Static Public Member Functions | |
static InputParameters | validParams () |
static const std::string & | checkpointSuffix () |
The file suffix for the checkpoint mesh. More... | |
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) More... | |
static void | addAppParam (InputParameters ¶ms) |
static void | addInputParam (InputParameters ¶ms) |
Public Attributes | |
const ConsoleStream | _console |
An instance of helper class to write streams to the Console objects. More... | |
Static Public Attributes | |
static const RestartableDataMapName | MESH_META_DATA = "MeshMetaData" |
static const std::string | MESH_META_DATA_SUFFIX = "mesh" |
Protected Types | |
enum | UNUSED_CHECK { OFF, WARN_UNUSED, ERROR_UNUSED } |
Indicates whether warnings, errors, or no output is displayed when unused parameters are detected. More... | |
Protected Member Functions | |
void | dynamicRegistration (const libMesh::Parameters ¶ms) |
Helper method for dynamic loading of objects. More... | |
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 application that may have several dependencies. More... | |
MooseApp (InputParameters parameters) | |
Constructor is protected so that this object is constructed through the AppFactory object. More... | |
void | registerRestartableNameWithFilter (const std::string &name, Moose::RESTARTABLE_FILTER filter) |
NOTE: This is an internal function meant for MOOSE use only! More... | |
void | errorCheck () |
Runs post-initialization error checking that cannot be run correctly unless the simulation has been fully set up and initialized. More... | |
PerfID | registerTimedSection (const std::string §ion_name, const unsigned int level) const |
Call to register a named section for timing. More... | |
PerfID | registerTimedSection (const std::string §ion_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const |
Call to register a named section for timing. More... | |
std::string | timedSectionName (const std::string §ion_name) const |
Protected Attributes | |
InputParameters | _pars |
Parameters of this object. More... | |
const std::string | _type |
The string representation of the type of this object as registered (see registerApp(AppName)) More... | |
const std::shared_ptr< libMesh::Parallel::Communicator > | _comm |
The MPI communicator this App is going to use. More... | |
std::string | _output_file_base |
The output file basename. More... | |
bool | _file_base_set_by_user |
Whether or not file base is set through input or setOutputFileBase by MultiApp. More... | |
bool | _output_position_set |
Whether or not an output position has been set for this app. More... | |
Point | _output_position |
The output position. More... | |
bool | _start_time_set |
Whether or not an start time has been set. More... | |
Real | _start_time |
The time at which to start the simulation. More... | |
Real | _global_time_offset |
Offset of the local App time to the "global" problem time. More... | |
std::shared_ptr< CommandLine > | _command_line |
Command line object. More... | |
Syntax | _syntax |
Syntax of the input file. More... | |
std::unique_ptr< InputParameterWarehouse > | _input_parameter_warehouse |
Input parameter storage structure; unique_ptr so we can control its destruction order. More... | |
ActionFactory | _action_factory |
The Factory responsible for building Actions. More... | |
ActionWarehouse | _action_warehouse |
Where built actions are stored. More... | |
OutputWarehouse | _output_warehouse |
OutputWarehouse object for this App. More... | |
const std::shared_ptr< Parser > | _parser |
Parser for parsing the input file. More... | |
Moose::Builder | _builder |
Builder for building app related parser tree. More... | |
std::vector< RestartableDataMap > | _restartable_data |
Where the restartable data is held (indexed on tid) More... | |
DataNames | _recoverable_data_names |
Data names that will only be read from the restart file during RECOVERY. More... | |
PerfGraph & | _perf_graph |
The PerfGraph object for this application (recoverable) More... | |
SolutionInvalidity & | _solution_invalidity |
The SolutionInvalidity object for this application. More... | |
const RankMap | _rank_map |
The RankMap is a useful object for determining how the processes are laid out on the physical hardware. More... | |
std::shared_ptr< Executioner > | _executioner |
Pointer to the executioner of this run (typically build by actions) More... | |
std::shared_ptr< Executor > | _executor |
Pointer to the Executor of this run. More... | |
std::map< std::string, std::shared_ptr< Executor > > | _executors |
Pointers to all of the Executors for this run. More... | |
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> More... | |
FixedPointConfig | _fixed_point_config |
Multiapp-related fixed point algorithm configuration details primarily intended to be passed to and used by the executioner/executor system. More... | |
const bool | _use_executor |
Indicates whether we are operating in the new/experimental executor mode instead of using the legacy executioner system. More... | |
std::shared_ptr< NullExecutor > | _null_executor |
Used to return an executor that does nothing. More... | |
bool | _use_nonlinear |
Boolean to indicate whether to use a Nonlinear or EigenSystem (inspected by actions) More... | |
bool | _use_eigen_value |
Boolean to indicate whether to use an eigenvalue executioner. More... | |
std::unique_ptr< SystemInfo > | _sys_info |
System Information. More... | |
enum MooseApp::UNUSED_CHECK | _enable_unused_check |
Factory | _factory |
bool | _error_overridden |
Indicates whether warnings or errors are displayed when overridden parameters are detected. More... | |
std::string | _early_exit_param |
Indicates if simulation is ready to exit, and keeps track of which param caused it to exit. More... | |
bool | _ready_to_exit |
int | _exit_code |
The exit code. More... | |
bool | _initial_from_file |
This variable indicates when a request has been made to restart from an Exodus file. More... | |
std::shared_ptr< libMesh::ExodusII_IO > | _ex_reader |
The Exodus reader when _initial_from_file is set to true. More... | |
bool | _distributed_mesh_on_command_line |
This variable indicates that DistributedMesh should be used for the libMesh mesh underlying MooseMesh. More... | |
bool | _recover |
Whether or not this is a recovery run. More... | |
bool | _restart |
Whether or not this is a restart run. More... | |
bool | _split_mesh |
Whether or not we are performing a split mesh operation (–split-mesh) More... | |
const bool | _use_split |
Whether or not we are using a (pre-)split mesh (automatically DistributedMesh) More... | |
bool | _trap_fpe |
Whether or not FPE trapping should be turned on. More... | |
std::string | _restart_recover_base |
The base name to restart/recover from. If blank then we will find the newest checkpoint file. More... | |
bool | _test_checkpoint_half_transient |
Whether or not this simulation should only run half its transient (useful for testing recovery) More... | |
std::map< std::string, unsigned int > | _output_file_numbers |
Map of outputer name and file number (used by MultiApps to propagate file numbers down through the multiapps) More... | |
bool | _check_input |
true if we want to just check the input file More... | |
std::set< std::shared_ptr< RelationshipManager > > | _relationship_managers |
The relationship managers that have been added. More... | |
std::map< Moose::RelationshipManagerType, std::set< const RelationshipManager * > > | _attached_relationship_managers |
The relationship managers that have been attached (type -> RMs) More... | |
std::unordered_map< RelationshipManager *, std::shared_ptr< libMesh::GhostingFunctor > > | _undisp_to_disp_rms |
A map from undisplaced relationship managers to their displaced clone (stored as the base GhostingFunctor). More... | |
std::unordered_map< std::string, DynamicLibraryInfo > | _lib_handles |
The library archive (name only), registration method and the handle to the method. More... | |
MooseApp & | _pg_moose_app |
The MooseApp that owns the PerfGraph. More... | |
const std::string | _prefix |
A prefix to use for all sections. More... | |
const Parallel::Communicator & | _communicator |
MooseApp & | _app |
The MOOSE application this is associated with. More... | |
const std::string | _name |
The name of this class. More... | |
Private Types | |
enum | RegistrationType { APPLICATION, REGALL } |
Enumeration for holding the valid types of dynamic registrations allowed. More... | |
Private Member Functions | |
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. More... | |
void | removeRelationshipManager (std::shared_ptr< RelationshipManager > relationship_manager) |
Purge this relationship manager from meshes and DofMaps and finally from us. More... | |
torch::DeviceType | determineLibtorchDeviceType (const MooseEnum &device) const |
Function to determine the device which should be used by libtorch on this application. More... | |
void | createMinimalApp () |
Method for creating the minimum required actions for an application (no input file) More... | |
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 is complete. More... | |
bool | hasRMClone (const RelationshipManager &template_rm, const MeshBase &mesh) const |
RelationshipManager & | getRMClone (const RelationshipManager &template_rm, const MeshBase &mesh) const |
Return the relationship manager clone originally created from the provided template relationship manager and mesh. More... | |
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 dof_map . More... | |
PerfGraph & | createRecoverablePerfGraph () |
Creates a recoverable PerfGraph. More... | |
SolutionInvalidity & | createRecoverableSolutionInvalidity () |
Creates a recoverable SolutionInvalidity. More... | |
bool | showInputs () const |
Prints a message showing the installable inputs for a given application (if getInstallableInputs has been overridden for an application). More... | |
virtual std::string | getInstallableInputs () const |
Method to retrieve the installable inputs from a given applications <app>Revision.h file. More... | |
bool | copyInputs () |
Handles the copy_inputs input parameter logic: Checks to see whether the passed argument is valid (a readable installed directory) and recursively copies those files into a read/writable location for the user. More... | |
bool | runInputs () |
Handles the run input parameter logic: Checks to see whether a directory exists in user space and launches the TestHarness to process the given directory. More... | |
Private Attributes | |
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. More... | |
std::unique_ptr< TheWarehouse > | _the_warehouse |
The combined warehouse for storing any MooseObject based object. More... | |
unsigned int | _multiapp_level |
Level of multiapp, the master is level 0. This used by the Console to indent output. More... | |
unsigned int | _multiapp_number |
Numbering in all the sub-apps on the same level. More... | |
const MooseMesh *const | _master_mesh |
The mesh from master app. More... | |
const MooseMesh *const | _master_displaced_mesh |
The displaced mesh from master app. More... | |
MeshGeneratorSystem | _mesh_generator_system |
The system that manages the MeshGenerators. More... | |
ChainControlDataSystem | _chain_control_system |
The system that manages the ChainControls. More... | |
RestartableDataReader | _rd_reader |
const ExecFlagEnum | _execute_flags |
Execution flags for this App. More... | |
std::streambuf * | _output_buffer_cache |
Cache output buffer so the language server can turn it off then back on. More... | |
const bool | _automatic_automatic_scaling |
Whether to turn on automatic scaling by default. More... | |
bool | _cpu_profiling = false |
CPU profiling. More... | |
bool | _heap_profiling = false |
Memory profiling. More... | |
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 object and the clone of the template relationship manager, e.g. More... | |
std::map< std::type_index, std::unique_ptr< InterfaceRegistryObjectsBase > > | _interface_registry |
Registration for interface objects. More... | |
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 typically gets set from a MultiApp that has a backup This is a pointer to a pointer because at the time of construction of the app, the backup will not be filled yet. More... | |
const torch::DeviceType | _libtorch_device |
The libtorch device this app is using. More... | |
Friends | |
class | FEProblemBase |
class | Restartable |
class | SubProblem |
Base class for MOOSE-based applications.
This generic class for application provides:
Each application should register its own objects and register its own special syntax
Definition at line 82 of file MooseApp.h.
|
private |
Enumeration for holding the valid types of dynamic registrations allowed.
Enumerator | |
---|---|
APPLICATION | |
REGALL |
Definition at line 1445 of file MooseApp.h.
|
protected |
Indicates whether warnings, errors, or no output is displayed when unused parameters are detected.
Enumerator | |
---|---|
OFF | |
WARN_UNUSED | |
ERROR_UNUSED |
Definition at line 1243 of file MooseApp.h.
|
virtual |
|
protected |
Constructor is protected so that this object is constructed through the AppFactory object.
Definition at line 404 of file MooseApp.C.
|
inline |
Return a writable reference to the ActionWarehouse associated with this app.
Definition at line 223 of file MooseApp.h.
Referenced by ElementIDOutputAction::act(), MeshOnlyAction::act(), SplitMeshAction::act(), MaterialOutputAction::act(), MeshGeneratorSystem::appendingMeshGenerators(), Console::Console(), Factory::create(), MeshGeneratorSystem::createAddedMeshGenerators(), MeshGeneratorSystem::createMeshGeneratorOrder(), MeshGeneratorSystem::dataDrivenError(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::DumpObjectsProblem(), DumpObjectsProblem::dumpVariableHelper(), MeshGeneratorSystem::getMeshGeneratorOutput(), OutputWarehouse::getOutputNames(), ActionFactory::getValidParams(), Factory::initialize(), OutputWarehouse::mooseConsole(), Console::outputInput(), Exodus::outputInput(), PostprocessorInterface::postprocessorsAdded(), ReporterInterface::reportersAdded(), MeshGenerator::setMeshProperty(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().
|
inline |
Return a const reference to the ActionWarehouse associated with this app.
Definition at line 227 of file MooseApp.h.
|
static |
Definition at line 90 of file MooseApp.C.
Referenced by AppFactory::createAppShared(), Moose::createMooseApp(), and validParams().
void MooseApp::addExecutor | ( | const std::string & | type, |
const std::string & | name, | ||
const InputParameters & | params | ||
) |
Definition at line 1402 of file MooseApp.C.
Referenced by recursivelyCreateExecutors().
void MooseApp::addExecutorParams | ( | const std::string & | type, |
const std::string & | name, | ||
const InputParameters & | params | ||
) |
Adds the parameters for an Executor to the list of parameters.
This is done so that the Executors can be created in exactly the correct order.
Definition at line 1414 of file MooseApp.C.
Referenced by ReadExecutorParamsAction::act().
|
static |
Definition at line 97 of file MooseApp.C.
Referenced by AppFactory::createAppShared(), Moose::createMooseApp(), and validParams().
|
inline |
Add a mesh generator that will act on the meshes in the system.
type | The type of MeshGenerator |
name | The name of the MeshGenerator |
params | The params used to construct the MeshGenerator |
See MeshGeneratorSystem::addMeshGenerator()
Definition at line 868 of file MooseApp.h.
Referenced by AddMeshGeneratorAction::act(), and MeshGenerator::addMeshSubgenerator().
bool MooseApp::addRelationshipManager | ( | std::shared_ptr< RelationshipManager > | relationship_manager | ) |
Transfers ownership of a RelationshipManager to the application for lifetime management.
The RelationshipManager will NOT be duplicately added if an equivalent RelationshipManager is already active. In that case, it's possible that the object will be destroyed if the reference count drops to zero.
Definition at line 2430 of file MooseApp.C.
Referenced by AdaptivityAction::act(), SetAdaptivityOptionsAction::act(), AddPeriodicBCAction::act(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), FVFluxKernel::adjustRMGhostLayers(), and FunctorSmootherTempl< T >::FunctorSmootherTempl().
|
inlinevirtual |
Definition at line 123 of file MooseApp.h.
Referenced by copyInputs(), run(), and runInputs().
|
inline |
Append a mesh generator that will act on the final mesh generator in the system.
type | The type of MeshGenerator |
name | The name of the MeshGenerator |
params | The params used to construct the MeshGenerator |
See MeshGeneratorSystem::appendMeshGenerator()
Definition at line 919 of file MooseApp.h.
std::string MooseApp::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)
Definition at line 1860 of file MooseApp.C.
Referenced by dynamicAllRegistration(), and dynamicAppRegistration().
void MooseApp::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 supposed to be attached late will be attached when Algebraic are attached.
Definition at line 2640 of file MooseApp.C.
Referenced by AddRelationshipManager::act(), CouplingFunctorCheckAction::act(), and MooseMesh::buildTypedMesh().
Attach geometric relationship managers to the given MeshBase
object.
This API is designed to work with MeshGenerators
which are executed at the very beginning of a simulation. No attempt will be made to add relationship managers to a displaced mesh, because it doesn't exist yet.
std::vector< std::filesystem::path > MooseApp::backup | ( | const std::filesystem::path & | folder_base | ) |
Backs up the application to the folder folder_base
.
Definition at line 1284 of file MooseApp.C.
Referenced by Checkpoint::output().
std::unique_ptr< Backup > MooseApp::backup | ( | ) |
Backs up the application memory in a Backup.
Definition at line 1295 of file MooseApp.C.
Referenced by finalizeRestore(), and restore().
|
inline |
Returns a writable reference to the builder.
Definition at line 232 of file MooseApp.h.
Referenced by MeshOnlyAction::act(), and SetupMeshAction::act().
|
inherited |
Calls moose error with the message msg
.
Will prefix the message with the subapp name if one exists.
If with_prefix
, then add the prefix from errorPrefix() to the error.
Definition at line 33 of file MooseBase.C.
Referenced by InputParameters::callMooseErrorHelper(), MooseBaseErrorInterface::mooseDocumentedError(), MooseBaseErrorInterface::mooseError(), MooseBaseErrorInterface::mooseErrorNonPrefixed(), and MooseBaseParameterInterface::paramError().
|
inline |
Returns whether the Application is running in check input mode.
Definition at line 942 of file MooseApp.h.
void MooseApp::checkMetaDataIntegrity | ( | ) | const |
Function to check the integrity of the restartable meta data structure.
Definition at line 2831 of file MooseApp.C.
Referenced by SetupRecoverFileBaseAction::act().
|
static |
The file suffix for the checkpoint mesh.
Definition at line 2478 of file MooseApp.C.
Referenced by SetupRecoverFileBaseAction::act(), MooseMesh::init(), and Checkpoint::output().
|
inline |
Get the command line.
Definition at line 441 of file MooseApp.h.
Referenced by FEProblemBase::addMultiApp(), Moose::Builder::build(), MultiApp::createApp(), Moose::Builder::errorCheck(), ConsoleUtils::outputFrameworkInformation(), MooseServer::parseDocumentForDiagnostics(), and ExodusFormatter::printInputFile().
|
virtual |
Whether this app is constructing mesh generators.
This is virtual to allow MooseUnitApp to override it so that we can construct MeshGenerators in unit tests
Definition at line 2930 of file MooseApp.C.
Referenced by MeshGenerator::addChildMeshGenerator(), MeshGeneratorSystem::addMeshGenerator(), MeshGenerator::addMeshSubgenerator(), MeshGenerator::addParentMeshGenerator(), MeshGenerator::checkGetMesh(), MeshGeneratorSystem::createMeshGenerator(), MeshGeneratorSystem::createMeshGeneratorOrder(), MeshGenerator::declareMeshProperty(), MeshGenerator::declareNullMeshName(), and MeshGeneratorSystem::getMeshGeneratorOutput().
|
private |
Handles the copy_inputs input parameter logic: Checks to see whether the passed argument is valid (a readable installed directory) and recursively copies those files into a read/writable location for the user.
Definition at line 1663 of file MooseApp.C.
Referenced by run().
void MooseApp::createExecutors | ( | ) |
After adding all of the Executor Params - this function will actually cause all of them to be built.
Definition at line 1481 of file MooseApp.C.
Referenced by AddExecutorAction::act().
|
private |
Method for creating the minimum required actions for an application (no input file)
Mimics the following input file:
[Mesh] type = GeneratedMesh dim = 1 nx = 1 []
[Executioner] type = Transient num_steps = 1 dt = 1 []
[Problem] solve = false []
[Outputs] console = false []
Definition at line 2330 of file MooseApp.C.
Referenced by setupOptions().
|
private |
Creates a recoverable PerfGraph.
This is a separate method so that it can be used in the constructor (multiple calls are required to declare it).
Definition at line 2899 of file MooseApp.C.
|
private |
Creates a recoverable SolutionInvalidity.
This is a separate method so that it can be used in the constructor (multiple calls are required to declare it).
Definition at line 2917 of file MooseApp.C.
|
private |
Take an input relationship manager, clone it, and then initialize it with provided mesh and optional dof_map
.
template_rm | The relationship manager template from which we will clone |
moose_mesh | The moose mesh to use for initialization |
mesh | The mesh to use for initialization |
dof_map | An optional parameter that, if provided, will be used to help init the cloned relationship manager |
Definition at line 2574 of file MooseApp.C.
Referenced by attachRelationshipManagers().
|
inline |
Whether to enable automatic scaling by default.
Definition at line 1045 of file MooseApp.h.
|
private |
Function to determine the device which should be used by libtorch on this application.
We use this function to decide what is available on different builds.
device | Enum to describe if a cpu or a gpu should be used. |
Definition at line 2938 of file MooseApp.C.
void MooseApp::disableCheckUnusedFlag | ( | ) |
Removes warnings and error checks for unrecognized variables in the input file.
Definition at line 1390 of file MooseApp.C.
void MooseApp::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.
This method attempts to load a dynamic library and register it when it is needed. Throws an error if no suitable library is found that contains the app_name in question.
Definition at line 2077 of file MooseApp.C.
Referenced by DynamicObjectRegistrationAction::DynamicObjectRegistrationAction().
void MooseApp::dynamicAppRegistration | ( | const std::string & | app_name, |
std::string | library_path, | ||
const std::string & | library_name, | ||
bool | lib_load_deps | ||
) |
Definition at line 2020 of file MooseApp.C.
Referenced by MultiApp::createApps().
|
protected |
Helper method for dynamic loading of objects.
Definition at line 2106 of file MooseApp.C.
Referenced by dynamicAllRegistration(), and dynamicAppRegistration().
|
protected |
Runs post-initialization error checking that cannot be run correctly unless the simulation has been fully set up and initialized.
Definition at line 1171 of file MooseApp.C.
Referenced by executeExecutioner(), and run().
|
inlinevirtual |
Whether this application should by default error on Jacobian nonzero reallocations.
The application level setting can always be overridden by setting the error_on_jacobian_nonzero_reallocation
parameter in the Problem
block of the input file
Definition at line 1079 of file MooseApp.h.
|
inherited |
Definition at line 43 of file MooseBase.C.
Referenced by MooseBase::callMooseError(), MooseBaseErrorInterface::mooseDeprecated(), MooseBaseErrorInterface::mooseInfo(), MooseBaseErrorInterface::mooseWarning(), and MooseBaseParameterInterface::paramErrorMsg().
|
virtual |
Execute the Executioner that was built.
Definition at line 1207 of file MooseApp.C.
Referenced by run().
|
inline |
Get the shell exit code for the application.
Definition at line 136 of file MooseApp.h.
Referenced by copyInputs().
FEProblemBase & MooseApp::feProblem | ( | ) | const |
Definition at line 1396 of file MooseApp.C.
Referenced by attachRelationshipManagers(), MooseMesh::cacheFaceInfoVariableOwnership(), MooseMesh::cacheFVElementalDoFs(), errorCheck(), AutomaticMortarGeneration::initOutput(), removeRelationshipManager(), and setOutputFileBase().
std::unique_ptr< Backup > MooseApp::finalizeRestore | ( | ) |
Finalizes (closes) the restoration process done in restore().
This releases access to the stream in which the restore was loaded from and makes it no longer possible to restore additional data.
Definition at line 1352 of file MooseApp.C.
Referenced by FEProblemBase::initialSetup().
|
inline |
This info is stored here because we need a "globalish" place to put it in order to allow communication between a multiapp and solver-specific internals (i.e.
relating to fixed-point inner loops like picard, etc.) for handling subapp-specific modifications necessary for those solve processes.
Definition at line 409 of file MooseApp.h.
Referenced by FixedPointSolve::FixedPointSolve().
|
inline |
Retrieve a writable reference to the ActionFactory associated with this App.
Definition at line 429 of file MooseApp.h.
Referenced by Action::Action(), and DumpObjectsProblem::DumpObjectsProblem().
|
inline |
Gets the system that manages the ChainControls.
Definition at line 857 of file MooseApp.h.
Referenced by ChainControlSetupAction::act(), FEProblemBase::advanceState(), ChainControl::getChainControlDataSystem(), and ChainControlDataPostprocessor::initialSetup().
std::list< std::string > MooseApp::getCheckpointDirectories | ( | ) | const |
Get all checkpoint directories.
Definition at line 1796 of file MooseApp.C.
Referenced by getCheckpointFiles().
std::list< std::string > MooseApp::getCheckpointFiles | ( | ) | const |
Extract all possible checkpoint file names.
Definition at line 1828 of file MooseApp.C.
Referenced by setRestartRecoverFileBase().
|
inline |
Definition at line 1048 of file MooseApp.h.
Referenced by MooseServer::parseDocumentForDiagnostics().
const hit::Node * MooseApp::getCurrentActionHitNode | ( | ) | const |
Can be used to link objects that are created by an action to the action that created them in input
Definition at line 2501 of file MooseApp.C.
Referenced by ActionFactory::create(), and Factory::initialize().
|
inline |
Returns true if the user specified –distributed-mesh (or –parallel-mesh, for backwards compatibility) on the command line and false otherwise.
Definition at line 483 of file MooseApp.h.
Referenced by MooseMesh::determineUseDistributedMesh().
|
inline |
Return the app level ExecFlagEnum, this contains all the available flags for the app.
Definition at line 1030 of file MooseApp.h.
Referenced by FEProblemBase::initialSetup(), and EigenExecutionerBase::normalizeSolution().
Executioner * MooseApp::getExecutioner | ( | ) | const |
Retrieve the Executioner for this App.
Definition at line 1552 of file MooseApp.C.
Referenced by CheckIntegrityAction::act(), AddTimeStepperAction::act(), ComposeTimeStepperAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), LazyCoupleable::coupled(), EigenProblem::doFreeNonlinearPowerIterations(), EigenKernel::EigenKernel(), PseudoTimestep::execute(), IterationInfo::execute(), PIDTransientControl::execute(), Terminator::execute(), ChangeOverFixedPointPostprocessor::finalize(), FVAdvection::FVAdvection(), DefaultNonlinearConvergence::getSharedExecutionerParam(), NumFixedPointIterations::getValue(), FEProblemBase::init(), Console::initialSetup(), NumFailedTimeSteps::NumFailedTimeSteps(), ConsoleUtils::outputExecutionInformation(), MultiApp::preTransfer(), setOutputFileBase(), TimeIntervalTimes::TimeIntervalTimes(), and TimePeriod::TimePeriod().
|
inline |
Definition at line 347 of file MooseApp.h.
Referenced by CheckIntegrityAction::act(), ExecutorInterface::getExecutor(), FEProblemBase::getExecutor(), and ExecutorInterface::getExecutorByName().
Executor & MooseApp::getExecutor | ( | const std::string & | name, |
bool | fail_if_not_found = true |
||
) |
Get an Executor.
name | The name of the Executor |
fail_if_not_found | Whether or not to fail if the executor doesn't exist. If this is false then this function will return a NullExecutor |
Definition at line 1538 of file MooseApp.C.
|
inline |
Whether or not we need to use a separate Exodus reader to read the mesh BEFORE we create the mesh.
Definition at line 453 of file MooseApp.h.
Referenced by SetupMeshCompleteAction::act(), FileMesh::buildMesh(), FileMeshGenerator::generate(), and FEProblemBase::initialSetup().
|
inline |
Get the Exodus reader to restart variables from an Exodus mesh file.
Definition at line 466 of file MooseApp.h.
Referenced by FEProblemBase::checkICRestartError(), and FEProblemBase::initialSetup().
|
inline |
Retrieve a writable reference to the Factory associated with this App.
Definition at line 424 of file MooseApp.h.
Referenced by AB2PredictorCorrector::AB2PredictorCorrector(), BatchMeshGeneratorAction::addMeshGenerators(), MeshGenerator::addMeshSubgenerator(), FVFluxKernel::adjustRMGhostLayers(), AStableDirk4::AStableDirk4(), BatchMeshGeneratorAction::BatchMeshGeneratorAction(), SingleRankPartitioner::clone(), RandomPartitioner::clone(), BlockWeightedPartitioner::clone(), GhostEverything::clone(), GhostHigherDLowerDPointNeighbors::clone(), GhostLowerDElems::clone(), LibmeshPartitioner::clone(), PetscExternalPartitioner::clone(), HierarchicalGridPartitioner::clone(), GridPartitioner::clone(), ElementSideNeighborLayers::clone(), ElementPointNeighborLayers::clone(), GhostBoundary::clone(), RedistributeProperties::clone(), ProxyRelationshipManager::clone(), OversampleOutput::cloneMesh(), MeshGeneratorSystem::createMeshGenerator(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), MooseObject::MooseObject(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), OverlayMeshGenerator::OverlayMeshGenerator(), TiledMesh::safeClone(), FileMesh::safeClone(), ImageMesh::safeClone(), GeneratedMesh::safeClone(), RinglebMesh::safeClone(), SpiralAnnularMesh::safeClone(), ConcentricCircleMesh::safeClone(), AnnularMesh::safeClone(), MeshGeneratorMesh::safeClone(), StitchedMesh::safeClone(), PatternedMesh::safeClone(), TransientBase::setupTimeIntegrator(), and SideSetExtruderGenerator::SideSetExtruderGenerator().
std::string MooseApp::getFileName | ( | bool | stripLeadingPath = true | ) | const |
Return the primary (first) filename that was parsed Note: When stripLeadingPath is false, this function returns the same name as getInputFileName() method when the input file is not a link.
Definition at line 1842 of file MooseApp.C.
Referenced by ProgressOutput::output().
|
inline |
Returns whether FPE trapping is turned on (either because of debug or user requested)
Definition at line 945 of file MooseApp.h.
std::string MooseApp::getFrameworkVersion | ( | ) | const |
Returns the framework version.
Definition at line 718 of file MooseApp.C.
|
inline |
Each App has it's own local time.
The "global" time of the whole problem might be different. This offset is how far off the local App time is from the global time.
Definition at line 324 of file MooseApp.h.
Referenced by Tecplot::output(), Exodus::outputEmptyTimestep(), Exodus::outputNodalVariables(), and TransientMultiApp::solveStep().
const std::vector< std::string > & MooseApp::getInputFileNames | ( | ) | const |
Definition at line 1098 of file MooseApp.C.
Referenced by ConsoleUtils::outputFrameworkInformation(), Console::outputInput(), and setupOptions().
InputParameterWarehouse & MooseApp::getInputParameterWarehouse | ( | ) |
Get the InputParameterWarehouse for MooseObjects.
Definition at line 2306 of file MooseApp.C.
Referenced by FEProblemBase::addMaterialHelper(), MooseBaseParameterInterface::connectControllableParams(), ActionFactory::create(), Factory::initialize(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), ConsoleUtils::outputDataFileParams(), ActionWarehouse::printInputFile(), and Factory::releaseSharedObjects().
|
privatevirtual |
Method to retrieve the installable inputs from a given applications <app>Revision.h file.
Definition at line 1657 of file MooseApp.C.
Referenced by showInputs().
const std::vector< T * > & MooseApp::getInterfaceObjects | ( | ) | const |
Gets the registered interface objects for a given interface.
For this to work, the interface must register itself using registerInterfaceObject.
Definition at line 1584 of file MooseApp.h.
Referenced by DeclareLateReportersAction::act(), ResolveOptionalMaterialPropertiesAction::act(), Coupleable::checkWritableVar(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), and PetscOutput::solveSetup().
const std::string & MooseApp::getLastInputFileName | ( | ) | const |
Definition at line 1105 of file MooseApp.C.
Referenced by setupOptions().
std::set< std::string > MooseApp::getLibrarySearchPaths | ( | const std::string & | library_path_from_param | ) | const |
Return the paths searched by MOOSE when loading libraries.
Definition at line 2280 of file MooseApp.C.
Referenced by dynamicAppRegistration(), and dynamicRegistration().
|
inline |
Get the device torch is supposed to be running on.
Definition at line 90 of file MooseApp.h.
std::set< std::string > MooseApp::getLoadedLibraryPaths | ( | ) | const |
Return the paths of loaded libraries.
Definition at line 2269 of file MooseApp.C.
Referenced by Factory::reportUnregisteredError().
|
inline |
name
. Definition at line 886 of file MooseApp.h.
Referenced by MeshGenerator::generateInternal().
|
inline |
Definition at line 894 of file MooseApp.h.
|
inline |
See MeshGeneratorSystem::getMeshGeneratorNames()
Definition at line 904 of file MooseApp.h.
Referenced by SetupMeshAction::act().
|
inline |
Gets the system that manages the MeshGenerators.
Definition at line 852 of file MooseApp.h.
Referenced by ExecuteMeshGenerators::act(), SetupMeshAction::act(), CombineComponentsMeshes::act(), CreateAddedMeshGenerators::act(), CylinderComponent::addMeshGenerators(), BatchMeshGeneratorAction::addMeshGenerators(), MeshGenerator::checkGetMesh(), SideSetsFromNormalsGenerator::generate(), ExtraNodesetGenerator::generate(), MeshGenerator::getMeshByName(), MeshGenerator::MeshGenerator(), MeshGeneratorComponent::setupComponent(), and SetupDebugAction::SetupDebugAction().
|
inlineinherited |
Get the MooseApp this class is associated with.
Definition at line 45 of file MooseBase.h.
Referenced by AddDefaultConvergenceAction::act(), ChainControlSetupAction::act(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), MooseBaseParameterInterface::connectControllableParams(), Coupleable::Coupleable(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultNonlinearConvergence::getSharedExecutionerParam(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().
|
inline |
Definition at line 348 of file MooseApp.h.
Referenced by ExecutorInterface::getExecutor().
std::string MooseApp::getOutputFileBase | ( | bool | for_non_moose_build_output = false | ) | const |
Get the output file base name.
for_non_moose_build_output | True for getting the file base for outputs generated with Outputs/[outputname] input syntax. |
Definition at line 1112 of file MooseApp.C.
Referenced by getCheckpointDirectories(), OutputWarehouse::resetFileBase(), and MultiApp::setAppOutputFileBase().
|
inline |
Store a map of outputter names and file numbers The MultiApp system requires this to get the file numbering to propogate down through the multiapps.
Definition at line 563 of file MooseApp.h.
Referenced by TransientMultiApp::setupApp().
|
inline |
Get the output position.
Definition at line 294 of file MooseApp.h.
Referenced by MultiApp::createApp(), Exodus::output(), and MultiApp::parentOutputPositionChanged().
OutputWarehouse & MooseApp::getOutputWarehouse | ( | ) |
Get the OutputWarehouse objects.
Definition at line 1848 of file MooseApp.C.
Referenced by AutoCheckpointAction::act(), CommonOutputAction::act(), FEProblemBase::addOutput(), FEProblemBase::allowOutput(), MooseBase::callMooseError(), CheckOutputAction::checkConsoleOutput(), CheckOutputAction::checkMaterialOutput(), CheckOutputAction::checkPerfLogOutput(), CheckOutputAction::checkVariableOutput(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeLinearSystemTags(), FEProblemBase::computeResidualAndJacobian(), FEProblemBase::computeResidualTags(), MultiApp::createApp(), FEProblemBase::customSetup(), FEProblemBase::forceOutput(), TimePeriod::initialSetup(), FEProblemBase::initialSetup(), AutomaticMortarGeneration::initOutput(), AdvancedOutput::initOutputList(), EigenProblem::initPetscOutputAndSomeSolverSettings(), FEProblemBase::initPetscOutputAndSomeSolverSettings(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), ConsoleUtils::outputFrameworkInformation(), ConsoleUtils::outputOutputInformation(), FEProblemBase::outputStep(), FEProblemBase::subdomainSetup(), and FEProblemBase::timestepSetup().
const OutputWarehouse & MooseApp::getOutputWarehouse | ( | ) | const |
Definition at line 1854 of file MooseApp.C.
const T & MooseApp::getParam | ( | const std::string & | name | ) |
Retrieve a parameter for the object.
name | The name of the parameter |
Definition at line 1523 of file MooseApp.h.
Referenced by CommonOutputAction::act(), FEProblemBase::addOutput(), Console::Console(), MooseApp(), PerfGraphOutput::output(), Console::outputSystemInformation(), SetupMeshAction::setupMesh(), and Output::setWallTimeIntervalFromCommandLineParam().
const T & MooseApp::getParam | ( | const std::string & | name | ) | const |
Definition at line 1530 of file MooseApp.h.
|
inlinevirtual |
Get printable name of the application.
Definition at line 121 of file MooseApp.h.
Referenced by getPrintableVersion().
std::string MooseApp::getPrintableVersion | ( | ) | const |
Non-virtual method for printing out the version string in a consistent format.
Definition at line 730 of file MooseApp.C.
Referenced by setupOptions().
|
inline |
Return a reference to the recoverable data object.
Definition at line 738 of file MooseApp.h.
Referenced by restore().
|
inline |
Definition at line 518 of file MooseApp.h.
std::vector< std::pair< std::string, std::string > > MooseApp::getRelationshipManagerInfo | ( | ) | const |
Returns the Relationship managers info suitable for printing.
Definition at line 2755 of file MooseApp.C.
Referenced by ConsoleUtils::outputRelationshipManagerInformation().
const std::vector<std::shared_ptr<RelationshipManager> >& MooseApp::getReleationshipManagers | ( | ) |
Retrieve the relationship managers.
const T & MooseApp::getRenamedParam | ( | const std::string & | old_name, |
const std::string & | new_name | ||
) | const |
Retrieve a renamed parameter for the object.
This helper makes sure we check both names before erroring, and that only one parameter is passed to avoid silent errors
old_name | the old name for the parameter |
new_name | the new name for the parameter |
Definition at line 1537 of file MooseApp.h.
|
inline |
Return reference to the restartable data object.
Definition at line 704 of file MooseApp.h.
|
inline |
Definition at line 705 of file MooseApp.h.
RestartableDataMap & MooseApp::getRestartableDataMap | ( | const RestartableDataMapName & | name | ) |
Return a reference to restartable data for the specific type flag.
Definition at line 2863 of file MooseApp.C.
Referenced by getRestartableMetaData(), possiblyLoadRestartableMetaData(), and writeRestartableMetaData().
|
inline |
Iterator based access to the extra RestartableDataMap objects; see Checkpoint.C for use case.
These are MOOSE internal functions and should not be used otherwise.
Definition at line 1069 of file MooseApp.h.
Referenced by SetupDebugAction::act().
|
inline |
Definition at line 1071 of file MooseApp.h.
Referenced by SetupDebugAction::act().
const std::string & MooseApp::getRestartableDataMapName | ( | const RestartableDataMapName & | name | ) | const |
name
Definition at line 2890 of file MooseApp.C.
Referenced by possiblyLoadRestartableMetaData(), and writeRestartableMetaData().
RestartableDataValue & MooseApp::getRestartableMetaData | ( | const std::string & | name, |
const RestartableDataMapName & | metaname, | ||
THREAD_ID | tid | ||
) |
Definition at line 1950 of file MooseApp.C.
Referenced by MeshMetaDataInterface::getMeshPropertyInternal(), and MeshGenerator::setMeshPropertyHelper().
|
inline |
The file_base for the recovery file.
Definition at line 517 of file MooseApp.h.
Referenced by SetupRecoverFileBaseAction::act(), MooseMesh::init(), and FEProblemBase::initialSetup().
|
private |
Return the relationship manager clone originally created from the provided template relationship manager and mesh.
Definition at line 2517 of file MooseApp.C.
Referenced by removeRelationshipManager().
|
inline |
Definition at line 312 of file MooseApp.h.
Referenced by FEProblemBase::initialSetup(), and TransientBase::TransientBase().
|
inline |
Get SystemInfo object.
Definition at line 578 of file MooseApp.h.
Referenced by ConsoleUtils::outputFrameworkInformation(), ExodusFormatter::printInputFile(), and to_json().
|
virtual |
Returns the current version of the framework or application (default: framework version).
Definition at line 724 of file MooseApp.C.
Referenced by getPrintableVersion(), and ExodusFormatter::printInputFile().
|
inline |
See _initial_backup and restoreFromInitialBackup() for more info.
Definition at line 1037 of file MooseApp.h.
Referenced by FEProblemBase::initialSetup(), and restoreFromInitialBackup().
|
inline |
name
. Definition at line 878 of file MooseApp.h.
|
inline |
Whether or not an output position has been set.
Definition at line 288 of file MooseApp.h.
Referenced by Exodus::output().
bool MooseApp::hasRecoverFileBase | ( | ) | const |
Definition at line 1261 of file MooseApp.C.
bool MooseApp::hasRelationshipManager | ( | const std::string & | name | ) | const |
Returns a Boolean indicating whether a RelationshipManater exists with the same name.
Definition at line 2404 of file MooseApp.C.
bool MooseApp::hasRestartableDataMap | ( | const RestartableDataMapName & | name | ) | const |
Definition at line 2874 of file MooseApp.C.
bool MooseApp::hasRestartableMetaData | ( | const std::string & | name, |
const RestartableDataMapName & | metaname | ||
) | const |
Definition at line 1940 of file MooseApp.C.
Referenced by MeshMetaDataInterface::hasMeshProperty().
bool MooseApp::hasRestartRecoverFileBase | ( | ) | const |
Return true if the recovery file base is set.
Definition at line 1255 of file MooseApp.C.
|
private |
template_rm
but not for the provided mesh so we return false in that case as well Definition at line 2509 of file MooseApp.C.
Referenced by removeRelationshipManager().
|
inline |
Definition at line 307 of file MooseApp.h.
Referenced by FEProblemBase::initialSetup(), and TransientBase::TransientBase().
|
virtual |
Returns a string to be printed at the beginning of a simulation.
Definition at line 2312 of file MooseApp.C.
Referenced by restore(), and setupOptions().
|
inline |
Definition at line 193 of file MooseApp.h.
Referenced by copyInputs(), errorCheck(), getRenamedParam(), MooseApp(), runInputFile(), runInputs(), SetupMeshAction::setupMesh(), and setupOptions().
|
inline |
Definition at line 191 of file MooseApp.h.
Referenced by getRenamedParam(), MooseApp(), setupOptions(), and Output::setWallTimeIntervalFromCommandLineParam().
bool MooseApp::isRecovering | ( | ) | const |
Whether or not this is a "recover" calculation.
More specifically whether this simulation has been recovered with something like the –recover
command line argument. Note that this will never return true when isRestarting
is true
Definition at line 1237 of file MooseApp.C.
Referenced by ExecuteMeshGenerators::act(), SetupMeshCompleteAction::act(), SetupMeshAction::act(), SetupRecoverFileBaseAction::act(), OversampleOutput::cloneMesh(), MultiApp::createApp(), InversePowerMethod::execute(), NonlinearEigen::execute(), PIDTransientControl::execute(), SteadyBase::execute(), Eigenvalue::execute(), FullSolveMultiApp::FullSolveMultiApp(), NonlinearEigen::init(), InversePowerMethod::init(), TransientBase::init(), MooseMesh::init(), Console::initialSetup(), FEProblemBase::initialSetup(), OversampleOutput::outputStep(), Output::outputStep(), TransientBase::preExecute(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), TransientMultiApp::solveStep(), and TimeExtremeValue::TimeExtremeValue().
bool MooseApp::isRestarting | ( | ) | const |
Whether or not this is a "restart" calculation.
More specifically whether this has been restarted using the Problem/restart_file_base
parameter. Note that this will only return true when doing checkpoint restart. This will be false if doing exodus restart. Finally this will never return true when isRecovering
is true
Definition at line 1243 of file MooseApp.C.
Referenced by SetupMeshAction::act(), FEProblemBase::checkICRestartError(), MultiApp::createApp(), EigenProblem::execute(), FileOutput::FileOutput(), FullSolveMultiApp::FullSolveMultiApp(), Eigenvalue::init(), FEProblemBase::initialSetup(), TransientBase::preExecute(), TimeSequenceStepperBase::setupSequence(), and TransientMultiApp::solveStep().
bool MooseApp::isSplitMesh | ( | ) | const |
Whether or not this is a split mesh operation.
Definition at line 1249 of file MooseApp.C.
Referenced by MooseMesh::init().
|
inline |
Whether or not this app is the ultimate master app.
(ie level == 0)
Definition at line 837 of file MooseApp.h.
Referenced by AutoCheckpointAction::act(), ExecuteMeshGenerators::act(), SetupMeshCompleteAction::act(), SetupMeshAction::act(), SetupRecoverFileBaseAction::act(), MooseBase::callMooseError(), FEProblemBase::FEProblemBase(), FileOutput::FileOutput(), FixedPointSolve::FixedPointSolve(), MooseMesh::init(), FEProblemBase::initialSetup(), MooseApp(), Eigenvalue::prepareSolverOptions(), PerfGraphLivePrint::printStats(), setupOptions(), EigenProblem::solve(), FEProblemBase::solve(), FEProblemBase::solveLinearSystem(), and FEProblemBase::~FEProblemBase().
std::string MooseApp::libNameToAppName | ( | const std::string & | library_name | ) | const |
Converts a library name to an application name:
Definition at line 1876 of file MooseApp.C.
|
protected |
Recursively loads libraries and dependencies in the proper order to fully register a MOOSE application that may have several dependencies.
REQUIRES: dynamic linking loader support.
Definition at line 2119 of file MooseApp.C.
Referenced by dynamicRegistration().
void MooseApp::loadRestartableMetaData | ( | const std::filesystem::path & | folder_base | ) |
Loads all available restartable meta data if it is available with the folder base folder_base
.
Definition at line 1984 of file MooseApp.C.
Referenced by SetupRecoverFileBaseAction::act().
|
inline |
Returns a pointer to the master displaced mesh.
Definition at line 847 of file MooseApp.h.
Referenced by SetupMeshAction::act().
|
inline |
Returns a pointer to the master mesh.
Definition at line 842 of file MooseApp.h.
Referenced by ExecuteMeshGenerators::act(), SetupMeshCompleteAction::act(), and SetupMeshAction::act().
|
static |
The file suffix for meta data (header and data)
Definition at line 2485 of file MooseApp.C.
Referenced by possiblyLoadRestartableMetaData(), and writeRestartableMetaData().
|
inline |
The MultiApp Level.
Definition at line 826 of file MooseApp.h.
Referenced by DefaultNonlinearConvergence::checkConvergence(), MultiApp::createApp(), OutputWarehouse::mooseConsole(), ConsoleUtils::outputFrameworkInformation(), and Console::write().
|
inline |
The MultiApp number.
Definition at line 832 of file MooseApp.h.
Referenced by FileOutput::FileOutput(), and Console::outputSystemInformation().
|
inlinevirtualinherited |
Get the name of the class.
Reimplemented in MooseVariableBase.
Definition at line 57 of file MooseBase.h.
Referenced by AddElementalFieldAction::act(), CopyNodalVarsAction::act(), AdaptivityAction::act(), AddTimeStepperAction::act(), DeprecatedBlockAction::act(), SetupTimeIntegratorAction::act(), AddActionComponentAction::act(), AddVariableAction::act(), DisplayGhostingAction::act(), MaterialOutputAction::act(), AddPeriodicBCAction::act(), FEProblemBase::addAnyRedistributers(), Executioner::addAttributeReporter(), FEProblemBase::addAuxKernel(), FEProblemBase::addAuxScalarKernel(), DisplacedProblem::addAuxVariable(), FEProblemBase::addBoundaryCondition(), PhysicsComponentInterface::addComponent(), FEProblemBase::addConstraint(), FEProblemBase::addConvergence(), FEProblemBase::addDamper(), Registry::addDataFilePath(), FEProblemBase::addDGKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), addExecutor(), addExecutorParams(), FEProblemBase::addFunction(), SubProblem::addFunctor(), FEProblemBase::addFunctorMaterial(), FunctorMaterial::addFunctorProperty(), FunctorMaterial::addFunctorPropertyByBlocks(), FEProblemBase::addFVBC(), FEProblemBase::addFVInitialCondition(), FEProblemBase::addFVInterfaceKernel(), FEProblemBase::addFVKernel(), ADDGKernel::ADDGKernel(), FEProblemBase::addHDGIntegratedBC(), FEProblemBase::addHDGKernel(), FEProblemBase::addIndicator(), FEProblemBase::addInitialCondition(), FEProblemBase::addInterfaceKernel(), FEProblemBase::addInterfaceMaterial(), FEProblemBase::addKernel(), FEProblemBase::addLinearFVBC(), FEProblemBase::addLinearFVKernel(), FEProblemBase::addMarker(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), ComponentMaterialPropertyInterface::addMaterials(), FEProblemBase::addMeshDivision(), addMeshGenerator(), CylinderComponent::addMeshGenerators(), MeshGenerator::addMeshSubgenerator(), FEProblemBase::addMultiApp(), FEProblemBase::addNodalKernel(), FEProblemBase::addObject(), ComponentPhysicsInterface::addPhysics(), SubProblem::addPiecewiseByBlockLambdaFunctor(), FEProblemBase::addPostprocessor(), InitialConditionBase::addPostprocessorDependencyHelper(), UserObject::addPostprocessorDependencyHelper(), FEProblemBase::addPredictor(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), FEProblemBase::addReporter(), FEProblemBase::addSampler(), FEProblemBase::addScalarKernel(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), InitialConditionBase::addUserObjectDependencyHelper(), UserObject::addUserObjectDependencyHelper(), AuxKernelTempl< Real >::addUserObjectDependencyHelper(), DisplacedProblem::addVariable(), FEProblemBase::addVectorPostprocessor(), UserObject::addVectorPostprocessorDependencyHelper(), FVFluxKernel::adjustRMGhostLayers(), Output::advancedExecuteOn(), AdvancedExtruderGenerator::AdvancedExtruderGenerator(), appBinaryName(), appendMeshGenerator(), Registry::appNameFromAppPath(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), ArrayDGKernel::ArrayDGKernel(), ArrayParsedAux::ArrayParsedAux(), PhysicsBase::assignBlocks(), AStableDirk4::AStableDirk4(), AuxKernelTempl< Real >::AuxKernelTempl(), Function::average(), MultiApp::backup(), CoarsenedPiecewiseLinear::buildCoarsenedGrid(), PiecewiseTabularBase::buildFromFile(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), MooseBase::callMooseError(), ChangeOverFixedPointPostprocessor::ChangeOverFixedPointPostprocessor(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), PhysicsBase::checkBlockRestrictionIdentical(), PhysicsBase::checkComponentType(), ParsedConvergence::checkConvergence(), DefaultNonlinearConvergence::checkConvergence(), FEProblemBase::checkDependMaterialsHelper(), ReporterTransferInterface::checkHasReporterValue(), FEProblemBase::checkICRestartError(), Material::checkMaterialProperty(), checkMetaDataIntegrity(), Damper::checkMinDamping(), Checkpoint::checkpointInfo(), Coupleable::checkWritableVar(), CompositeFunction::CompositeFunction(), MaterialBase::computeProperties(), FEProblemBase::computeUserObjectByName(), VectorPostprocessorVisualizationAux::computeValue(), MooseBaseParameterInterface::connectControllableParams(), ConstantPostprocessor::ConstantPostprocessor(), MultiApp::createApp(), createExecutors(), AddVariableAction::createInitialConditionAction(), MeshGeneratorSystem::createMeshGeneratorOrder(), createRecoverablePerfGraph(), CutMeshByLevelSetGenerator::CutMeshByLevelSetGenerator(), CutMeshByPlaneGenerator::CutMeshByPlaneGenerator(), MaterialBase::declareADProperty(), MeshGenerator::declareMeshesForSubByName(), MeshGenerator::declareNullMeshName(), MaterialBase::declareProperty(), DOFMapOutput::demangle(), DerivativeSumMaterialTempl< is_ad >::DerivativeSumMaterialTempl(), Registry::determineDataFilePath(), DGKernel::DGKernel(), DGKernelBase::DGKernelBase(), DomainUserObject::DomainUserObject(), DumpObjectsProblem::dumpObjectHelper(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), ElementMaterialSampler::ElementMaterialSampler(), ElementValueSampler::ElementValueSampler(), EigenKernel::enabled(), MooseMesh::errorIfDistributedMesh(), MooseBase::errorPrefix(), SolutionUserObjectBase::evalMeshFunction(), SolutionUserObjectBase::evalMeshFunctionGradient(), SolutionUserObjectBase::evalMultiValuedMeshFunction(), SolutionUserObjectBase::evalMultiValuedMeshFunctionGradient(), RestartableDataReporter::execute(), PointValue::execute(), MultiAppNearestNodeTransfer::execute(), WebServerControl::execute(), MultiAppGeneralFieldTransfer::execute(), ActionWarehouse::executeActionsWithAction(), Exodus::Exodus(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), FEProblemBase::FEProblemBase(), MultiApp::fillPositions(), PointSamplerBase::finalize(), ChainControl::fullControlDataName(), FunctionDT::FunctionDT(), FunctionIC::functionName(), FVFunctionIC::functionName(), FunctorPositions::FunctorPositions(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), FVOneVarDiffusionInterface::FVOneVarDiffusionInterface(), MooseServer::gatherDocumentSymbols(), BoundaryDeletionGenerator::generate(), RenameBlockGenerator::generate(), RenameBoundaryGenerator::generate(), BreakMeshByBlockGenerator::generate(), GeneratedMeshGenerator::generate(), ParsedSubdomainMeshGenerator::generate(), ParsedExtraElementIDGenerator::generate(), StitchedMeshGenerator::generate(), XYDelaunayGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), MeshGenerator::generateInternal(), InterfaceMaterial::getADMaterialProperty(), Material::getADMaterialProperty(), MultiAppTransfer::getAppInfo(), MultiApp::getBoundingBox(), getCheckpointDirectories(), Control::getControllableParameterByName(), Control::getControllableValue(), Control::getControllableValueByName(), FEProblemBase::getConvergence(), Registry::getDataFilePath(), UserObject::getDependObjects(), DistributionInterface::getDistribution(), FEProblemBase::getDistribution(), DistributionInterface::getDistributionByName(), ElementUOProvider::getElementalValueLong(), ElementUOProvider::getElementalValueReal(), MultiApp::getExecutioner(), getExecutor(), FEProblemBase::getExecutor(), OutputWarehouse::getFileNumbers(), FEProblemBase::getFunction(), SubProblem::getFunctor(), NodalPatchRecovery::getGenericMaterialProperty(), InterfaceMaterial::getGenericMaterialProperty(), Material::getGenericMaterialProperty(), AuxKernelTempl< Real >::getGenericMaterialProperty(), InterfaceMaterial::getGenericNeighborMaterialProperty(), InterfaceMaterial::getGenericNeighborMaterialPropertyByName(), Material::getGenericOptionalMaterialProperty(), MaterialBase::getGenericZeroMaterialProperty(), SolutionUserObjectBase::getLocalVarIndex(), Marker::getMarkerValue(), Material::getMaterial(), FEProblemBase::getMaterial(), Material::getMaterialByName(), NodalPatchRecovery::getMaterialProperty(), InterfaceMaterial::getMaterialProperty(), Material::getMaterialProperty(), AuxKernelTempl< Real >::getMaterialProperty(), SubProblem::getMaterialPropertyBlockNames(), SubProblem::getMaterialPropertyBoundaryNames(), NodalPatchRecovery::getMaterialPropertyOld(), InterfaceMaterial::getMaterialPropertyOld(), Material::getMaterialPropertyOld(), AuxKernelTempl< Real >::getMaterialPropertyOld(), NodalPatchRecovery::getMaterialPropertyOlder(), InterfaceMaterial::getMaterialPropertyOlder(), Material::getMaterialPropertyOlder(), AuxKernelTempl< Real >::getMaterialPropertyOlder(), MeshGenerator::getMesh(), FEProblemBase::getMeshDivision(), MeshGenerator::getMeshesByName(), getMeshGenerator(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), ActionWarehouse::getMooseAppName(), MultiAppTransfer::getMultiApp(), InterfaceMaterial::getNeighborADMaterialProperty(), InterfaceMaterial::getNeighborMaterialProperty(), InterfaceMaterial::getNeighborMaterialPropertyOld(), InterfaceMaterial::getNeighborMaterialPropertyOlder(), MooseServer::getObjectParameters(), Material::getOptionalADMaterialProperty(), Material::getOptionalMaterialProperty(), Material::getOptionalMaterialPropertyOld(), Material::getOptionalMaterialPropertyOlder(), OutputWarehouse::getOutput(), getParam(), FEProblemBase::getPositionsObject(), FEProblemBase::getPostprocessorValueByName(), ComponentMaterialPropertyInterface::getPropertyValue(), ReporterData::getReporterInfo(), getRestartableDataMap(), getRestartableDataMapName(), getRestartableMetaData(), FEProblemBase::getSampler(), TransientBase::getTimeStepperName(), ProjectedStatefulMaterialStorageAction::getTypeEnum(), FEProblemBase::getUserObject(), FEProblemBase::getUserObjectBase(), Terminator::handleMessage(), Control::hasControllableParameterByName(), FEProblemBase::hasConvergence(), FEProblemBase::hasFunction(), SubProblem::hasFunctor(), SubProblem::hasFunctorWithType(), hasMeshGenerator(), AdvancedOutput::hasOutputHelper(), FEProblemBase::hasPostprocessor(), FEProblemBase::hasPostprocessorValueByName(), hasRelationshipManager(), hasRestartableDataMap(), hasRestartableMetaData(), FEProblemBase::hasUserObject(), IterationAdaptiveDT::init(), AddVariableAction::init(), AdvancedOutput::init(), AdvancedOutput::initExecutionTypes(), AttribName::initFrom(), NestedDivision::initialize(), TransformedPositions::initialize(), SideFVFluxBCIntegral::initialSetup(), SolutionScalarAux::initialSetup(), MultiAppProjectionTransfer::initialSetup(), NodalVariableValue::initialSetup(), Console::initialSetup(), SolutionUserObjectBase::initialSetup(), AdvancedOutput::initOutputList(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), Function::integral(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), MeshGenerator::isChildMeshGenerator(), MeshGenerator::isNullMeshName(), isParamValid(), MeshGenerator::isParentMeshGenerator(), LinearCombinationFunction::LinearCombinationFunction(), FEProblemBase::logAdd(), Marker::Marker(), MaterialBase::markMatPropRequested(), MatDiffusionBase< Real >::MatDiffusionBase(), Material::Material(), MaterialDerivativeTestKernelBase< Real >::MaterialDerivativeTestKernelBase(), Distribution::median(), MemoryUsageReporter::MemoryUsageReporter(), MeshGenerator::meshPropertyPrefix(), MooseApp(), OutputWarehouse::mooseConsole(), MooseVariableInterface< Real >::MooseVariableInterface(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalPatchRecoveryAuxBase::NodalPatchRecoveryAuxBase(), NodalValueSampler::NodalValueSampler(), Registry::objData(), MeshGenerator::Comparator::operator()(), ProgressOutput::output(), DOFMapOutput::output(), Output::Output(), AdvancedOutput::outputElementalVariables(), ConsoleUtils::outputExecutionInformation(), MaterialOutputAction::outputHelper(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), Exodus::outputPostprocessors(), AdvancedOutput::outputPostprocessors(), TableOutput::outputReporter(), AdvancedOutput::outputReporters(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), AdvancedOutput::outputVectorPostprocessors(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedExtraElementIDGenerator::ParsedExtraElementIDGenerator(), MooseServer::parseDocumentForDiagnostics(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ComponentPhysicsInterface::physicsExists(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseByBlockFunctorMaterialTempl< T >::PiecewiseByBlockFunctorMaterialTempl(), possiblyLoadRestartableMetaData(), PhysicsBase::prefix(), BlockRestrictionDebugOutput::printBlockRestrictionMap(), PerfGraphLivePrint::printStats(), MultiApp::readCommandLineArguments(), Receiver::Receiver(), Executor::Result::record(), Registry::registerObjectsTo(), FEProblemBase::registerRandomInterface(), registerRestartableDataMapName(), registerRestartableNameWithFilter(), GlobalParamsAction::remove(), MaterialBase::resetQpProperties(), MultiApp::restore(), runInputFile(), ScalarComponentIC::ScalarComponentIC(), MultiApp::setAppOutputFileBase(), MooseMesh::setBoundaryName(), Control::setControllableValue(), Control::setControllableValueByName(), GlobalParamsAction::setDoubleIndexParam(), OutputWarehouse::setFileNumbers(), GlobalParamsAction::setParam(), FEProblemBase::setPostprocessorValueByName(), FEProblemBase::setResidualObjectParamsAndLog(), GlobalParamsAction::setScalarParam(), MooseMesh::setSubdomainName(), GlobalParamsAction::setTripleIndexParam(), NodeSetsGeneratorBase::setup(), Split::setup(), SideSetsGeneratorBase::setup(), TransientMultiApp::setupApp(), GlobalParamsAction::setVectorParam(), FullSolveMultiApp::showStatusMessage(), SideSetExtruderGenerator::SideSetExtruderGenerator(), TransientMultiApp::solveStep(), UserObject::spatialValue(), WebServerControl::startServer(), StitchedMesh::StitchedMesh(), SubProblem::storeBoundaryDelayedCheckMatProp(), SubProblem::storeBoundaryMatPropName(), MaterialBase::storeBoundaryZeroMatProp(), SubProblem::storeBoundaryZeroMatProp(), SubProblem::storeSubdomainDelayedCheckMatProp(), SubProblem::storeSubdomainMatPropName(), MaterialBase::storeSubdomainZeroMatProp(), SubProblem::storeSubdomainZeroMatProp(), MaterialBase::subdomainSetup(), TaggingInterface::TaggingInterface(), VectorPostprocessorVisualizationAux::timestepSetup(), to_json(), MultiAppDofCopyTransfer::transfer(), TransientMultiApp::TransientMultiApp(), MooseServer::traverseParseTreeAndFillSymbols(), MooseBase::typeAndName(), MooseBaseParameterInterface::uniqueParameterName(), FVFluxBC::uOnGhost(), FVFluxBC::uOnUSub(), UserObject::UserObject(), UserObjectInterface::userObjectName(), ParsedAux::validateGenericVectorNames(), PhysicsBase::variableExists(), MultiAppTransfer::variableIntegrityCheck(), VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl(), Convergence::verboseOutput(), AdvancedOutput::wantOutput(), Coupleable::writableCoupledValue(), Coupleable::writableVariable(), Console::write(), and writeRestartableMetaData().
|
inline |
Get the parameters of the object.
Definition at line 147 of file MooseApp.h.
Referenced by MeshOnlyAction::act(), SplitMeshAction::act(), CommonOutputAction::act(), MeshGeneratorSystem::hasDataDrivenAllowed(), MooseApp(), ConsoleUtils::outputLegacyInformation(), MooseServer::parseDocumentForDiagnostics(), and NonlinearSystemBase::shouldEvaluatePreSMOResidual().
Parser & MooseApp::parser | ( | ) |
Definition at line 1422 of file MooseApp.C.
Referenced by ActionFactory::create().
|
inline |
Get the PerfGraph for this app.
Definition at line 158 of file MooseApp.h.
Referenced by PerfGraphInterface::perfGraph().
void MooseApp::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
.
Definition at line 1969 of file MooseApp.C.
Referenced by FileMesh::buildMesh(), FileMeshGenerator::generate(), and loadRestartableMetaData().
|
inlinevirtual |
Insertion point for other apps that is called after restore()
for_restart | Whether this restoration is explicitly for the first restoration of restart data |
Definition at line 790 of file MooseApp.h.
Referenced by restore().
|
inlinevirtual |
Insertion point for other apps that is called before backup()
Definition at line 756 of file MooseApp.h.
Referenced by backup().
|
inline |
Returns the MPI processor ID of the current processor.
Definition at line 434 of file MooseApp.h.
Referenced by MooseApp(), restartFolderBase(), FileOutput::setFileBaseInternal(), and writeRestartableMetaData().
|
inline |
The RankMap is a useful object for determining how the processes are laid out on the physical nodes of the cluster.
Definition at line 153 of file MooseApp.h.
|
private |
Internal function used to recursively create the executor objects.
Called by createExecutors
current_executor_name | The name of the executor currently needing to be built |
possible_roots | The names of executors that are currently candidates for being the root |
Definition at line 1429 of file MooseApp.C.
Referenced by createExecutors().
void MooseApp::registerInterfaceObject | ( | T & | interface | ) |
Registers an interface object for accessing with getInterfaceObjects.
This should be called within the constructor of the interface in interest.
Definition at line 1562 of file MooseApp.h.
Referenced by Coupleable::Coupleable(), MaterialPropertyInterface::MaterialPropertyInterface(), PetscOutputInterface::PetscOutputInterface(), and Reporter::Reporter().
RestartableDataValue & MooseApp::registerRestartableData | ( | std::unique_ptr< RestartableDataValue > | data, |
THREAD_ID | tid, | ||
bool | read_only, | ||
const RestartableDataMapName & | metaname = "" |
||
) |
Definition at line 1888 of file MooseApp.C.
Referenced by createRecoverablePerfGraph(), createRecoverableSolutionInvalidity(), MeshGenerator::declareMeshProperty(), ReporterData::getRestartableDataHelper(), and Restartable::registerRestartableDataOnApp().
RestartableDataValue& MooseApp::registerRestartableData | ( | const std::string & | name, |
std::unique_ptr< RestartableDataValue > | data, | ||
THREAD_ID | tid, | ||
bool | read_only, | ||
const RestartableDataMapName & | metaname = "" |
||
) |
void MooseApp::registerRestartableDataMapName | ( | const RestartableDataMapName & | name, |
std::string | suffix = "" |
||
) |
Reserve a location for storing custom RestartableDataMap objects.
This should be called in the constructor of an application.
name | A key to use for accessing the data object |
suffix | The suffix to use when appending to checkpoint output, if not supplied the given name is used to generate the suffix (MyMetaData -> _mymetadata) |
Definition at line 2880 of file MooseApp.C.
Referenced by MooseApp().
|
protected |
NOTE: This is an internal function meant for MOOSE use only!
Register a piece of restartable data that will be used in a filter in/out during deserialization. Note however that this data will always be written to the restart file.
name | The full (unique) name. |
filter | The filter name where to direct the name |
Definition at line 1269 of file MooseApp.C.
Referenced by createRecoverablePerfGraph(), createRecoverableSolutionInvalidity(), and Restartable::registerRestartableNameWithFilterOnApp().
|
protectedinherited |
Call to register a named section for timing.
section_name | The name of the code section to be timed |
level | The importance of the timer - lower is more important (0 will always come out) |
Definition at line 53 of file PerfGraphInterface.C.
|
protectedinherited |
Call to register a named section for timing.
section_name | The name of the code section to be timed |
level | The importance of the timer - lower is more important (0 will always come out) |
live_message | The message to be printed to the screen during execution |
print_dots | Whether or not progress dots should be printed for this section |
Definition at line 64 of file PerfGraphInterface.C.
|
inline |
Return the container of relationship managers.
Definition at line 1053 of file MooseApp.h.
Referenced by NumRelationshipManagers::getValue().
|
private |
Purge this relationship manager from meshes and DofMaps and finally from us.
This method is private because only this object knows when we should remove relationship managers: when we are adding relationship managers to this object's storage, we perform an operator>= comparison between our existing RMs and the RM we are trying to add. If any comparison returns true, we do not add the new RM because the comparison indicates that we would gain no new coverage. However, if no comparison return true, then we add the new RM and we turn the comparison around! Consequently if our new RM is >= than any of our preexisting RMs, we remove those preexisting RMs using this method
Definition at line 2532 of file MooseApp.C.
Referenced by addRelationshipManager().
std::filesystem::path MooseApp::restartFolderBase | ( | const std::filesystem::path & | folder_base | ) | const |
The file suffix for restartable data.
Definition at line 2493 of file MooseApp.C.
Referenced by FEProblemBase::initialSetup(), and Checkpoint::output().
void MooseApp::restore | ( | const std::filesystem::path & | folder_base, |
const bool | for_restart | ||
) |
Restore an application from file.
folder_base | The backup folder base |
for_restart | Whether this restoration is explicitly for the first restoration of restart data |
You must call finalizeRestore() after this in order to finalize the restoration. The restore process is kept open in order to restore additional data after the initial restore (that is, the restoration of data that has already been declared).
Definition at line 1310 of file MooseApp.C.
Referenced by FEProblemBase::initialSetup(), and restoreFromInitialBackup().
Restore an application from the backup backup
.
backup | The backup |
for_restart | Whether this restoration is explicitly for the first restoration of restart data |
You must call finalizeRestore() after this in order to finalize the restoration. The restore process is kept open in order to restore additional data after the initial restore (that is, the restoration of data that has already been declared).
Definition at line 1323 of file MooseApp.C.
void MooseApp::restoreFromInitialBackup | ( | const bool | for_restart | ) |
Restores from a "initial" backup, that is, one set in _initial_backup.
for_restart | Whether this restoration is explicitly for the first restoration of restart data |
This is only used for restoration of multiapp subapps, which have been given a Backup from their parent on initialization. Said Backup is passed to this app via the "_initial_backup" private input parameter.
See restore() for more information
Definition at line 1345 of file MooseApp.C.
Referenced by FEProblemBase::initialSetup().
|
virtual |
Run the application.
Definition at line 1564 of file MooseApp.C.
|
virtual |
Actually build everything in the input file.
Definition at line 1137 of file MooseApp.C.
Referenced by run().
|
private |
Handles the run input parameter logic: Checks to see whether a directory exists in user space and launches the TestHarness to process the given directory.
Definition at line 1728 of file MooseApp.C.
Referenced by run().
|
private |
Set a flag so that the parser will either warn or error when unused variables are seen after parsing is complete.
Definition at line 1384 of file MooseApp.C.
Referenced by setupOptions().
void MooseApp::setErrorOverridden | ( | ) |
Set a flag so that the parser will throw an error if overridden parameters are detected.
Definition at line 1558 of file MooseApp.C.
Referenced by setupOptions().
|
inline |
Set the Executioner for this App.
Definition at line 355 of file MooseApp.h.
Referenced by CreateExecutionerAction::act().
Definition at line 356 of file MooseApp.h.
Sets the exit code that the application will exit with.
Definition at line 141 of file MooseApp.h.
Referenced by copyInputs(), and runInputs().
|
inline |
Set the flag to indicate whether or not we need to use a separate Exodus reader to read the mesh BEFORE we create the mesh.
Definition at line 447 of file MooseApp.h.
Referenced by CopyNodalVarsAction::act(), and PhysicsBase::prepareCopyVariablesFromMesh().
|
inline |
Set the Exodus reader to restart variables from an Exodus mesh file.
Definition at line 458 of file MooseApp.h.
Referenced by FileMesh::buildMesh(), and FileMeshGenerator::generate().
Each App has it's own local time.
The "global" time of the whole problem might be different. This offset is how far off the local App time is from the global time.
Definition at line 318 of file MooseApp.h.
void MooseApp::setOutputFileBase | ( | const std::string & | output_file_base | ) |
Override the selection of the output file base name.
Note: This method is supposed to be called by MultiApp only.
Definition at line 1121 of file MooseApp.C.
Store a map of outputter names and file numbers The MultiApp system requires this to get the file numbering to propagate down through the Multiapps.
numbers | Map of outputter names and file numbers |
Definition at line 551 of file MooseApp.h.
Tell the app to output in a specific position.
Definition at line 1785 of file MooseApp.C.
void MooseApp::setRecover | ( | bool | value | ) |
Definition at line 2324 of file MooseApp.C.
void MooseApp::setRestart | ( | bool | value | ) |
Sets the restart/recover flags.
state | The state to set the flag to |
Definition at line 2318 of file MooseApp.C.
Referenced by FEProblemBase::setRestartFile().
|
inline |
mutator for recover_base (set by RecoverBaseAction)
Definition at line 529 of file MooseApp.h.
Referenced by SetupRecoverFileBaseAction::act(), and FEProblemBase::setRestartFile().
Set the starting time for the simulation.
This will override any choice made in the input file.
time | The start time for the simulation. |
Definition at line 1835 of file MooseApp.C.
Referenced by EigenExecutionerBase::EigenExecutionerBase(), and TransientBase::TransientBase().
|
virtual |
Setup options based on InputParameters.
Definition at line 736 of file MooseApp.C.
Referenced by run().
|
private |
Prints a message showing the installable inputs for a given application (if getInstallableInputs has been overridden for an application).
Definition at line 1625 of file MooseApp.C.
Referenced by run().
|
inline |
Get the SolutionInvalidity for this app.
Definition at line 164 of file MooseApp.h.
Referenced by FEProblemBase::acceptInvalidSolution(), SolverSystem::checkInvalidSolution(), NonlinearSystemBase::computeJacobianInternal(), LinearSystem::computeLinearSystemInternal(), NonlinearSystemBase::computeResidualInternal(), SolutionInvalidInterface::flagInvalidSolutionInternal(), NonlinearSystemBase::jacobianSetup(), NonlinearSystemBase::residualSetup(), SolutionInvalidityReporter::SolutionInvalidityReporter(), and NonlinearSystem::solve().
|
inline |
Definition at line 165 of file MooseApp.h.
|
inline |
Returns a writable reference to the syntax object.
Definition at line 237 of file MooseApp.h.
Referenced by dynamicAllRegistration(), and setupOptions().
|
inline |
Whether or not this simulation should only run half its transient (useful for testing recovery)
Definition at line 541 of file MooseApp.h.
Referenced by AutoCheckpointAction::act(), TimeStepper::constrainStep(), TransientBase::execute(), TimeSequenceStepperBase::setupSequence(), and TransientBase::TransientBase().
|
inline |
Definition at line 116 of file MooseApp.h.
Referenced by MooseVariableDataFV< OutputType >::MooseVariableDataFV(), and FEProblemBase::theWarehouse().
|
protectedinherited |
section_name
.Optionally adds a prefix if one is defined.
Definition at line 47 of file PerfGraphInterface.C.
Referenced by PerfGraphInterface::registerTimedSection().
|
inlineinherited |
Get the type of this class.
Definition at line 51 of file MooseBase.h.
Referenced by CreateProblemDefaultAction::act(), SetupDebugAction::act(), MaterialDerivativeTestAction::act(), MaterialOutputAction::act(), FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::addConvergence(), FEProblemBase::addDistribution(), addExecutor(), addExecutorParams(), FEProblemBase::addFunction(), FEProblemBase::addMeshDivision(), addMeshGenerator(), MeshGenerator::addMeshSubgenerator(), FEProblemBase::addObject(), FEProblemBase::addPredictor(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), FEProblemBase::addReporter(), FEProblemBase::addSampler(), FEProblemBase::addTimeIntegrator(), MooseServer::addValuesToList(), DisplacedProblem::addVectorTag(), SubProblem::addVectorTag(), FEProblemBase::advanceMultiApps(), appendMeshGenerator(), AuxKernelTempl< Real >::AuxKernelTempl(), FEProblemBase::backupMultiApps(), BoundaryPreservedMarker::BoundaryPreservedMarker(), DistributedRectilinearMeshGenerator::buildCube(), MooseMesh::buildHRefinementAndCoarseningMaps(), MooseMesh::buildLowerDMesh(), MooseMesh::buildPRefinementAndCoarseningMaps(), PhysicsBase::checkComponentType(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), ADDGKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighJacobian(), ElemElemConstraint::computeElemNeighJacobian(), ArrayDGKernel::computeElemNeighJacobian(), ADDGKernel::computeElemNeighResidual(), DGKernel::computeElemNeighResidual(), ElemElemConstraint::computeElemNeighResidual(), ArrayDGKernel::computeElemNeighResidual(), LowerDIntegratedBC::computeLowerDJacobian(), ArrayLowerDIntegratedBC::computeLowerDJacobian(), DGLowerDKernel::computeLowerDJacobian(), ArrayDGLowerDKernel::computeLowerDJacobian(), LowerDIntegratedBC::computeLowerDOffDiagJacobian(), ArrayLowerDIntegratedBC::computeLowerDOffDiagJacobian(), ArrayHFEMDirichletBC::computeLowerDQpJacobian(), ArrayHFEMDiffusion::computeLowerDQpJacobian(), HFEMDirichletBC::computeLowerDQpJacobian(), HFEMDiffusion::computeLowerDQpJacobian(), ArrayHFEMDirichletBC::computeLowerDQpOffDiagJacobian(), HFEMDirichletBC::computeLowerDQpOffDiagJacobian(), ArrayLowerDIntegratedBC::computeLowerDQpOffDiagJacobian(), ArrayDGLowerDKernel::computeLowerDQpOffDiagJacobian(), FEProblemBase::computeMultiAppsDT(), ADDGKernel::computeOffDiagElemNeighJacobian(), DGKernel::computeOffDiagElemNeighJacobian(), ArrayDGKernel::computeOffDiagElemNeighJacobian(), DGLowerDKernel::computeOffDiagLowerDJacobian(), ArrayDGLowerDKernel::computeOffDiagLowerDJacobian(), DGConvection::computeQpJacobian(), ScalarKernel::computeQpJacobian(), InterfaceDiffusion::computeQpJacobian(), ArrayDGDiffusion::computeQpJacobian(), InterfaceReaction::computeQpJacobian(), CoupledTiedValueConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), DGDiffusion::computeQpJacobian(), LinearNodalConstraint::computeQpJacobian(), EqualValueBoundaryConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpOffDiagJacobian(), HFEMTestJump::computeQpOffDiagJacobian(), HFEMTrialJump::computeQpOffDiagJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), ArrayDGKernel::computeQpOffDiagJacobian(), ArrayHFEMDiffusion::computeQpResidual(), DGConvection::computeQpResidual(), HFEMDiffusion::computeQpResidual(), ScalarKernel::computeQpResidual(), InterfaceDiffusion::computeQpResidual(), ArrayDGDiffusion::computeQpResidual(), ADMatInterfaceReaction::computeQpResidual(), InterfaceReaction::computeQpResidual(), ADDGAdvection::computeQpResidual(), CoupledTiedValueConstraint::computeQpResidual(), TiedValueConstraint::computeQpResidual(), ADDGDiffusion::computeQpResidual(), DGDiffusion::computeQpResidual(), LinearNodalConstraint::computeQpResidual(), HFEMTestJump::computeQpResidual(), HFEMTrialJump::computeQpResidual(), EqualValueBoundaryConstraint::computeQpResidual(), EqualValueEmbeddedConstraint::computeQpResidual(), FEProblemBase::computeSystems(), FEProblemBase::computeUserObjectByName(), FEProblemBase::computeUserObjects(), FEProblemBase::computeUserObjectsInternal(), DisplacedProblem::createQRules(), FEProblemBase::createQRules(), createRecoverablePerfGraph(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), FEProblemBase::duplicateVariableCheck(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), MooseBase::errorPrefix(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), FEProblemBase::execTransfers(), WebServerControl::execute(), SteadyBase::execute(), ActionWarehouse::executeActionsWithAction(), FEProblemBase::finishMultiAppStep(), FVScalarLagrangeMultiplierInterface::FVScalarLagrangeMultiplierInterface(), MooseServer::gatherDocumentReferencesLocations(), LowerDBlockFromSidesetGenerator::generate(), SubdomainPerElementGenerator::generate(), PatternedMeshGenerator::generate(), MeshGenerator::generateInternal(), MultiAppTransfer::getAppInfo(), TransfiniteMeshGenerator::getEdge(), ElementGenerator::getElemType(), MooseServer::getInputLookupDefinitionNodes(), FEProblemBase::getMaterial(), FEProblemBase::getMaterialData(), MaterialOutputAction::getParams(), ReporterData::getReporterInfo(), FEProblemBase::getTransfers(), DisplacedProblem::getVectorTags(), SubProblem::getVectorTags(), CommonOutputAction::hasConsole(), FEProblemBase::hasMultiApps(), AdvancedOutput::hasOutput(), FEProblemBase::incrementMultiAppTStep(), AdvancedOutput::initAvailableLists(), FunctorPositions::initialize(), FunctorTimes::initialize(), MultiAppConservativeTransfer::initialSetup(), LinearFVDiffusion::initialSetup(), LinearFVAnisotropicDiffusion::initialSetup(), LinearFVAdvection::initialSetup(), ArrayDGDiffusion::initQpResidual(), AdvancedOutput::initShowHideLists(), RelationshipManager::isType(), FEProblemBase::logAdd(), MaterialFunctorConverterTempl< T >::MaterialFunctorConverterTempl(), MooseObject::MooseObject(), DisplacedProblem::numVectorTags(), SubProblem::numVectorTags(), Console::output(), AdvancedOutput::output(), ConsoleUtils::outputExecutionInformation(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), MooseServer::parseDocumentForDiagnostics(), ProjectedStatefulMaterialStorageAction::processProperty(), recursivelyCreateExecutors(), SolutionInvalidInterface::registerInvalidSolutionInternal(), FEProblemBase::restoreMultiApps(), MeshRepairGenerator::separateSubdomainsByElementType(), FEProblemBase::setCoupling(), setupOptions(), WebServerControl::startServer(), MooseBase::typeAndName(), ScalarKernelBase::uOld(), AuxScalarKernel::uOld(), DisplacedProblem::updateGeomSearch(), FEProblemBase::updateGeomSearch(), UserObjectInterface::userObjectType(), and AdvancedOutput::wantOutput().
|
inherited |
Get the class's combined type and name; useful in error handling.
Definition at line 27 of file MooseBase.C.
Referenced by MaterialPropertyStorage::addProperty(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< std::vector< T > >::finalize(), and ReporterData::getReporterInfo().
|
inline |
Returns a writable Boolean indicating whether this app will use an eigenvalue executioner.
Definition at line 419 of file MooseApp.h.
Referenced by CreateProblemDefaultAction::act().
|
inline |
Definition at line 349 of file MooseApp.h.
|
inline |
Returns a writable Boolean indicating whether this app will use a Nonlinear or Eigen System.
Definition at line 414 of file MooseApp.h.
Referenced by CreateProblemAction::act(), and CreateProblemDefaultAction::act().
|
static |
Definition at line 104 of file MooseApp.C.
std::vector< std::filesystem::path > MooseApp::writeRestartableMetaData | ( | const RestartableDataMapName & | name, |
const std::filesystem::path & | folder_base | ||
) |
Writes the restartable meta data for name
with a folder base of folder_base
.
Definition at line 1991 of file MooseApp.C.
Referenced by MeshOnlyAction::act(), SplitMeshAction::act(), Checkpoint::output(), and writeRestartableMetaData().
std::vector< std::filesystem::path > MooseApp::writeRestartableMetaData | ( | const std::filesystem::path & | folder_base | ) |
Writes all available restartable meta data with a file base of file_base
.
Definition at line 2005 of file MooseApp.C.
|
friend |
Definition at line 1516 of file MooseApp.h.
|
friend |
Definition at line 1517 of file MooseApp.h.
|
friend |
Definition at line 1518 of file MooseApp.h.
|
protected |
The Factory responsible for building Actions.
Definition at line 1176 of file MooseApp.h.
Referenced by createMinimalApp(), getActionFactory(), and MooseApp().
|
protected |
Where built actions are stored.
Definition at line 1179 of file MooseApp.h.
Referenced by actionWarehouse(), attachRelationshipManagers(), constructingMeshGenerators(), createMinimalApp(), getCheckpointDirectories(), getCurrentActionHitNode(), getRelationshipManagerInfo(), removeRelationshipManager(), runInputFile(), and setupOptions().
|
protectedinherited |
The MOOSE application this is associated with.
Definition at line 84 of file MooseBase.h.
Referenced by AB2PredictorCorrector::AB2PredictorCorrector(), FEProblemBase::acceptInvalidSolution(), ElementIDOutputAction::act(), CreateExecutionerAction::act(), DeclareLateReportersAction::act(), AddExecutorAction::act(), AddMeshGeneratorAction::act(), AutoCheckpointAction::act(), ExecuteMeshGenerators::act(), CheckIntegrityAction::act(), ReadExecutorParamsAction::act(), CopyNodalVarsAction::act(), SetupMeshCompleteAction::act(), CreateProblemDefaultAction::act(), CreateProblemAction::act(), MeshOnlyAction::act(), SetupMeshAction::act(), SplitMeshAction::act(), AdaptivityAction::act(), CombineComponentsMeshes::act(), AddTimeStepperAction::act(), SetupDebugAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), ComposeTimeStepperAction::act(), SetupRecoverFileBaseAction::act(), CouplingFunctorCheckAction::act(), AddRelationshipManager::act(), SetAdaptivityOptionsAction::act(), CreateAddedMeshGenerators::act(), DisplayGhostingAction::act(), MaterialOutputAction::act(), ResolveOptionalMaterialPropertiesAction::act(), CommonOutputAction::act(), AddPeriodicBCAction::act(), Action::Action(), FEProblemBase::addAnyRedistributers(), MeshGenerator::addChildMeshGenerator(), FEProblemBase::addMaterialHelper(), CylinderComponent::addMeshGenerators(), BatchMeshGeneratorAction::addMeshGenerators(), MeshGenerator::addMeshSubgenerator(), FEProblemBase::addMultiApp(), FEProblemBase::addOutput(), MeshGenerator::addParentMeshGenerator(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), FVFluxKernel::adjustRMGhostLayers(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), BatchMeshGeneratorAction::BatchMeshGeneratorAction(), FileMesh::buildMesh(), MooseMesh::buildTypedMesh(), MooseMesh::cacheFaceInfoVariableOwnership(), MooseMesh::cacheFVElementalDoFs(), MooseBase::callMooseError(), CheckOutputAction::checkConsoleOutput(), DefaultNonlinearConvergence::checkConvergence(), MeshGenerator::checkGetMesh(), FEProblemBase::checkICRestartError(), CheckOutputAction::checkMaterialOutput(), CheckOutputAction::checkPerfLogOutput(), CheckOutputAction::checkVariableOutput(), SingleRankPartitioner::clone(), RandomPartitioner::clone(), BlockWeightedPartitioner::clone(), GhostEverything::clone(), GhostHigherDLowerDPointNeighbors::clone(), GhostLowerDElems::clone(), LibmeshPartitioner::clone(), PetscExternalPartitioner::clone(), HierarchicalGridPartitioner::clone(), GridPartitioner::clone(), ElementSideNeighborLayers::clone(), ElementPointNeighborLayers::clone(), RedistributeProperties::clone(), GhostBoundary::clone(), ProxyRelationshipManager::clone(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeLinearSystemTags(), FEProblemBase::computeResidualAndJacobian(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), MultiApp::createApp(), MultiApp::createApps(), FEProblemBase::customSetup(), MeshGenerator::declareMeshProperty(), MeshGenerator::declareNullMeshName(), MooseMesh::determineUseDistributedMesh(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::DumpObjectsProblem(), DumpObjectsProblem::dumpVariableHelper(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), InversePowerMethod::execute(), NonlinearEigen::execute(), PseudoTimestep::execute(), IterationInfo::execute(), PIDTransientControl::execute(), TransientBase::execute(), SteadyBase::execute(), Eigenvalue::execute(), EigenProblem::execute(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), FEProblemBase::FEProblemBase(), FileOutput::FileOutput(), ChangeOverFixedPointPostprocessor::finalize(), RadialAverage::finalize(), FixedPointSolve::FixedPointSolve(), FEProblemBase::forceOutput(), FullSolveMultiApp::FullSolveMultiApp(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), FVAdvection::FVAdvection(), ExtraNodesetGenerator::generate(), SideSetsFromNormalsGenerator::generate(), FileMeshGenerator::generate(), MeshGenerator::generateInternal(), FEProblemBase::getExecutor(), MeshGenerator::getMeshByName(), MooseBase::getMooseApp(), NumRelationshipManagers::getValue(), NumFixedPointIterations::getValue(), GhostingUserObject::GhostingUserObject(), InversePowerMethod::init(), NonlinearEigen::init(), TransientBase::init(), Eigenvalue::init(), MooseMesh::init(), FEProblemBase::init(), TimePeriod::initialSetup(), Console::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), EigenProblem::initPetscOutputAndSomeSolverSettings(), FEProblemBase::initPetscOutputAndSomeSolverSettings(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MeshGenerator::MeshGenerator(), MooseObject::MooseObject(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), EigenExecutionerBase::normalizeSolution(), NumFailedTimeSteps::NumFailedTimeSteps(), PerfGraphOutput::output(), Tecplot::output(), Exodus::output(), Checkpoint::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), JSONOutput::outputSystemInformation(), Console::outputSystemInformation(), OverlayMeshGenerator::OverlayMeshGenerator(), MultiApp::parentOutputPositionChanged(), TransientBase::preExecute(), PhysicsBase::prepareCopyVariablesFromMesh(), Eigenvalue::prepareSolverOptions(), FEProblemBase::projectSolution(), TiledMesh::safeClone(), FileMesh::safeClone(), ImageMesh::safeClone(), RinglebMesh::safeClone(), AnnularMesh::safeClone(), GeneratedMesh::safeClone(), SpiralAnnularMesh::safeClone(), ConcentricCircleMesh::safeClone(), MeshGeneratorMesh::safeClone(), StitchedMesh::safeClone(), PatternedMesh::safeClone(), MultiApp::setAppOutputFileBase(), FileOutput::setFileBaseInternal(), MeshGenerator::setMeshProperty(), MeshGenerator::setMeshPropertyHelper(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), MeshGeneratorComponent::setupComponent(), SetupMeshAction::setupMesh(), TimeSequenceStepperBase::setupSequence(), TransientBase::setupTimeIntegrator(), Output::setWallTimeIntervalFromCommandLineParam(), SideSetExtruderGenerator::SideSetExtruderGenerator(), SolutionInvalidityReporter::SolutionInvalidityReporter(), EigenProblem::solve(), FEProblemBase::solve(), FEProblemBase::solveLinearSystem(), PetscOutput::solveSetup(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimeIntervalTimes::TimeIntervalTimes(), TimePeriod::TimePeriod(), FEProblemBase::timestepSetup(), TransientBase::TransientBase(), FEProblemBase::updateMortarMesh(), Console::write(), and FEProblemBase::~FEProblemBase().
|
protected |
The relationship managers that have been attached (type -> RMs)
Definition at line 1301 of file MooseApp.h.
Referenced by attachRelationshipManagers().
|
private |
Whether to turn on automatic scaling by default.
Definition at line 1487 of file MooseApp.h.
Referenced by defaultAutomaticScaling().
|
protected |
Builder for building app related parser tree.
Definition at line 1188 of file MooseApp.h.
Referenced by builder(), errorCheck(), getFileName(), and setupOptions().
|
private |
The system that manages the ChainControls.
Definition at line 1470 of file MooseApp.h.
Referenced by getChainControlDataSystem().
|
protected |
true if we want to just check the input file
Definition at line 1294 of file MooseApp.h.
Referenced by checkInput(), errorCheck(), MooseApp(), run(), and setupOptions().
|
protected |
The MPI communicator this App is going to use.
Definition at line 1142 of file MooseApp.h.
Referenced by errorCheck(), getCommunicator(), MooseApp(), and processor_id().
|
protected |
Command line object.
Definition at line 1166 of file MooseApp.h.
Referenced by commandLine(), copyInputs(), executeExecutioner(), MooseApp(), setupOptions(), and showInputs().
|
inherited |
An instance of helper class to write streams to the Console objects.
Definition at line 31 of file ConsoleStreamInterface.h.
Referenced by IterationAdaptiveDT::acceptStep(), MeshOnlyAction::act(), SetupDebugAction::act(), MaterialOutputAction::act(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), PerfGraph::addToExecutionList(), SimplePredictor::apply(), SystemBase::applyScalingFactors(), MultiApp::backup(), FEProblemBase::backupMultiApps(), CoarsenedPiecewiseLinear::buildCoarsenedGrid(), MeshDiagnosticsGenerator::checkElementOverlap(), MeshDiagnosticsGenerator::checkElementTypes(), MeshDiagnosticsGenerator::checkElementVolumes(), FEProblemBase::checkExceptionAndStopSolve(), SolverSystem::checkInvalidSolution(), MeshDiagnosticsGenerator::checkLocalJacobians(), MeshDiagnosticsGenerator::checkNonConformalMesh(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), MeshDiagnosticsGenerator::checkNonPlanarSides(), FEProblemBase::checkProblemIntegrity(), ReferenceResidualConvergence::checkRelativeConvergence(), MeshDiagnosticsGenerator::checkSidesetsOrientation(), MeshDiagnosticsGenerator::checkWatertightNodesets(), MeshDiagnosticsGenerator::checkWatertightSidesets(), IterationAdaptiveDT::computeAdaptiveDT(), TransientBase::computeConstrainedDT(), FixedPointSolve::computeCustomConvergencePostprocessor(), NonlinearSystemBase::computeDamping(), FixedPointIterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInitialDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeLinearSystemTags(), NonlinearSystemBase::computeScaling(), Problem::console(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), MultiApp::createApp(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MessageFromInput::execute(), SteadyBase::execute(), Eigenvalue::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), MeshGeneratorSystem::executeMeshGenerators(), ElementQualityChecker::finalize(), FEProblemBase::finishMultiAppStep(), MeshRepairGenerator::fixOverlappingNodes(), CoarsenBlockGenerator::generate(), MeshGenerator::generateInternal(), VariableCondensationPreconditioner::getDofToCondense(), NonlinearEigen::init(), InversePowerMethod::init(), FEProblemBase::initialAdaptMesh(), EigenExecutionerBase::inversePowerIteration(), FEProblemBase::joinAndFinalize(), TransientBase::keepGoing(), IterationAdaptiveDT::limitDTByFunction(), IterationAdaptiveDT::limitDTToPostprocessorValue(), FEProblemBase::logAdd(), EigenExecutionerBase::makeBXConsistent(), Console::meshChanged(), MooseBaseErrorInterface::mooseDeprecated(), MooseBaseErrorInterface::mooseInfo(), MooseBaseErrorInterface::mooseWarning(), MooseBaseErrorInterface::mooseWarningNonPrefixed(), ReferenceResidualConvergence::nonlinearConvergenceSetup(), ReporterDebugOutput::output(), PerfGraphOutput::output(), SolutionInvalidityOutput::output(), MaterialPropertyDebugOutput::output(), DOFMapOutput::output(), VariableResidualNormsDebugOutput::output(), Console::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Console::outputInput(), Console::outputPostprocessors(), PseudoTimestep::outputPseudoTimestep(), Console::outputReporters(), Console::outputScalarVariables(), Console::outputSystemInformation(), FEProblemBase::possiblyRebuildGeomSearchPatches(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), BlockRestrictionDebugOutput::printBlockRestrictionMap(), SolutionInvalidity::printDebug(), EigenExecutionerBase::printEigenvalue(), SteffensenSolve::printFixedPointConvergenceHistory(), SecantSolve::printFixedPointConvergenceHistory(), PicardSolve::printFixedPointConvergenceHistory(), FixedPointSolve::printFixedPointConvergenceReason(), PerfGraphLivePrint::printLiveMessage(), MaterialPropertyDebugOutput::printMaterialMap(), PerfGraphLivePrint::printStats(), AutomaticMortarGeneration::projectPrimaryNodesSinglePair(), AutomaticMortarGeneration::projectSecondaryNodesSinglePair(), CoarsenBlockGenerator::recursiveCoarsen(), SolutionTimeAdaptiveDT::rejectStep(), MultiApp::restore(), FEProblemBase::restoreMultiApps(), NonlinearSystemBase::setInitialSolution(), setupOptions(), Checkpoint::shouldOutput(), SubProblem::showFunctorRequestors(), SubProblem::showFunctors(), FullSolveMultiApp::showStatusMessage(), FixedPointSolve::solve(), FEProblemSolve::solve(), EigenProblem::solve(), NonlinearSystem::solve(), LinearSystem::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), LStableDirk4::solve(), AStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), FixedPointSolve::solveStep(), PerfGraphLivePrint::start(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), TransientBase::takeStep(), TerminateChainControl::terminate(), Convergence::verboseOutput(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().
|
private |
|
protected |
This variable indicates that DistributedMesh should be used for the libMesh mesh underlying MooseMesh.
Definition at line 1267 of file MooseApp.h.
Referenced by getDistributedMeshOnCommandLine(), and setupOptions().
|
protected |
Indicates if simulation is ready to exit, and keeps track of which param caused it to exit.
Definition at line 1255 of file MooseApp.h.
Referenced by errorCheck(), run(), runInputFile(), and setupOptions().
|
protected |
Referenced by disableCheckUnusedFlag(), errorCheck(), and setCheckUnusedFlag().
|
protected |
Indicates whether warnings or errors are displayed when overridden parameters are detected.
Definition at line 1253 of file MooseApp.h.
Referenced by setErrorOverridden().
|
protected |
The Exodus reader when _initial_from_file is set to true.
Definition at line 1264 of file MooseApp.h.
Referenced by getExReaderForRestart(), and setExReaderForRestart().
|
private |
Execution flags for this App.
Note: These are copied on purpose instead of maintaining a reference to the ExecFlagRegistry registry. In the Multiapp case, the registry may be augmented, changing the flags "known" to the application in the middle of executing the setup. This causes issues with the application having to process flags that aren't specifically registered.
Definition at line 1481 of file MooseApp.h.
Referenced by getExecuteOnEnum().
|
protected |
Pointer to the executioner of this run (typically build by actions)
Definition at line 1209 of file MooseApp.h.
Referenced by attachRelationshipManagers(), errorCheck(), executeExecutioner(), feProblem(), getExecutioner(), removeRelationshipManager(), setExecutioner(), and setOutputPosition().
|
protected |
Pointer to the Executor of this run.
Definition at line 1212 of file MooseApp.h.
Referenced by attachRelationshipManagers(), createExecutors(), errorCheck(), executeExecutioner(), feProblem(), getExecutioner(), getExecutor(), and setExecutor().
|
protected |
Used in building the Executors Maps the name of the Executor block to the <type, params>
Definition at line 1220 of file MooseApp.h.
Referenced by addExecutorParams(), createExecutors(), and recursivelyCreateExecutors().
|
protected |
Pointers to all of the Executors for this run.
Definition at line 1215 of file MooseApp.h.
Referenced by addExecutor(), createExecutors(), getExecutor(), and recursivelyCreateExecutors().
|
protected |
The exit code.
Definition at line 1258 of file MooseApp.h.
Referenced by exitCode(), setExitCode(), and setupOptions().
|
protected |
Definition at line 1250 of file MooseApp.h.
Referenced by addExecutor(), createExecutors(), getFactory(), MooseApp(), removeRelationshipManager(), and runInputFile().
|
protected |
Whether or not file base is set through input or setOutputFileBase by MultiApp.
Definition at line 1148 of file MooseApp.h.
Referenced by getCheckpointDirectories(), getOutputFileBase(), setOutputFileBase(), and setupOptions().
|
protected |
Multiapp-related fixed point algorithm configuration details primarily intended to be passed to and used by the executioner/executor system.
Definition at line 1224 of file MooseApp.h.
Referenced by fixedPointConfig().
|
protected |
Offset of the local App time to the "global" problem time.
Definition at line 1163 of file MooseApp.h.
Referenced by getGlobalTimeOffset(), and setGlobalTimeOffset().
|
private |
|
private |
The backup for use in initial setup; this will get set from the _initial_backup input parameter that typically gets set from a MultiApp that has a backup This is a pointer to a pointer because at the time of construction of the app, the backup will not be filled yet.
Definition at line 1508 of file MooseApp.h.
Referenced by hasInitialBackup(), and restoreFromInitialBackup().
|
protected |
This variable indicates when a request has been made to restart from an Exodus file.
Definition at line 1261 of file MooseApp.h.
Referenced by getExodusFileRestart(), and setExodusFileRestart().
|
protected |
Input parameter storage structure; unique_ptr so we can control its destruction order.
Definition at line 1173 of file MooseApp.h.
Referenced by getInputParameterWarehouse().
|
private |
Registration for interface objects.
Definition at line 1502 of file MooseApp.h.
Referenced by getInterfaceObjects(), and registerInterfaceObject().
|
protected |
The library archive (name only), registration method and the handle to the method.
Definition at line 1318 of file MooseApp.h.
Referenced by getLoadedLibraryPaths(), and loadLibraryAndDependencies().
|
private |
The libtorch device this app is using.
Definition at line 1512 of file MooseApp.h.
|
private |
The displaced mesh from master app.
Definition at line 1464 of file MooseApp.h.
Referenced by masterDisplacedMesh(), and MooseApp().
|
private |
The mesh from master app.
Definition at line 1461 of file MooseApp.h.
Referenced by masterMesh(), and MooseApp().
|
private |
The system that manages the MeshGenerators.
Definition at line 1467 of file MooseApp.h.
Referenced by addMeshGenerator(), appendMeshGenerator(), constructingMeshGenerators(), getMeshGenerator(), getMeshGeneratorMesh(), getMeshGeneratorNames(), getMeshGeneratorSystem(), and hasMeshGenerator().
|
private |
Level of multiapp, the master is level 0. This used by the Console to indent output.
Definition at line 1455 of file MooseApp.h.
Referenced by getOutputFileBase(), isUltimateMaster(), MooseApp(), and multiAppLevel().
|
private |
Numbering in all the sub-apps on the same level.
Definition at line 1458 of file MooseApp.h.
Referenced by multiAppNumber().
|
protectedinherited |
The name of this class.
Definition at line 90 of file MooseBase.h.
Referenced by AddBCAction::act(), AddDGKernelAction::act(), AddPostprocessorAction::act(), AddConstraintAction::act(), AddUserObjectAction::act(), AddIndicatorAction::act(), AddMarkerAction::act(), AddDiracKernelAction::act(), AddInterfaceKernelAction::act(), PartitionerAction::act(), AddFVInitialConditionAction::act(), AddMultiAppAction::act(), AddVectorPostprocessorAction::act(), ReadExecutorParamsAction::act(), AddScalarKernelAction::act(), AddTransferAction::act(), AddFunctorMaterialAction::act(), AddFVInterfaceKernelAction::act(), AddMaterialAction::act(), AddKernelAction::act(), AddDamperAction::act(), AddInitialConditionAction::act(), AddNodalKernelAction::act(), AddMeshGeneratorAction::act(), AddPositionsAction::act(), AddReporterAction::act(), AddTimesAction::act(), AddFieldSplitAction::act(), AddFVKernelAction::act(), AddFVBCAction::act(), AddConvergenceAction::act(), AddHDGKernelAction::act(), AddTimeStepperAction::act(), AddDistributionAction::act(), SetupPreconditionerAction::act(), SetupTimeIntegratorAction::act(), AddFunctionAction::act(), AddMeshDivisionAction::act(), AddHDGBCAction::act(), AddOutputAction::act(), AddLinearFVBCAction::act(), AddLinearFVKernelAction::act(), AddCorrectorAction::act(), AddMeshModifiersAction::act(), AddSamplerAction::act(), AddControlAction::act(), AddPeriodicBCAction::act(), ADPiecewiseLinearInterpolationMaterial::ADPiecewiseLinearInterpolationMaterial(), PiecewiseTabularBase::buildFromFile(), PiecewiseTabularBase::buildFromXY(), PiecewiseLinearBase::buildInterpolation(), CombinerGenerator::CombinerGenerator(), Executor::Executor(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), QuadraturePointMultiApp::fillPositions(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), FillBetweenPointVectorsGenerator::generate(), FillBetweenCurvesGenerator::generate(), FillBetweenSidesetsGenerator::generate(), NearestPointBase< LayeredSideDiffusiveFluxAverage, SideIntegralVariableUserObject >::name(), ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), and PiecewiseBase::setData().
|
protected |
Used to return an executor that does nothing.
Definition at line 1231 of file MooseApp.h.
Referenced by createExecutors(), getExecutor(), and getNullExecutor().
|
private |
Cache output buffer so the language server can turn it off then back on.
Definition at line 1484 of file MooseApp.h.
Referenced by MooseApp(), and setupOptions().
|
protected |
The output file basename.
Definition at line 1145 of file MooseApp.h.
Referenced by getOutputFileBase(), setOutputFileBase(), and setupOptions().
|
protected |
Map of outputer name and file number (used by MultiApps to propagate file numbers down through the multiapps)
Definition at line 1291 of file MooseApp.h.
Referenced by getOutputFileNumbers(), and setOutputFileNumbers().
|
protected |
The output position.
Definition at line 1154 of file MooseApp.h.
Referenced by getOutputPosition(), and setOutputPosition().
|
protected |
Whether or not an output position has been set for this app.
Definition at line 1151 of file MooseApp.h.
Referenced by hasOutputPosition(), and setOutputPosition().
|
protected |
OutputWarehouse object for this App.
Definition at line 1182 of file MooseApp.h.
Referenced by getOutputWarehouse(), setOutputFileBase(), and setOutputPosition().
|
protected |
Parameters of this object.
Definition at line 1136 of file MooseApp.h.
Referenced by copyInputs(), getParam(), getRenamedParam(), isParamSetByUser(), isParamValid(), parameters(), setupOptions(), and showInputs().
|
protected |
Parser for parsing the input file.
Definition at line 1185 of file MooseApp.h.
Referenced by getInputFileNames(), getLastInputFileName(), parser(), and setupOptions().
|
protected |
The PerfGraph object for this application (recoverable)
Definition at line 1200 of file MooseApp.h.
Referenced by MooseApp(), perfGraph(), and setupOptions().
|
protectedinherited |
The MooseApp that owns the PerfGraph.
Definition at line 124 of file PerfGraphInterface.h.
Referenced by PerfGraphInterface::perfGraph().
|
protectedinherited |
A prefix to use for all sections.
Definition at line 127 of file PerfGraphInterface.h.
Referenced by PerfGraphInterface::timedSectionName().
|
protected |
The RankMap is a useful object for determining how the processes are laid out on the physical hardware.
Definition at line 1206 of file MooseApp.h.
Referenced by rankMap().
|
private |
Definition at line 1472 of file MooseApp.h.
Referenced by finalizeRestore(), and restore().
|
protected |
Definition at line 1256 of file MooseApp.h.
Referenced by executeExecutioner(), run(), runInputFile(), and setupOptions().
|
protected |
Whether or not this is a recovery run.
Definition at line 1270 of file MooseApp.h.
Referenced by isRecovering(), setRecover(), and setupOptions().
|
protected |
Data names that will only be read from the restart file during RECOVERY.
e.g. these names are excluded during restart.
Definition at line 1197 of file MooseApp.h.
Referenced by getRecoverableData(), and registerRestartableNameWithFilter().
|
protected |
The relationship managers that have been added.
Definition at line 1297 of file MooseApp.h.
Referenced by addRelationshipManager(), attachRelationshipManagers(), getRelationshipManagerInfo(), hasRelationshipManager(), relationshipManagers(), and removeRelationshipManager().
|
protected |
Whether or not this is a restart run.
Definition at line 1273 of file MooseApp.h.
Referenced by isRestarting(), and setRestart().
|
protected |
The base name to restart/recover from. If blank then we will find the newest checkpoint file.
Definition at line 1285 of file MooseApp.h.
Referenced by getRecoverFileBase(), getRestartRecoverFileBase(), hasRecoverFileBase(), hasRestartRecoverFileBase(), setRestartRecoverFileBase(), and setupOptions().
|
protected |
Where the restartable data is held (indexed on tid)
Definition at line 1191 of file MooseApp.h.
Referenced by backup(), getRestartableData(), and registerRestartableData().
|
private |
General storage for custom RestartableData that can be added to from outside applications.
Definition at line 1442 of file MooseApp.h.
Referenced by checkMetaDataIntegrity(), getRestartableDataMap(), getRestartableDataMapBegin(), getRestartableDataMapEnd(), getRestartableDataMapName(), hasRestartableDataMap(), hasRestartableMetaData(), loadRestartableMetaData(), registerRestartableData(), registerRestartableDataMapName(), and writeRestartableMetaData().
|
protected |
The SolutionInvalidity object for this application.
Definition at line 1203 of file MooseApp.h.
Referenced by solutionInvalidity().
|
protected |
Whether or not we are performing a split mesh operation (–split-mesh)
Definition at line 1276 of file MooseApp.h.
Referenced by isSplitMesh(), and setupOptions().
|
protected |
The time at which to start the simulation.
Definition at line 1160 of file MooseApp.h.
Referenced by getStartTime(), and setStartTime().
|
protected |
Whether or not an start time has been set.
Definition at line 1157 of file MooseApp.h.
Referenced by hasStartTime(), and setStartTime().
|
protected |
Syntax of the input file.
Definition at line 1169 of file MooseApp.h.
Referenced by MooseApp(), setupOptions(), and syntax().
|
protected |
System Information.
Definition at line 1240 of file MooseApp.h.
Referenced by getSystemInfo(), and MooseApp().
|
private |
Map from a template relationship manager to a map in which the key-value pairs represent the MeshBase
object and the clone of the template relationship manager, e.g.
the top-level map key
Definition at line 1499 of file MooseApp.h.
Referenced by createRMFromTemplateAndInit(), getRMClone(), and hasRMClone().
|
protected |
Whether or not this simulation should only run half its transient (useful for testing recovery)
Definition at line 1288 of file MooseApp.h.
Referenced by setupOptions(), and testCheckpointHalfTransient().
|
private |
The combined warehouse for storing any MooseObject based object.
Definition at line 1452 of file MooseApp.h.
Referenced by MooseApp(), and theWarehouse().
|
protected |
Whether or not FPE trapping should be turned on.
Definition at line 1282 of file MooseApp.h.
Referenced by getFPTrapFlag(), and setupOptions().
|
protected |
The string representation of the type of this object as registered (see registerApp(AppName))
Definition at line 1139 of file MooseApp.h.
Referenced by MooseApp().
|
protected |
A map from undisplaced relationship managers to their displaced clone (stored as the base GhostingFunctor).
Anytime we clone in attachRelationshipManagers we create a map entry from the cloned undisplaced relationship manager to its displaced clone counterpart. We leverage this map when removing relationship managers/ghosting functors
Definition at line 1308 of file MooseApp.h.
|
protected |
Boolean to indicate whether to use an eigenvalue executioner.
Definition at line 1237 of file MooseApp.h.
Referenced by useEigenvalue().
|
protected |
Indicates whether we are operating in the new/experimental executor mode instead of using the legacy executioner system.
Definition at line 1228 of file MooseApp.h.
Referenced by executeExecutioner(), and useExecutor().
|
protected |
Boolean to indicate whether to use a Nonlinear or EigenSystem (inspected by actions)
Definition at line 1234 of file MooseApp.h.
Referenced by useNonlinear().
|
protected |
Whether or not we are using a (pre-)split mesh (automatically DistributedMesh)
Definition at line 1279 of file MooseApp.h.
|
static |
Definition at line 109 of file MooseApp.h.
Referenced by MeshOnlyAction::act(), SplitMeshAction::act(), SetupDebugAction::act(), FileMesh::buildMesh(), MeshGenerator::declareMeshProperty(), FileMeshGenerator::generate(), MeshMetaDataInterface::getMeshPropertyInternal(), MeshMetaDataInterface::hasMeshProperty(), MooseApp(), MeshGenerator::setMeshPropertyHelper(), and MeshMetaDataReporter::validParams().
|
static |
Definition at line 110 of file MooseApp.h.
Referenced by MooseApp().