MultiApp Class Reference

A MultiApp represents one or more MOOSE applications that are running simultaneously. More...

#include <MultiApp.h>

Inheritance diagram for MultiApp:

Public Member Functions
	MultiApp (const InputParameters &parameters)
virtual void	preExecute ()
virtual void	finalize ()
	Method called towards the end of the simulation to execute on final. More...
virtual void	postExecute ()
	Method called at the end of the simulation (after finalize) More...
void	setupPositions ()
	Called just after construction to allow derived classes to set _positions;. More...
virtual void	initialSetup () override
	Gets called at the beginning of the simulation before this object is asked to do its job. More...
virtual void	preTransfer (Real dt, Real target_time)
	Gets called just before transfers are done to the MultiApp (Which is just before the MultiApp is solved) More...
virtual bool	solveStep (Real dt, Real target_time, bool auto_advance=true)=0
	Re-solve all of the Apps. More...
virtual void	incrementTStep (Real)
	Advances the multi-apps time step which is important for dt selection. More...
virtual void	finishStep ()
	Calls multi-apps executioners' endStep and postStep methods which creates output and advances time (not the time step; see incrementTStep()) among other things. More...
virtual void	backup ()
	Save off the state of every Sub App. More...
virtual void	restore ()
	Restore the state of every Sub App. More...
virtual bool	needsRestoration ()
	Whether or not this MultiApp should be restored at the beginning of each Picard iteration. More...
virtual Executioner *	getExecutioner (unsigned int app)
virtual BoundingBox	getBoundingBox (unsigned int app, bool displaced_mesh)
	Get the BoundingBox for the mesh associated with app The bounding box will be shifted to be in the correct position within the master domain. More...
FEProblemBase &	problemBase ()
	Get the FEProblemBase this MultiApp is part of. More...
FEProblemBase &	appProblemBase (unsigned int app)
	Get the FEProblemBase for the global app is part of. More...
FEProblem &	appProblem (unsigned int app)
	Get the FEProblem for the global app is part of. More...
const UserObject &	appUserObjectBase (unsigned int app, const std::string &name)
	Get a UserObject base for a specific global app. More...
Real	appPostprocessorValue (unsigned int app, const std::string &name)
	Get a Postprocessor value for a specified global app. More...
virtual NumericVector< Number > &	appTransferVector (unsigned int app, std::string var_name)
	Get the vector to transfer to for this MultiApp. More...
unsigned int	numGlobalApps ()
unsigned int	numLocalApps ()
unsigned int	firstLocalApp ()
bool	hasApp ()
	Whether or not this MultiApp has an app on this processor. More...
bool	hasLocalApp (unsigned int global_app)
	Whether or not the given global app number is on this processor. More...
MooseApp *	localApp (unsigned int local_app)
	Get the local MooseApp object. More...
Point	position (unsigned int app)
	The physical position of a global App number. More...
virtual void	resetApp (unsigned int global_app, Real time=0.0)
	"Reset" the App corresponding to the global App number passed in. More...
virtual void	moveApp (unsigned int global_app, Point p)
	Move the global_app to Point p. More...
virtual void	parentOutputPositionChanged ()
	For apps outputting in position we need to change their output positions if their parent app moves. More...
MPI_Comm &	comm ()
	Get the MPI communicator this MultiApp is operating on. More...
bool	isRootProcessor ()
	Whether or not this processor is the "root" processor for the sub communicator. More...
const std::string &	type () const
	Get the type of this object. More...
const std::string &	name () const
	Get the name of the object. More...
const InputParameters &	parameters () const
	Get the parameters of the object. More...
template<typename T >
const T &	getParam (const std::string &name) const
	Retrieve a parameter for the object. More...
template<typename T >
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
	Verifies that the requested parameter exists and is not NULL and returns it to the caller. More...
bool	isParamValid (const std::string &name) const
	Test if the supplied parameter is valid. More...
MooseApp &	getMooseApp () const
	Get the MooseApp this object is associated with. More...
virtual bool	enabled () const
	Return the enabled status of the object. More...
template<typename... Args>
void	paramError (const std::string &param, Args... args)
	Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...
template<typename... Args>
void	paramWarning (const std::string &param, Args... args)
	Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...
template<typename... Args>
void	paramInfo (const std::string &param, Args... args)
	Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...
template<typename... Args>
void	mooseError (Args &&... args) const
template<typename... Args>
void	mooseWarning (Args &&... args) const
template<typename... Args>
void	mooseDeprecated (Args &&... args) const
template<typename... Args>
void	mooseInfo (Args &&... args) const
virtual void	timestepSetup ()
	Gets called at the beginning of the timestep before this object is asked to do its job. More...
virtual void	jacobianSetup ()
	Gets called just before the Jacobian is computed and before this object is asked to do its job. More...
virtual void	residualSetup ()
	Gets called just before the residual is computed and before this object is asked to do its job. More...
virtual void	subdomainSetup ()
	Gets called when the subdomain changes (i.e. More...
const ExecFlagEnum &	getExecuteOnEnum () const
	Return the execute on MultiMooseEnum for this object. More...
virtual const std::vector< ExecFlagType > &	execFlags () const
	(DEPRECATED) Get the execution flag for the object TODO: ExecFlagType More...
ExecFlagType	execBitFlags () const
	(DEPRECATED) Build and return the execution flags as a bitfield TODO: ExecFlagType More...

Static Public Member Functions
static ExecFlagEnum	getExecuteOptions ()
	(DEPRECATED) Returns the available options for the 'execute_on' input parameters TODO: ExecFlagType More...

Public Attributes
const ConsoleStream	_console
	An instance of helper class to write streams to the Console objects. More...

Protected Member Functions
virtual void	fillPositions ()
	must fill in _positions with the positions of the sub-aps More...
void	createApp (unsigned int i, Real start_time)
	Helper function for creating an App instance. More...
void	buildComm ()
	Create an MPI communicator suitable for each app. More...
unsigned int	globalAppToLocal (unsigned int global_app)
	Map a global App number to the local number. More...
virtual void	preRunInputFile ()
	call back executed right before app->runInputFile() More...
void	init (unsigned int num)
	Initialize the MultiApp by creating the provided number of apps. More...
template<typename T >
T &	declareRestartableData (std::string data_name)
	Declare a piece of data as "restartable". More...
template<typename T >
T &	declareRestartableData (std::string data_name, const T &init_value)
	Declare a piece of data as "restartable" and initialize it. More...
template<typename T >
T &	declareRestartableDataWithContext (std::string data_name, void *context)
	Declare a piece of data as "restartable". More...
template<typename T >
T &	declareRestartableDataWithContext (std::string data_name, const T &init_value, void *context)
	Declare a piece of data as "restartable" and initialize it. More...
template<typename T >
T &	declareRecoverableData (std::string data_name)
	Declare a piece of data as "recoverable". More...
template<typename T >
T &	declareRecoverableData (std::string data_name, const T &init_value)
	Declare a piece of data as "restartable" and initialize it. More...
template<typename T >
T &	declareRestartableDataWithObjectName (std::string data_name, std::string object_name)
	Declare a piece of data as "restartable". More...
template<typename T >
T &	declareRestartableDataWithObjectNameWithContext (std::string data_name, std::string object_name, void *context)
	Declare a piece of data as "restartable". More...

Protected Attributes
FEProblemBase &	_fe_problem
	The FEProblemBase this MultiApp is part of. More...
std::string	_app_type
	The type of application to build. More...
std::vector< Point >	_positions
	The positions of all of the apps. More...
const bool	_use_positions
	Toggle use of "positions". More...
std::vector< FileName >	_input_files
	The input file for each app's simulation. More...
std::string	_output_base
	The output file basename for each multiapp. More...
unsigned int	_total_num_apps
	The total number of apps to simulate. More...
unsigned int	_my_num_apps
	The number of apps this object is involved in simulating. More...
unsigned int	_first_local_app
	The number of the first app on this processor. More...
const MPI_Comm &	_orig_comm
	The original comm handle. More...
libMesh::Parallel::Communicator	_my_communicator
	The communicator object that holds the MPI_Comm that we're going to use. More...
MPI_Comm &	_my_comm
	The MPI communicator this object is going to use. More...
int	_orig_num_procs
	The number of processors in the original comm. More...
int	_orig_rank
	The mpi "rank" of this processor in the original communicator. More...
std::string	_node_name
	Node Name. More...
int	_my_rank
	The mpi "rank" of this processor in the sub communicator. More...
std::vector< std::shared_ptr< MooseApp > >	_apps
	Pointers to each of the Apps. More...
std::vector< bool >	_has_bounding_box
	Flag if this multi-app computed its bounding box (valid only for non-displaced meshes) More...
std::vector< BoundingBox >	_bounding_box
	This multi-app's bounding box. More...
Real	_inflation
	Relative bounding box inflation. More...
Point	_bounding_box_padding
	Additional padding added to the bounding box, useful for 1D meshes. More...
unsigned int	_max_procs_per_app
	Maximum number of processors to give to each app. More...
bool	_output_in_position
	Whether or not to move the output of the MultiApp into position. More...
const Real	_global_time_offset
	The offset time so the MultiApp local time relative to the global time. More...
Real	_reset_time
	The time at which to reset apps. More...
std::vector< unsigned int >	_reset_apps
	The apps to be reset. More...
bool	_reset_happened
	Whether or not apps have been reset. More...
Real	_move_time
	The time at which to move apps. More...
std::vector< unsigned int >	_move_apps
	The apps to be moved. More...
std::vector< Point >	_move_positions
	The new positions for the apps to be moved. More...
bool	_move_happened
	Whether or not the move has happened. More...
bool	_has_an_app
	Whether or not this processor as an App at all More...
SubAppBackups &	_backups
	Backups for each local App. More...
const std::vector< std::string > &	_cli_args
	Storage for command line arguments. More...
const InputParameters &	_pars
	Parameters of this object, references the InputParameters stored in the InputParametersWarehouse. More...
MooseApp &	_app
	The MooseApp this object is associated with. More...
const std::string &	_type
	The type of this object (the Class name) More...
const std::string &	_name
	The name of this object, reference to value stored in InputParameters. More...
const bool &	_enabled
	Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects. More...
const ExecFlagEnum &	_execute_enum
	Execute settings for this oejct. More...
const std::vector< ExecFlagType >	_exec_flags
	(DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType More...
const ExecFlagType &	_current_execute_flag
	Reference to FEProblemBase. More...

Detailed Description

A MultiApp represents one or more MOOSE applications that are running simultaneously.

These other MOOSE apps generally represent some "sub-solve" or "embedded-solves" of the overall nonlinear solve. If your system support dynamic libraries unregistered Multiapps can be loaded on the fly by setting the exporting the appropriate library path using "MOOSE_LIBRARY_PATH" or by specifying a single input file library path in Multiapps InputParameters object.

Definition at line 58 of file MultiApp.h.

Constructor & Destructor Documentation

MultiApp()

MultiApp::MultiApp

(

const InputParameters &

parameters

)

Definition at line 171 of file MultiApp.C.

  : MooseObject(parameters),
    SetupInterface(this),
    Restartable(this, "MultiApps"),
    _fe_problem(*getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
    _app_type(isParamValid("app_type") ? std::string(getParam<MooseEnum>("app_type"))
                                       : _fe_problem.getMooseApp().type()),
    _use_positions(getParam<bool>("use_positions")),
    _input_files(getParam<std::vector<FileName>>("input_files")),
    _total_num_apps(0),
    _my_num_apps(0),
    _first_local_app(0),
    _orig_comm(_communicator.get()),
    _my_communicator(),
    _my_comm(_my_communicator.get()),
    _my_rank(0),
    _inflation(getParam<Real>("bounding_box_inflation")),
    _bounding_box_padding(getParam<Point>("bounding_box_padding")),
    _max_procs_per_app(getParam<unsigned int>("max_procs_per_app")),
    _output_in_position(getParam<bool>("output_in_position")),
    _global_time_offset(getParam<Real>("global_time_offset")),
    _reset_time(getParam<Real>("reset_time")),
    _reset_apps(getParam<std::vector<unsigned int>>("reset_apps")),
    _reset_happened(false),
    _move_time(getParam<Real>("move_time")),
    _move_apps(getParam<std::vector<unsigned int>>("move_apps")),
    _move_positions(getParam<std::vector<Point>>("move_positions")),
    _move_happened(false),
    _has_an_app(true),
    _backups(declareRestartableDataWithContext<SubAppBackups>("backups", this)),
    _cli_args(getParam<std::vector<std::string>>("cli_args"))
{
}

Member Function Documentation

appPostprocessorValue()

Real MultiApp::appPostprocessorValue	(	unsigned int	app,
		const std::string &	name
	)

Get a Postprocessor value for a specified global app.

Parameters

app	The global app number you want to get a Postprocessor from.
name	The name of the Postprocessor.

Definition at line 520 of file MultiApp.C.

{
  if (!_has_an_app)
    mooseError("No app for ", MultiApp::name(), " on processor ", _orig_rank);

  return appProblemBase(app).getPostprocessorValue(name);
}

appProblem()

FEProblem & MultiApp::appProblem

(

unsigned int

app

)

Get the FEProblem for the global app is part of.

Parameters

app	The global app number

Definition at line 498 of file MultiApp.C.

{
  mooseDeprecated(
      "MultiApp::appProblem() is deprecated, call MultiApp::appProblemBase() instead.\n");
  if (!_has_an_app)
    mooseError("No app for ", name(), " on processor ", _orig_rank);

  unsigned int local_app = globalAppToLocal(app);

  return dynamic_cast<FEProblem &>(_apps[local_app]->getExecutioner()->feProblem());
}

appProblemBase()

FEProblemBase & MultiApp::appProblemBase

(

unsigned int

app

)

Get the FEProblemBase for the global app is part of.

Parameters

app	The global app number

Definition at line 487 of file MultiApp.C.

Referenced by appPostprocessorValue(), TransientMultiApp::appTransferVector(), appTransferVector(), appUserObjectBase(), TransientMultiApp::resetApp(), TransientMultiApp::setupApp(), and TransientMultiApp::solveStep().

{
  if (!_has_an_app)
    mooseError("No app for ", name(), " on processor ", _orig_rank);

  unsigned int local_app = globalAppToLocal(app);

  return _apps[local_app]->getExecutioner()->feProblem();
}

appTransferVector()

NumericVector< Number > & MultiApp::appTransferVector ( unsigned int  app, std::string  var_name  )

virtual

Get the vector to transfer to for this MultiApp.

In general this is the Auxiliary system solution vector.

Parameters

app	The global app number you want the transfer vector for.
var_name	The name of the variable you are going to be transferring to.

Returns

The vector to fill.

Reimplemented in TransientMultiApp.

Definition at line 529 of file MultiApp.C.

{
  return appProblemBase(app).getAuxiliarySystem().solution();
}

appUserObjectBase()

const UserObject & MultiApp::appUserObjectBase	(	unsigned int	app,
		const std::string &	name
	)

Get a UserObject base for a specific global app.

Parameters

app	The global app number you want to get a UserObject from.
name	The name of the UserObject.

Definition at line 511 of file MultiApp.C.

Referenced by MultiAppDTKUserObjectEvaluator::evaluate().

{
  if (!_has_an_app)
    mooseError("No app for ", MultiApp::name(), " on processor ", _orig_rank);

  return appProblemBase(app).getUserObjectBase(name);
}

backup()

void MultiApp::backup ( )

virtual

Save off the state of every Sub App.

This allows us to "Restore" this state later

Reimplemented in FullSolveMultiApp.

Definition at line 400 of file MultiApp.C.

Referenced by FullSolveMultiApp::backup(), and dataStore().

{
  _console << "Begining backing up MultiApp " << name() << std::endl;
  for (unsigned int i = 0; i < _my_num_apps; i++)
    _backups[i] = _apps[i]->backup();
  _console << "Finished backing up MultiApp " << name() << std::endl;
}

buildComm()

void MultiApp::buildComm ( )

protected

Create an MPI communicator suitable for each app.

Also find out which communicator we are using and what our first local app is.

Definition at line 700 of file MultiApp.C.

Referenced by init().

{
  int ierr;

  ierr = MPI_Comm_size(_communicator.get(), &_orig_num_procs);
  mooseCheckMPIErr(ierr);
  ierr = MPI_Comm_rank(_communicator.get(), &_orig_rank);
  mooseCheckMPIErr(ierr);

  struct utsname sysInfo;
  uname(&sysInfo);

  _node_name = sysInfo.nodename;

  // If we have more apps than processors then we're just going to divide up the work
  if (_total_num_apps >= (unsigned)_orig_num_procs)
  {
    _my_comm = MPI_COMM_SELF;
    _my_rank = 0;

    _my_num_apps = _total_num_apps / _orig_num_procs;
    unsigned int jobs_left = _total_num_apps - (_my_num_apps * _orig_num_procs);

    if (jobs_left != 0)
    {
      // Spread the remaining jobs out over the first set of processors
      if ((unsigned)_orig_rank < jobs_left) // (these are the "jobs_left_pids" ie the pids that are
                                            // snatching up extra jobs)
      {
        _my_num_apps += 1;
        _first_local_app = _my_num_apps * _orig_rank;
      }
      else
      {
        unsigned int num_apps_in_jobs_left_pids = (_my_num_apps + 1) * jobs_left;
        unsigned int distance_to_jobs_left_pids = _orig_rank - jobs_left;

        _first_local_app = num_apps_in_jobs_left_pids + (_my_num_apps * distance_to_jobs_left_pids);
      }
    }
    else
      _first_local_app = _my_num_apps * _orig_rank;

    return;
  }

  // In this case we need to divide up the processors that are going to work on each app
  int rank;
  ierr = MPI_Comm_rank(_communicator.get(), &rank);
  mooseCheckMPIErr(ierr);

  unsigned int procs_per_app = _orig_num_procs / _total_num_apps;

  if (_max_procs_per_app < procs_per_app)
    procs_per_app = _max_procs_per_app;

  int my_app = rank / procs_per_app;
  unsigned int procs_for_my_app = procs_per_app;

  if ((unsigned int)my_app > _total_num_apps - 1 && procs_for_my_app == _max_procs_per_app)
  {
    // If we've already hit the max number of procs per app then this processor
    // won't have an app at all
    _my_num_apps = 0;
    _has_an_app = false;
  }
  else if ((unsigned int)my_app >=
           _total_num_apps - 1) // The last app will gain any left-over procs
  {
    my_app = _total_num_apps - 1;
    //    procs_for_my_app += _orig_num_procs % _total_num_apps;
    _first_local_app = my_app;
    _my_num_apps = 1;
  }
  else
  {
    _first_local_app = my_app;
    _my_num_apps = 1;
  }

  if (_has_an_app)
  {
    _communicator.split(_first_local_app, rank, _my_communicator);

    ierr = MPI_Comm_rank(_my_comm, &_my_rank);
    mooseCheckMPIErr(ierr);
  }
  else
  {
    _communicator.split(MPI_UNDEFINED, rank, _my_communicator);

    _my_rank = 0;
  }
}

comm()

MPI_Comm& MultiApp::comm ( )

inline

Get the MPI communicator this MultiApp is operating on.

Returns

The MPI comm for this MultiApp

Definition at line 270 of file MultiApp.h.

Referenced by MultiAppDTKUserObjectEvaluator::evaluate().

{ return _my_comm; }

createApp()

void MultiApp::createApp ( unsigned int  i, Real  start_time  )

protected

Helper function for creating an App instance.

Parameters

i	The local app number to create.
start_time	The initial time for the App

Definition at line 596 of file MultiApp.C.

Referenced by initialSetup(), and resetApp().

{
  // Define the app name
  std::ostringstream multiapp_name;
  std::string full_name;
  multiapp_name << name() << std::setw(std::ceil(std::log10(_total_num_apps)))
                << std::setprecision(0) << std::setfill('0') << std::right << _first_local_app + i;

  // Only add parent name if it the parent is not the main app
  if (_app.multiAppLevel() > 0)
    full_name = _app.name() + "_" + multiapp_name.str();
  else
    full_name = multiapp_name.str();

  InputParameters app_params = AppFactory::instance().getValidParams(_app_type);
  app_params.set<FEProblemBase *>("_parent_fep") = &_fe_problem;
  app_params.set<std::shared_ptr<CommandLine>>("_command_line") = _app.commandLine();

  // Single set of "cli_args" to be applied to all sub apps
  if (_cli_args.size() == 1)
  {
    for (const std::string & str : MooseUtils::split(_cli_args[0], ";"))
    {
      std::ostringstream oss;
      oss << full_name << ":" << str;
      app_params.get<std::shared_ptr<CommandLine>>("_command_line")->addArgument(oss.str());
    }
  }

  // Unique set of "cli_args" to be applied to each sub apps
  else if (_cli_args.size() > 1)
  {
    for (const std::string & str : MooseUtils::split(_cli_args[i + _first_local_app], ";"))
    {
      std::ostringstream oss;
      oss << full_name << ":" << str;
      app_params.get<std::shared_ptr<CommandLine>>("_command_line")->addArgument(oss.str());
    }
  }

  _console << COLOR_CYAN << "Creating MultiApp " << name() << " of type " << _app_type
           << " of level " << _app.multiAppLevel() + 1 << " and number " << _first_local_app + i
           << ":" << COLOR_DEFAULT << std::endl;
  app_params.set<unsigned int>("_multiapp_level") = _app.multiAppLevel() + 1;
  app_params.set<unsigned int>("_multiapp_number") = _first_local_app + i;
  _apps[i] = AppFactory::instance().createShared(_app_type, full_name, app_params, _my_comm);
  auto & app = _apps[i];

  std::string input_file = "";
  if (_input_files.size() == 1) // If only one input file was provided, use it for all the solves
    input_file = _input_files[0];
  else
    input_file = _input_files[_first_local_app + i];

  std::ostringstream output_base;

  // Create an output base by taking the output base of the master problem and appending
  // the name of the multiapp + a number to it
  if (!_app.getOutputFileBase().empty())
    output_base << _app.getOutputFileBase() + "_";
  else
  {
    std::string base = _app.getFileName();
    size_t pos = base.find_last_of('.');
    output_base << base.substr(0, pos) + "_out_";
  }

  // Append the sub app name to the output file base
  output_base << multiapp_name.str();
  app->setGlobalTimeOffset(start_time);
  app->setInputFileName(input_file);
  app->setOutputFileBase(output_base.str());
  app->setOutputFileNumbers(_app.getOutputWarehouse().getFileNumbers());
  app->setRestart(_app.isRestarting());
  app->setRecover(_app.isRecovering());

  // This means we have a backup of this app that we need to give to it
  // Note: This won't do the restoration immediately.  The Backup
  // will be cached by the MooseApp object so that it can be used
  // during FEProblemBase::initialSetup() during runInputFile()
  if (_app.isRestarting() || _app.isRecovering())
    app->setBackupObject(_backups[i]);

  if (_use_positions && getParam<bool>("output_in_position"))
    app->setOutputPosition(_app.getOutputPosition() + _positions[_first_local_app + i]);

  // Update the MultiApp level for the app that was just created
  app->setupOptions();
  preRunInputFile();
  app->runInputFile();

  auto & picard_solve = _apps[i]->getExecutioner()->picardSolve();
  picard_solve.setMultiAppRelaxationFactor(getParam<Real>("relaxation_factor"));
  picard_solve.setMultiAppRelaxationVariables(
      getParam<std::vector<std::string>>("relaxed_variables"));
  if (getParam<Real>("relaxation_factor") != 1.0)
  {
    // Store a copy of the previous solution here
    FEProblemBase & fe_problem_base = _apps[i]->getExecutioner()->feProblem();
    fe_problem_base.getNonlinearSystemBase().addVector("self_relax_previous", false, PARALLEL);
  }
}

declareRecoverableData() [1/2]

template<typename T >

T & Restartable::declareRecoverableData ( std::string  data_name )

protectedinherited

Declare a piece of data as "recoverable".

This means that in the event of a recovery this piece of data will be restored back to its previous value.

Note - this data will NOT be restored on Restart!

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name

The name of the data (usually just use the same name as the member variable)

Definition at line 271 of file Restartable.h.

{
  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;

  registerRecoverableDataOnApp(full_name);

  return declareRestartableDataWithContext<T>(data_name, nullptr);
}

declareRecoverableData() [2/2]

template<typename T >

T & Restartable::declareRecoverableData ( std::string  data_name, const T &  init_value  )

protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

Note - this data will NOT be restored on Restart!

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
init_value	The initial value of the data

Definition at line 282 of file Restartable.h.

{
  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;

  registerRecoverableDataOnApp(full_name);

  return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
}

declareRestartableData() [1/2]

template<typename T >

T & Restartable::declareRestartableData ( std::string  data_name )

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name

The name of the data (usually just use the same name as the member variable)

Definition at line 204 of file Restartable.h.

{
  return declareRestartableDataWithContext<T>(data_name, nullptr);
}

declareRestartableData() [2/2]

template<typename T >

T & Restartable::declareRestartableData ( std::string  data_name, const T &  init_value  )

protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
init_value	The initial value of the data

Definition at line 211 of file Restartable.h.

{
  return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
}

declareRestartableDataWithContext() [1/2]

template<typename T >

T & Restartable::declareRestartableDataWithContext ( std::string  data_name, void *  context  )

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
context	Context pointer that will be passed to the load and store functions

Definition at line 218 of file Restartable.h.

{
  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
  auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
  T & restartable_data_ref = data_ptr->get();

  registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid);

  return restartable_data_ref;
}

declareRestartableDataWithContext() [2/2]

template<typename T >

T & Restartable::declareRestartableDataWithContext ( std::string  data_name, const T &  init_value, void *  context  )

protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
init_value	The initial value of the data
context	Context pointer that will be passed to the load and store functions

Definition at line 231 of file Restartable.h.

{
  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
  auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
  data_ptr->set() = init_value;

  T & restartable_data_ref = data_ptr->get();
  registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid);

  return restartable_data_ref;
}

declareRestartableDataWithObjectName()

template<typename T >

T & Restartable::declareRestartableDataWithObjectName ( std::string  data_name, std::string  object_name  )

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
object_name	A supplied name for the object that is declaring this data.

Definition at line 247 of file Restartable.h.

{
  return declareRestartableDataWithObjectNameWithContext<T>(data_name, object_name, nullptr);
}

declareRestartableDataWithObjectNameWithContext()

template<typename T >

T & Restartable::declareRestartableDataWithObjectNameWithContext ( std::string  data_name, std::string  object_name, void *  context  )

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
object_name	A supplied name for the object that is declaring this data.
context	Context pointer that will be passed to the load and store functions

Definition at line 254 of file Restartable.h.

{
  std::string old_name = _restartable_name;

  _restartable_name = object_name;

  T & value = declareRestartableDataWithContext<T>(data_name, context);

  _restartable_name = old_name;

  return value;
}

enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 96 of file MooseObject.h.

Referenced by EigenKernel::enabled().

{ return _enabled; }

execBitFlags()

ExecFlagType SetupInterface::execBitFlags ( ) const

inherited

(DEPRECATED) Build and return the execution flags as a bitfield TODO: ExecFlagType

Definition at line 85 of file SetupInterface.C.

{
  // TODO: ExecFlagType
  mooseDeprecated("The execBitFlags method is being removed because MOOSE was updated to use a "
                  "ExecFlagEnum for execute flags. This method maintains the behavior of the "
                  "original method but the use of this method should be removed from your "
                  "application. The ExecFlagEnum should be inspected directly via the "
                  "getExecuteOnEnum() method.");

  unsigned int exec_bit_field = EXEC_NONE;
  for (const auto & flag : _exec_flags)
    exec_bit_field |= flag.id();
  return ExecFlagType("deprecated", exec_bit_field);
}

execFlags()

const std::vector< ExecFlagType > & SetupInterface::execFlags ( ) const

virtualinherited

(DEPRECATED) Get the execution flag for the object TODO: ExecFlagType

Reimplemented in MultiAppTransfer.

Definition at line 73 of file SetupInterface.C.

{
  // TODO: ExecFlagType
  mooseDeprecated("The execFlags() method is being removed because MOOSE has been updated to use a "
                  "ExecFlagEnum for execute flags. The current flags should be retrieved from "
                  "the \"exeucte_on\" parameters of your object or by using the \"_execute_enum\" "
                  "reference to the parameter or the getExecuteOnEnum() method.");

  return _exec_flags;
}

fillPositions()

void MultiApp::fillPositions ( )

protectedvirtual

must fill in _positions with the positions of the sub-aps

Reimplemented in CentroidMultiApp.

Definition at line 252 of file MultiApp.C.

Referenced by setupPositions().

{
  if (_move_apps.size() != _move_positions.size())
    mooseError("The number of apps to move and the positions to move them to must be the same for "
               "MultiApp ",
               _name);

  if (isParamValid("positions") && isParamValid("positions_file"))
    mooseError(
        "Both 'positions' and 'positions_file' cannot be specified simultaneously in MultiApp ",
        name());

  if (isParamValid("positions"))
  {
    _positions = getParam<std::vector<Point>>("positions");

    if (_positions.size() < _input_files.size())
      mooseError("Not enough positions for the number of input files provided in MultiApp ",
                 name());
  }
  else if (isParamValid("positions_file"))
  {
    std::vector<FileName> positions_files = getParam<std::vector<FileName>>("positions_file");
    std::vector<FileName> input_files = getParam<std::vector<FileName>>("input_files");

    if (input_files.size() != 1 && positions_files.size() != input_files.size())
      mooseError("Number of input_files for MultiApp ",
                 name(),
                 " must either be only one or match the number of positions_file files");

    // Clear out the _input_files because we're going to rebuild it
    if (input_files.size() != 1)
      _input_files.clear();

    for (unsigned int p_file_it = 0; p_file_it < positions_files.size(); p_file_it++)
    {
      std::string positions_file = positions_files[p_file_it];

      std::vector<Real> positions_vec;

      // Read the file on the root processor then broadcast it
      if (processor_id() == 0)
      {
        MooseUtils::checkFileReadable(positions_file);

        std::ifstream is(positions_file.c_str());
        std::istream_iterator<Real> begin(is), end;
        positions_vec.insert(positions_vec.begin(), begin, end);

        if (positions_vec.size() % LIBMESH_DIM != 0)
          mooseError("Number of entries in 'positions_file' ",
                     positions_file,
                     " must be divisible by ",
                     LIBMESH_DIM,
                     " in MultiApp ",
                     name());
      }

      // Bradcast the vector to all processors
      std::size_t num_positions = positions_vec.size();
      _communicator.broadcast(num_positions);
      positions_vec.resize(num_positions);
      _communicator.broadcast(positions_vec);

      for (unsigned int i = 0; i < positions_vec.size(); i += LIBMESH_DIM)
      {
        if (input_files.size() != 1)
          _input_files.push_back(input_files[p_file_it]);

        Point position;

        // This is here so it will theoretically work with LIBMESH_DIM=1 or 2. That is completely
        // untested!
        for (unsigned int j = 0; j < LIBMESH_DIM; j++)
          position(j) = positions_vec[i + j];

        _positions.push_back(position);
      }
    }
  }
  else
  {
    _positions = {Point()};

    if (_positions.size() < _input_files.size())
      mooseError("Not enough positions for the number of input files provided in MultiApp ",
                 name());
  }

  mooseAssert(_input_files.size() == 1 || _positions.size() == _input_files.size(),
              "Number of positions and input files are not the same!");
}

finalize()

void MultiApp::finalize ( )

virtual

Method called towards the end of the simulation to execute on final.

Definition at line 375 of file MultiApp.C.

{
  for (const auto & app_ptr : _apps)
  {
    auto * executioner = app_ptr->getExecutioner();
    mooseAssert(executioner, "Executioner is nullptr");

    executioner->feProblem().execute(EXEC_FINAL);
    executioner->feProblem().outputStep(EXEC_FINAL);
  }
}

finishStep()

virtual void MultiApp::finishStep ( )

inlinevirtual

Calls multi-apps executioners' endStep and postStep methods which creates output and advances time (not the time step; see incrementTStep()) among other things.

This method is only called for Picard calculations because for loosely coupled calculations the executioners' endStep and postStep methods are called from solveStep().

Reimplemented in TransientMultiApp.

Definition at line 117 of file MultiApp.h.

{}

firstLocalApp()

unsigned int MultiApp::firstLocalApp ( )

inline

Returns

The global number of the first app on the local processor.

Definition at line 211 of file MultiApp.h.

Referenced by MultiAppDTKUserObjectEvaluator::createSourceGeometry().

{ return _first_local_app; }

getBoundingBox()

BoundingBox MultiApp::getBoundingBox ( unsigned int  app, bool  displaced_mesh  )

virtual

Get the BoundingBox for the mesh associated with app The bounding box will be shifted to be in the correct position within the master domain.

If the MultiApp is in an RZ coordinate system the box will be the size it would be if the geometry were 3D (ie if you were to revolve the geometry around the axis to create the 3D geometry).

Parameters

app	The global app number you want to get the bounding box for
displaced_mesh	True if the bounding box is retrieved for the displaced mesh, other false

Definition at line 424 of file MultiApp.C.

Referenced by MultiAppDTKUserObjectEvaluator::createSourceGeometry().

{
  if (!_has_an_app)
    mooseError("No app for ", name(), " on processor ", _orig_rank);

  unsigned int local_app = globalAppToLocal(app);
  FEProblemBase & fe_problem_base = _apps[local_app]->getExecutioner()->feProblem();
  MooseMesh & mesh = (displaced_mesh && fe_problem_base.getDisplacedProblem().get() != NULL)
                         ? fe_problem_base.getDisplacedProblem()->mesh()
                         : fe_problem_base.mesh();

  {
    Moose::ScopedCommSwapper swapper(_my_comm);
    if (displaced_mesh)
      _bounding_box[local_app] = MeshTools::create_bounding_box(mesh);
    else
    {
      if (!_has_bounding_box[local_app])
      {
        _bounding_box[local_app] = MeshTools::create_bounding_box(mesh);
        _has_bounding_box[local_app] = true;
      }
    }
  }
  BoundingBox bbox = _bounding_box[local_app];

  Point min = bbox.min();
  min -= _bounding_box_padding;
  Point max = bbox.max();
  max += _bounding_box_padding;

  Point inflation_amount = (max - min) * _inflation;

  Point inflated_min = min - inflation_amount;
  Point inflated_max = max + inflation_amount;

  // This is where the app is located.  We need to shift by this amount.
  Point p = position(app);

  Point shifted_min = inflated_min;
  Point shifted_max = inflated_max;

  // If the problem is RZ then we're going to invent a box that would cover the whole "3D" app
  // FIXME: Assuming all subdomains are the same coordinate system type!
  if (fe_problem_base.getCoordSystem(*(mesh.meshSubdomains().begin())) == Moose::COORD_RZ)
  {
    shifted_min(0) = -inflated_max(0);
    shifted_min(1) = inflated_min(1);
    shifted_min(2) = -inflated_max(0);

    shifted_max(0) = inflated_max(0);
    shifted_max(1) = inflated_max(1);
    shifted_max(2) = inflated_max(0);
  }

  // Shift them to the position they're supposed to be
  shifted_min += p;
  shifted_max += p;

  return BoundingBox(shifted_min, shifted_max);
}

getCheckedPointerParam()

template<typename T >

T MooseObject::getCheckedPointerParam ( const std::string &  name, const std::string &  error_string = ""  ) const

inlineinherited

Verifies that the requested parameter exists and is not NULL and returns it to the caller.

The template parameter must be a pointer or an error will be thrown.

Definition at line 77 of file MooseObject.h.

  {
    return parameters().getCheckedPointerParam<T>(name, error_string);
  }

getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 67 of file SetupInterface.C.

Referenced by ExecuteMooseObjectWarehouse< Transfer >::addObjectMask(), EigenExecutionerBase::init(), AttribExecOns::initFrom(), and MultiAppTransfer::MultiAppTransfer().

{
  return _execute_enum;
}

getExecuteOptions()

ExecFlagEnum SetupInterface::getExecuteOptions ( )

staticinherited

(DEPRECATED) Returns the available options for the 'execute_on' input parameters TODO: ExecFlagType

Returns

A MooseEnum with the available 'execute_on' options, the default is 'residual'

Definition at line 101 of file SetupInterface.C.

{
  // TODO: ExecFlagType
  ::mooseDeprecated("The 'getExecuteOptions' was replaced by the ExecFlagEnum class because MOOSE "
                    "was updated to use this for the execute flags and the new function provides "
                    "additional arguments for modification of the enum.");
  return MooseUtils::getDefaultExecFlagEnum();
}

getExecutioner()

Executioner * MultiApp::getExecutioner ( unsigned int  app )

virtual

Parameters

app	The global app number to get the Executioner for

Returns

The Executioner associated with that App.

Definition at line 366 of file MultiApp.C.

Referenced by TransientMultiApp::restore().

{
  if (!_has_an_app)
    mooseError("No app for ", name(), " on processor ", _orig_rank);

  return _apps[globalAppToLocal(app)]->getExecutioner();
}

getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const

inlineinherited

Get the MooseApp this object is associated with.

Definition at line 91 of file MooseObject.h.

Referenced by RestartableDataIO::createBackup(), RestartableDataIO::deserializeRestartableData(), ConsoleUtils::outputMeshInformation(), Resurrector::restartRestartableData(), and RestartableDataIO::restoreBackup().

{ return _app; }

getParam()

template<typename T >

const T & MooseObject::getParam ( const std::string &  name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns

The value of the parameter

Definition at line 188 of file MooseObject.h.

Referenced by FEProblemBase::addMaterialHelper(), ConstraintWarehouse::addObject(), BicubicSplineFunction::BicubicSplineFunction(), Piecewise::buildFromXandY(), createApp(), DerivativeParsedMaterial::DerivativeParsedMaterial(), EigenKernel::EigenKernel(), FEProblemBase::FEProblemBase(), FieldSplitPreconditioner::FieldSplitPreconditioner(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), SideSetsBetweenSubdomainsGenerator::generate(), ExtraNodesetGenerator::generate(), MeshExtruderGenerator::generate(), SideSetsAroundSubdomainGenerator::generate(), GenericConstantRankTwoTensor::GenericConstantRankTwoTensor(), GhostingUserObject::GhostingUserObject(), TimeSequenceStepper::init(), AttribThread::initFrom(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), Console::initialSetup(), AdvancedOutput::initialSetup(), SideSetsBetweenSubdomains::modify(), AddExtraNodeset::modify(), MeshExtruder::modify(), SideSetsAroundSubdomain::modify(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedMaterial::ParsedMaterial(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), SingleMatrixPreconditioner::SingleMatrixPreconditioner(), TimePeriod::TimePeriod(), and VectorOfPostprocessors::VectorOfPostprocessors().

{
  return InputParameters::getParamHelper(name, _pars, static_cast<T *>(0));
}

globalAppToLocal()

unsigned int MultiApp::globalAppToLocal ( unsigned int  global_app )

protected

Map a global App number to the local number.

Note: This will error if given a global number that doesn't map to a local number.

Parameters

global_app

The global app number.

Returns

The local app number.

Definition at line 796 of file MultiApp.C.

Referenced by appProblem(), appProblemBase(), getBoundingBox(), getExecutioner(), moveApp(), TransientMultiApp::resetApp(), and resetApp().

{
  if (global_app >= _first_local_app && global_app <= _first_local_app + (_my_num_apps - 1))
    return global_app - _first_local_app;

  _console << _first_local_app << " " << global_app << '\n';
  mooseError("Invalid global_app!");
}

hasApp()

bool MultiApp::hasApp ( )

inline

Whether or not this MultiApp has an app on this processor.

Definition at line 216 of file MultiApp.h.

{ return _has_an_app; }

hasLocalApp()

bool MultiApp::hasLocalApp

(

unsigned int

global_app

)

Whether or not the given global app number is on this processor.

Parameters

global_app

The global app number in question

Returns

True if the global app is on this processor

Definition at line 535 of file MultiApp.C.

Referenced by moveApp(), TransientMultiApp::resetApp(), and resetApp().

{
  if (_has_an_app && global_app >= _first_local_app &&
      global_app <= _first_local_app + (_my_num_apps - 1))
    return true;

  return false;
}

incrementTStep()

virtual void MultiApp::incrementTStep ( Real  )

inlinevirtual

Advances the multi-apps time step which is important for dt selection.

(Note this does not advance the time. That is done in Transient::endStep, which is called either directly from solveStep() for loose coupling cases or through finishStep() for Picard coupling cases)

Reimplemented in TransientMultiApp.

Definition at line 109 of file MultiApp.h.

{}

init()

void MultiApp::init ( unsigned int  num )

protected

Initialize the MultiApp by creating the provided number of apps.

This is called in the constructor, by default it utilizes the 'positions' input parameters.

Definition at line 206 of file MultiApp.C.

Referenced by setupPositions().

{
  _total_num_apps = num;
  buildComm();
  _backups.reserve(_my_num_apps);
  for (unsigned int i = 0; i < _my_num_apps; i++)
    _backups.emplace_back(std::make_shared<Backup>());

  _has_bounding_box.resize(_my_num_apps, false);
  _bounding_box.resize(_my_num_apps);

  if ((_cli_args.size() > 1) && (_total_num_apps != _cli_args.size()))
    paramError("cli_args",
               "The number of items supplied must be 1 or equal to the number of sub apps.");
}

initialSetup()

void MultiApp::initialSetup ( )

overridevirtual

Gets called at the beginning of the simulation before this object is asked to do its job.

Reimplemented from SetupInterface.

Reimplemented in TransientMultiApp, and FullSolveMultiApp.

Definition at line 233 of file MultiApp.C.

Referenced by FullSolveMultiApp::initialSetup(), and TransientMultiApp::initialSetup().

{
  if (!_has_an_app)
    return;

  Moose::ScopedCommSwapper swapper(_my_comm);

  _apps.resize(_my_num_apps);

  // If the user provided an unregistered app type, see if we can load it dynamically
  if (!AppFactory::instance().isRegistered(_app_type))
    _app.dynamicAppRegistration(
        _app_type, getParam<std::string>("library_path"), getParam<std::string>("library_name"));

  for (unsigned int i = 0; i < _my_num_apps; i++)
    createApp(i, _global_time_offset);
}

isParamValid()

bool MooseObject::isParamValid ( const std::string &  name ) const

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 86 of file MooseObject.h.

Referenced by AdvancedOutput::AdvancedOutput(), BicubicSplineFunction::BicubicSplineFunction(), Piecewise::buildFromFile(), Piecewise::buildFromXandY(), DistributedGeneratedMesh::buildMesh(), GeneratedMesh::buildMesh(), CartesianMeshGenerator::CartesianMeshGenerator(), LibmeshPartitioner::clone(), OversampleOutput::cloneMesh(), CSVReader::CSVReader(), MultiAppNearestNodeTransfer::execute(), Exodus::Exodus(), FEProblemBase::FEProblemBase(), FileOutput::FileOutput(), fillPositions(), FunctionDT::FunctionDT(), RenameBoundaryGenerator::generate(), BreakBoundaryOnSubdomainGenerator::generate(), ElementSubdomainIDGenerator::generate(), ExtraNodesetGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), MeshSideSetGenerator::generate(), RenameBlockGenerator::generate(), GeneratedMeshGenerator::generate(), ParsedSubdomainMeshGenerator::generate(), MeshExtruderGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), MultiAppNearestNodeTransfer::getLocalEntities(), MeshGenerator::getMesh(), MultiAppNearestNodeTransfer::getNearestNode(), IterationAdaptiveDT::init(), EigenExecutionerBase::init(), MooseMesh::init(), AdvancedOutput::initExecutionTypes(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), SolutionAux::initialSetup(), MooseParsedVectorFunction::initialSetup(), Console::initialSetup(), Receiver::initialSetup(), SolutionFunction::initialSetup(), MooseParsedGradFunction::initialSetup(), MooseParsedFunction::initialSetup(), AdvancedOutput::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), IterationAdaptiveDT::IterationAdaptiveDT(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), BreakBoundaryOnSubdomain::modify(), MeshExtruder::modify(), MeshSideSet::modify(), LowerDBlockFromSideset::modify(), AssignElementSubdomainID::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), SubdomainBoundingBox::modify(), MooseMesh::MooseMesh(), EigenExecutionerBase::normalizeSolution(), Output::Output(), PetscOutput::PetscOutput(), Piecewise::Piecewise(), SolutionUserObject::readExodusII(), RenameBlock::RenameBlock(), RenameBlockGenerator::RenameBlockGenerator(), RenameBoundaryGenerator::RenameBoundaryGenerator(), SolutionUserObject::SolutionUserObject(), and TimePeriod::TimePeriod().

{ return _pars.isParamValid(name); }

isRootProcessor()

bool MultiApp::isRootProcessor ( )

inline

Whether or not this processor is the "root" processor for the sub communicator.

The "root" processor has rank 0 in the sub communicator

Definition at line 276 of file MultiApp.h.

{ return _my_rank == 0; }

jacobianSetup()

void SetupInterface::jacobianSetup ( )

virtualinherited

Gets called just before the Jacobian is computed and before this object is asked to do its job.

Reimplemented in EqualValueEmbeddedConstraint.

Definition at line 52 of file SetupInterface.C.

{
}

localApp()

MooseApp * MultiApp::localApp

(

unsigned int

local_app

)

Get the local MooseApp object.

Parameters

local_app

The local app number

Definition at line 545 of file MultiApp.C.

{
  mooseAssert(local_app < _apps.size(), "Index out of range: " + Moose::stringify(local_app));
  return _apps[local_app].get();
}

mooseDeprecated()

template<typename... Args>

void MooseObject::mooseDeprecated ( Args &&...  args ) const

inlineinherited

Definition at line 158 of file MooseObject.h.

Referenced by FEProblemBase::advanceMultiApps(), appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), FEProblemBase::computeResidual(), Material::declarePropertyOld(), Material::declarePropertyOlder(), MooseMesh::elem(), MultiAppTransfer::execFlags(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), FEProblemBase::getUserObjects(), FEProblemBase::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValueOld(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), PercentChangePostprocessor::PercentChangePostprocessor(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

  {
    moose::internal::mooseDeprecatedStream(_console, false, std::forward<Args>(args)...);
  }

mooseError()

template<typename... Args>

void MooseObject::mooseError ( Args &&...  args ) const

inlineinherited

Definition at line 144 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), PetscExternalPartitioner::_do_partition(), FEProblemBase::addConstraint(), FEProblemBase::addInitialCondition(), FEProblem::addLineSearch(), FEProblemBase::addLineSearch(), FEProblemBase::addOutput(), DiracKernel::addPointWithValidId(), FEProblemBase::addPostprocessor(), MooseMesh::addQuadratureNode(), FEProblemBase::addVectorPostprocessor(), ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), Output::advancedExecuteOn(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), appPostprocessorValue(), appProblem(), appProblemBase(), appUserObjectBase(), DerivativeParsedMaterialHelper::assembleDerivatives(), Function::average(), Axisymmetric2D3DSolutionFunction::Axisymmetric2D3DSolutionFunction(), BicubicSplineFunction::BicubicSplineFunction(), BoundingValueElementDamper::BoundingValueElementDamper(), BoundingValueNodalDamper::BoundingValueNodalDamper(), BoundsAux::BoundsAux(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), MooseMesh::buildCoarseningMap(), Piecewise::buildFromFile(), Piecewise::buildFromXandY(), Piecewise::buildFromXY(), TiledMesh::buildMesh(), FileMesh::buildMesh(), SpiralAnnularMesh::buildMesh(), DistributedGeneratedMesh::buildMesh(), GeneratedMesh::buildMesh(), ImageMeshGenerator::buildMesh3D(), ImageMesh::buildMesh3D(), MooseMesh::buildMeshBaseObject(), MooseMesh::buildRefinementMap(), MooseMesh::buildSideList(), CartesianMeshGenerator::CartesianMeshGenerator(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), EigenExecutionerBase::chebyshev(), SubProblem::checkBlockMatProps(), SubProblem::checkBoundaryMatProps(), FEProblemBase::checkCoordinateSystems(), FEProblemBase::checkDependMaterialsHelper(), FEProblemBase::checkDisplacementOrders(), Material::checkExecutionStage(), BreakMeshByBlockBase::checkInputParameter(), Steady::checkIntegrity(), EigenExecutionerBase::checkIntegrity(), ActuallyExplicitEuler::checkLinearConvergence(), FEProblemBase::checkProblemIntegrity(), Material::checkStatefulSanity(), FEProblemBase::checkUserObjects(), LibmeshPartitioner::clone(), MooseMesh::clone(), ComparisonPostprocessor::comparisonIsTrue(), CompositeFunction::CompositeFunction(), ElementLpNormAux::compute(), ElementH1ErrorFunctionAux::compute(), NodalPatchRecovery::compute(), KernelBase::computeADOffDiagJacobian(), InterfaceKernel::computeElemNeighJacobian(), TimeSequenceStepperBase::computeFailedDT(), IterationAdaptiveDT::computeFailedDT(), TimeStepper::computeFailedDT(), HistogramVectorPostprocessor::computeHistogram(), EqualValueEmbeddedConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), KernelValue::computeQpResidual(), FEProblemBase::computeResidualInternal(), FEProblemBase::computeResidualTag(), FEProblemBase::computeResidualType(), StatisticsVectorPostprocessor::computeStatValue(), Material::computeSubdomainProperties(), ExplicitEuler::computeTimeDerivatives(), ImplicitEuler::computeTimeDerivatives(), BDF2::computeTimeDerivatives(), NewmarkBeta::computeTimeDerivatives(), CrankNicolson::computeTimeDerivatives(), ActuallyExplicitEuler::computeTimeDerivatives(), LStableDirk2::computeTimeDerivatives(), LStableDirk3::computeTimeDerivatives(), ImplicitMidpoint::computeTimeDerivatives(), ExplicitTVDRK2::computeTimeDerivatives(), AStableDirk4::computeTimeDerivatives(), LStableDirk4::computeTimeDerivatives(), ExplicitRK2::computeTimeDerivatives(), PenetrationAux::computeValue(), ConcentricCircleMesh::ConcentricCircleMesh(), TimeStepper::constrainStep(), CoupledForce::CoupledForce(), DebugResidualAux::DebugResidualAux(), FunctorRelationshipManager::delete_remote_elements(), BicubicSplineFunction::derivative(), DerivativeSumMaterial::DerivativeSumMaterial(), DGKernelBase::DGKernelBase(), FunctorRelationshipManager::dofmap_reinit(), FEProblemBase::duplicateVariableCheck(), EigenProblem::EigenProblem(), Eigenvalues::Eigenvalues(), ElementalVariableValue::ElementalVariableValue(), ElementQualityAux::ElementQualityAux(), MooseMesh::errorIfDistributedMesh(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), MultiAppPostprocessorTransfer::execute(), DiscreteElementUserObject::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), ElementQualityChecker::execute(), NodalValueSampler::execute(), InterfaceQpValueUserObject::execute(), PointValue::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppInterpolationTransfer::execute(), FindValueOnLine::execute(), MultiAppNearestNodeTransfer::execute(), TimeExtremeValue::execute(), VectorPostprocessorComparison::execute(), LeastSquaresFit::execute(), LeastSquaresFitHistory::execute(), FEProblemBase::executeControls(), MultiAppVectorPostprocessorTransfer::executeFromMultiapp(), MultiAppVectorPostprocessorTransfer::executeToMultiapp(), Exodus::Exodus(), FileOutput::FileOutput(), CentroidMultiApp::fillPositions(), fillPositions(), VerifyElementUniqueID::finalize(), VerifyNodalUniqueID::finalize(), DiscreteElementUserObject::finalize(), ElementQualityChecker::finalize(), MemoryUsage::finalize(), PointSamplerBase::finalize(), Transfer::find_sys(), BreakMeshByBlockBase::findFreeBoundaryId(), BreakMeshByBlockGeneratorBase::findFreeBoundaryId(), FunctionDT::FunctionDT(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GapValueAux::GapValueAux(), ElementSubdomainIDGenerator::generate(), ExtraNodesetGenerator::generate(), RenameBlockGenerator::generate(), RenameBoundaryGenerator::generate(), GeneratedMeshGenerator::generate(), MeshExtruderGenerator::generate(), SideSetsFromBoundingBoxGenerator::generate(), StackGenerator::generate(), SpiralAnnularMeshGenerator::generate(), PatternedMeshGenerator::generate(), BoundingBoxNodeSetGenerator::generate(), GeneratedMesh::GeneratedMesh(), GeneratedMeshGenerator::GeneratedMeshGenerator(), RandomICBase::generateRandom(), GenericConstantMaterial::GenericConstantMaterial(), GenericFunctionMaterial::GenericFunctionMaterial(), MooseMesh::getBoundaryID(), getBoundingBox(), MooseMesh::getCoarseningMap(), Control::getControllableParameterByName(), FEProblemBase::getCoordSystem(), PiecewiseConstant::getDirection(), FEProblemBase::getDistribution(), GhostingUserObject::getElementalValue(), ElementGenerator::getElemType(), getExecutioner(), FEProblemBase::getFunction(), SolutionUserObject::getLocalVarIndex(), SubProblem::getMatrixTagID(), AnnularMesh::getMaxInDimension(), DistributedGeneratedMesh::getMaxInDimension(), GeneratedMesh::getMaxInDimension(), FEProblemBase::getMaxQps(), FEProblemBase::getMaxShapeFunctions(), AnnularMesh::getMinInDimension(), DistributedGeneratedMesh::getMinInDimension(), GeneratedMesh::getMinInDimension(), MooseMesh::getMortarInterface(), MooseMesh::getMortarInterfaceByName(), MooseMesh::getNodeBlockIds(), MooseMesh::getNodeList(), FEProblemBase::getNonlinearSystem(), MooseMesh::getPairedBoundaryMapping(), ImageMeshGenerator::GetPixelInfo(), ImageMesh::GetPixelInfo(), InterfaceQpValueUserObject::getQpValue(), MaterialStdVectorAux::getRealValue(), MooseMesh::getRefinementMap(), FEProblemBase::getSampler(), DisplacedProblem::getScalarVariable(), FEProblemBase::getScalarVariable(), DisplacedProblem::getStandardVariable(), FEProblemBase::getStandardVariable(), MooseMesh::getSubdomainBoundaryIds(), MooseMesh::getSubdomainID(), DisplacedProblem::getSystem(), FEProblemBase::getSystem(), FEProblemBase::getUserObject(), FEProblemBase::getUserObjectBase(), PerformanceData::getValue(), Residual::getValue(), PerfGraphData::getValue(), LineValueSampler::getValue(), FindValueOnLine::getValueAtPoint(), SubProblem::getVariableHelper(), SubProblem::getVectorTagID(), DisplacedProblem::getVectorVariable(), FEProblemBase::getVectorVariable(), GhostingAux::GhostingAux(), globalAppToLocal(), MooseParsedVectorFunction::gradient(), AdvancedOutput::hasOutputHelper(), CrankNicolson::init(), CSVTimeSequenceStepper::init(), IterationAdaptiveDT::init(), EigenExecutionerBase::init(), Transient::init(), MooseMesh::init(), FEProblemBase::init(), NumPicardIterations::initialize(), FullSolveMultiApp::initialSetup(), PiecewiseBase::initialSetup(), SolutionAux::initialSetup(), Axisymmetric2D3DSolutionFunction::initialSetup(), Exodus::initialSetup(), SolutionFunction::initialSetup(), SolutionUserObject::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), AdvancedOutput::initShowHideLists(), Material::initStatefulProperties(), Function::integral(), InterfaceKernel::InterfaceKernel(), InterfaceTimeKernel::InterfaceTimeKernel(), EigenExecutionerBase::inversePowerIteration(), InversePowerMethod::InversePowerMethod(), IterationAdaptiveDT::IterationAdaptiveDT(), LayeredSideIntegral::LayeredSideIntegral(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), LinearCombinationFunction::LinearCombinationFunction(), LinearCombinationPostprocessor::LinearCombinationPostprocessor(), LinearNodalConstraint::LinearNodalConstraint(), LineMaterialSamplerBase< Real >::LineMaterialSamplerBase(), LineSearch::lineSearch(), LineValueSampler::LineValueSampler(), MaterialRealTensorValueAux::MaterialRealTensorValueAux(), MaterialRealVectorValueAux::MaterialRealVectorValueAux(), MaterialStdVectorRealGradientAux::MaterialStdVectorRealGradientAux(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), Distribution::median(), FunctorRelationshipManager::mesh_reinit(), SubProblem::meshChanged(), MeshExtruder::MeshExtruder(), MeshExtruderGenerator::MeshExtruderGenerator(), MeshSideSetGenerator::MeshSideSetGenerator(), SideSetsFromPoints::modify(), SideSetsFromNormals::modify(), AddExtraNodeset::modify(), MeshExtruder::modify(), BreakMeshByBlockBase::modify(), AssignElementSubdomainID::modify(), SmoothMesh::modify(), ElementDeleterBase::modify(), AddAllSideSetsByNormals::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), ImageSubdomain::modify(), OrientedSubdomainBoundingBox::modify(), BoundingBoxNodeSet::modify(), SubdomainBoundingBox::modify(), AddSideSetsFromBoundingBox::modify(), MooseGhostPointNeighbors::MooseGhostPointNeighbors(), MooseMesh::MooseMesh(), MultiAppMeshFunctionTransfer::MultiAppMeshFunctionTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), NearestNodeDistanceAux::NearestNodeDistanceAux(), NearestNodeValueAux::NearestNodeValueAux(), RenameBlockGenerator::newBlockID(), RenameBlock::newBlockID(), RenameBlockGenerator::newBlockName(), RenameBlock::newBlockName(), NewmarkBeta::NewmarkBeta(), NodalConstraint::NodalConstraint(), NodalScalarKernel::NodalScalarKernel(), NodalVariableValue::NodalVariableValue(), NumDOFs::NumDOFs(), NumNonlinearIterations::NumNonlinearIterations(), NumVars::NumVars(), FunctorRelationshipManager::operator()(), RelationshipManager::operator==(), XDA::output(), SolutionHistory::output(), Exodus::output(), AdvancedOutput::outputElementalVariables(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), Console::outputVectorPostprocessors(), AdvancedOutput::outputVectorPostprocessors(), MooseObject::paramError(), PiecewiseBilinear::parse(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PetscExternalPartitioner::PetscExternalPartitioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), Piecewise::Piecewise(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseMulticonstant::PiecewiseMulticonstant(), PiecewiseMultiInterpolation::PiecewiseMultiInterpolation(), SolutionUserObject::pointValueGradientWrapper(), SolutionUserObject::pointValueWrapper(), LStableDirk2::postResidual(), LStableDirk3::postResidual(), ImplicitMidpoint::postResidual(), ExplicitTVDRK2::postResidual(), AStableDirk4::postResidual(), LStableDirk4::postResidual(), ExplicitRK2::postResidual(), Predictor::Predictor(), Transient::preExecute(), SolutionUserObject::readExodusII(), SolutionUserObject::readXda(), FunctorRelationshipManager::redistribute(), EqualValueEmbeddedConstraint::reinitConstraint(), RelativeSolutionDifferenceNorm::RelativeSolutionDifferenceNorm(), RenameBlock::RenameBlock(), RenameBlockGenerator::RenameBlockGenerator(), RenameBoundaryGenerator::RenameBoundaryGenerator(), RinglebMesh::RinglebMesh(), RinglebMeshGenerator::RinglebMeshGenerator(), ScalarComponentIC::ScalarComponentIC(), BicubicSplineFunction::secondDerivative(), FEProblemBase::setCoordSystem(), PiecewiseBase::setData(), EigenProblem::setEigenproblemType(), FEProblemSolve::setInnerSolve(), Sampler::setNumberOfRequiedRandomSeeds(), Exodus::setOutputDimensionInExodusWriter(), Split::setup(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), SideSetsFromNormals::SideSetsFromNormals(), SideSetsFromNormalsGenerator::SideSetsFromNormalsGenerator(), SideSetsFromPoints::SideSetsFromPoints(), SideSetsFromPointsGenerator::SideSetsFromPointsGenerator(), SolutionTimeAdaptiveDT::SolutionTimeAdaptiveDT(), SolutionUserObject::SolutionUserObject(), PicardSolve::solve(), ActuallyExplicitEuler::solve(), FullSolveMultiApp::solveStep(), SpatialAverageBase::SpatialAverageBase(), UserObject::spatialValue(), SpiralAnnularMesh::SpiralAnnularMesh(), SpiralAnnularMeshGenerator::SpiralAnnularMeshGenerator(), StitchedMesh::StitchedMesh(), NodalUserObject::subdomainSetup(), GeneralUserObject::subdomainSetup(), Constraint::subdomainSetup(), Console::systemInfoFlags(), Terminator::Terminator(), TestSetupPostprocessorDataActionFunction::TestSetupPostprocessorDataActionFunction(), ThreadedGeneralUserObject::ThreadedGeneralUserObject(), ThreadedGeneralUserObject::threadJoin(), DiscreteElementUserObject::threadJoin(), GeneralUserObject::threadJoin(), TiledMeshGenerator::TiledMeshGenerator(), Function::timeDerivative(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), VectorPostprocessorVisualizationAux::timestepSetup(), MultiAppCopyTransfer::transfer(), MultiAppMeshFunctionTransfer::transferVariable(), FEProblemBase::uDotDotOldRequested(), FEProblemBase::uDotOldRequested(), EqualValueBoundaryConstraint::updateConstrainedNodes(), SolutionUserObject::updateExodusBracketingTimeIndices(), Axisymmetric2D3DSolutionFunction::value(), ValueRangeMarker::ValueRangeMarker(), ValueThresholdMarker::ValueThresholdMarker(), MultiAppTransfer::variableIntegrityCheck(), VariableTimeIntegrationAux::VariableTimeIntegrationAux(), VectorNodalBC::VectorNodalBC(), VectorOfPostprocessors::VectorOfPostprocessors(), VectorPostprocessorFunction::VectorPostprocessorFunction(), MooseParsedGradFunction::vectorValue(), MooseParsedFunction::vectorValue(), VectorVariableComponentAux::VectorVariableComponentAux(), VolumeHistogram::VolumeHistogram(), VTKOutput::VTKOutput(), DOFMapOutput::writeStreamToFile(), and Console::writeStreamToFile().

                                                      {
    std::ostringstream oss;
    moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
    std::string msg = oss.str();
    callMooseErrorRaw(msg, &_app);
  }

mooseInfo()

template<typename... Args>

void MooseObject::mooseInfo ( Args &&...  args ) const

inlineinherited

Definition at line 164 of file MooseObject.h.

Referenced by DerivativeParsedMaterialHelper::assembleDerivatives(), AStableDirk4::AStableDirk4(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), ParsedMaterialHelper::functionsOptimize(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), and MooseObject::paramInfo().

  {
    moose::internal::mooseInfoStream(_console, std::forward<Args>(args)...);
  }

mooseWarning()

template<typename... Args>

void MooseObject::mooseWarning ( Args &&...  args ) const

inlineinherited

Definition at line 152 of file MooseObject.h.

Referenced by CartesianMeshGenerator::CartesianMeshGenerator(), OversampleOutput::cloneMesh(), GapValueAux::computeValue(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), ElementSubdomainIDGenerator::generate(), MooseMesh::getBoundaryIDs(), FEProblemBase::getMaterial(), MooseMesh::getSubdomainIDs(), DerivativeFunctionMaterialBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), LeastSquaresFit::LeastSquaresFit(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), AssignElementSubdomainID::modify(), MultiAppTransfer::MultiAppTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MooseObject::paramWarning(), Executioner::problem(), Material::resetQpProperties(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), and Checkpoint::updateCheckpointFiles().

  {
    moose::internal::mooseWarningStream(_console, std::forward<Args>(args)...);
  }

moveApp()

void MultiApp::moveApp ( unsigned int  global_app, Point  p  )

virtual

Move the global_app to Point p.

Parameters

global_app	The global app number in question
p	The new position of the App.

Definition at line 571 of file MultiApp.C.

Referenced by preTransfer().

{
  if (_use_positions)
  {
    _positions[global_app] = p;

    if (hasLocalApp(global_app))
    {
      unsigned int local_app = globalAppToLocal(global_app);

      if (_output_in_position)
        _apps[local_app]->setOutputPosition(p);
    }
  }
}

name()

const std::string& MooseObject::name ( ) const

inlineinherited

Get the name of the object.

Returns

The name of the object

Definition at line 56 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), FEProblemBase::addADJacobianMaterial(), FEProblemBase::addADResidualMaterial(), Executioner::addAttributeReporter(), DumpObjectsProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarKernel(), DumpObjectsProblem::addBoundaryCondition(), FEProblemBase::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), DumpObjectsProblem::addDGKernel(), FEProblemBase::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), FEProblemBase::addIndicator(), DumpObjectsProblem::addInitialCondition(), FEProblemBase::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), FEProblemBase::addInterfaceKernel(), DumpObjectsProblem::addKernel(), FEProblemBase::addKernel(), FEProblemBase::addMarker(), DumpObjectsProblem::addMaterial(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), MooseMesh::addMortarInterface(), FEProblemBase::addMultiApp(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addNodalKernel(), FEProblemBase::addPostprocessor(), FEProblemBase::addPredictor(), CreateDisplacedProblemAction::addProxyAlgebraicRelationshipManagers(), CreateDisplacedProblemAction::addProxyGeometricRelationshipManagers(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarKernel(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), FEProblemBase::addVectorPostprocessor(), Output::advancedExecuteOn(), appPostprocessorValue(), appProblem(), appProblemBase(), appUserObjectBase(), DerivativeParsedMaterialHelper::assembleDerivatives(), AStableDirk4::AStableDirk4(), Function::average(), backup(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), FEProblemBase::checkDependMaterialsHelper(), Damper::checkMinDamping(), Material::checkStatefulSanity(), CompositeFunction::CompositeFunction(), Material::computeSubdomainProperties(), VectorPostprocessorVisualizationAux::computeValue(), createApp(), FEProblemBase::declareVectorPostprocessorVector(), DOFMapOutput::demangle(), DerivativeSumMaterial::DerivativeSumMaterial(), DGKernelBase::DGKernelBase(), DumpObjectsProblem::dumpObjectHelper(), ElementValueSampler::ElementValueSampler(), MooseMesh::errorIfDistributedMesh(), AB2PredictorCorrector::estimateTimeError(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), StatisticsVectorPostprocessor::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), PointValue::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), HistogramVectorPostprocessor::execute(), MultiAppCopyTransfer::execute(), Exodus::Exodus(), FileOutput::FileOutput(), fillPositions(), PointSamplerBase::finalize(), DerivativeParsedMaterialHelper::findMatPropDerivative(), FunctionDT::FunctionDT(), GeneralUserObject::GeneralUserObject(), LowerDBlockFromSidesetGenerator::generate(), StitchedMeshGenerator::generate(), Material::getADMaterialProperty(), getBoundingBox(), MooseObject::getCheckedPointerParam(), Control::getControllableParameterByName(), Control::getControllableValue(), Control::getControllableValueByName(), DistributionInterface::getDistribution(), FEProblemBase::getDistribution(), DistributionInterface::getDistributionByName(), getExecutioner(), OutputWarehouse::getFileNumbers(), FEProblemBase::getFunction(), SolutionUserObject::getLocalVarIndex(), Marker::getMarkerValue(), FEProblemBase::getMaterial(), NodalPatchRecovery::getMaterialProperty(), Material::getMaterialProperty(), AuxKernelTempl< ComputeValueType >::getMaterialProperty(), SubProblem::getMaterialPropertyBlockNames(), SubProblem::getMaterialPropertyBoundaryNames(), NodalPatchRecovery::getMaterialPropertyOld(), AuxKernelTempl< ComputeValueType >::getMaterialPropertyOld(), Material::getMaterialPropertyOld(), NodalPatchRecovery::getMaterialPropertyOlder(), AuxKernelTempl< ComputeValueType >::getMaterialPropertyOlder(), Material::getMaterialPropertyOlder(), MeshGenerator::getMesh(), MooseMesh::getMortarInterfaceByName(), OutputWarehouse::getOutput(), MooseObject::getParam(), GeneralUserObject::getPostprocessorValue(), FEProblemBase::getPostprocessorValue(), GeneralUserObject::getPostprocessorValueByName(), FEProblemBase::getPostprocessorValueOld(), FEProblemBase::getPostprocessorValueOlder(), FEProblemBase::getSampler(), FEProblemBase::getScatterVectorPostprocessorValue(), FEProblemBase::getScatterVectorPostprocessorValueOld(), Transient::getTimeStepperName(), InitialConditionBase::getUserObject(), FEProblemBase::getUserObject(), InitialConditionBase::getUserObjectBase(), FEProblemBase::getUserObjectBase(), InitialConditionBase::getUserObjectByName(), GeneralUserObject::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValue(), GeneralUserObject::getVectorPostprocessorValueByName(), FEProblemBase::getVectorPostprocessorValueOld(), FEProblemBase::hasFunction(), AdvancedOutput::hasOutputHelper(), FEProblemBase::hasPostprocessor(), FEProblemBase::hasUserObject(), FEProblemBase::hasVectorPostprocessor(), FEProblemBase::init(), AdvancedOutput::initExecutionTypes(), AttribName::initFrom(), CSVReader::initialize(), StatisticsVectorPostprocessor::initialize(), HistogramVectorPostprocessor::initialize(), MultiAppProjectionTransfer::initialSetup(), DerivativeFunctionMaterialBase::initialSetup(), SolutionUserObject::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPostprocessorData(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), Material::initStatefulProperties(), FEProblemBase::initVectorPostprocessorData(), Function::integral(), InterfaceKernel::InterfaceKernel(), Registry::isADObj(), MooseObject::isParamValid(), Registry::isRegisteredObj(), LinearCombinationFunction::LinearCombinationFunction(), Marker::Marker(), MatDiffusionBase< Real >::MatDiffusionBase(), MaterialDerivativeTestKernelBase< Real >::MaterialDerivativeTestKernelBase(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), Distribution::median(), MemoryUsageReporter::MemoryUsageReporter(), MeshSideSetGenerator::MeshSideSetGenerator(), ElementDeleterBase::modify(), MooseVariableInterface< Real >::MooseVariableInterface(), NearestPointBase< LayeredAverage >::NearestPointBase(), NodalValueSampler::NodalValueSampler(), NodalVariableValue::NodalVariableValue(), Registry::objData(), DOFMapOutput::output(), Output::Output(), AdvancedOutput::outputElementalVariables(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), ConsoleUtils::outputOutputInformation(), Nemesis::outputPostprocessors(), Exodus::outputPostprocessors(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), AdvancedOutput::outputVectorPostprocessors(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PointSamplerBase::PointSamplerBase(), Registry::registerObjectsTo(), FEProblemBase::registerRandomInterface(), Material::resetQpProperties(), restore(), Sampler::Sampler(), ScalarComponentIC::ScalarComponentIC(), MooseMesh::setBoundaryName(), Control::setControllableValue(), Control::setControllableValueByName(), OutputWarehouse::setFileNumbers(), MooseMesh::setSubdomainName(), Split::setup(), TransientMultiApp::setupApp(), SideSetsFromNormalsGenerator::SideSetsFromNormalsGenerator(), SideSetsFromPointsGenerator::SideSetsFromPointsGenerator(), SideValueSampler::SideValueSampler(), TransientMultiApp::solveStep(), SpatialAverageBase::SpatialAverageBase(), UserObject::spatialValue(), StitchedMesh::StitchedMesh(), SubProblem::storeBoundaryDelayedCheckMatProp(), SubProblem::storeBoundaryMatPropName(), SubProblem::storeBoundaryZeroMatProp(), SubProblem::storeSubdomainDelayedCheckMatProp(), SubProblem::storeSubdomainMatPropName(), SubProblem::storeSubdomainZeroMatProp(), TaggingInterface::TaggingInterface(), ThreadedGeneralUserObject::ThreadedGeneralUserObject(), Function::timeDerivative(), VectorPostprocessorVisualizationAux::timestepSetup(), TransientMultiApp::TransientMultiApp(), MultiAppTransfer::variableIntegrityCheck(), and AdvancedOutput::wantOutput().

{ return _name; }

needsRestoration()

virtual bool MultiApp::needsRestoration ( )

inlinevirtual

Whether or not this MultiApp should be restored at the beginning of each Picard iteration.

Reimplemented in TransientMultiApp.

Definition at line 137 of file MultiApp.h.

{ return true; }

numGlobalApps()

unsigned int MultiApp::numGlobalApps ( )

inline

Returns

Number of Global Apps in this MultiApp

Definition at line 201 of file MultiApp.h.

{ return _total_num_apps; }

numLocalApps()

unsigned int MultiApp::numLocalApps ( )

inline

Returns

Number of Apps on local processor.

Definition at line 206 of file MultiApp.h.

Referenced by MultiAppDTKUserObjectEvaluator::createSourceGeometry().

{ return _apps.size(); }

paramError()

template<typename... Args>

void MooseObject::paramError ( const std::string &  param, Args...  args  )

inlineinherited

Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseError - only printing a message using the given args.

Definition at line 105 of file MooseObject.h.

Referenced by ADIntegratedBCTempl< T, compute_stage >::ADIntegratedBCTempl(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), ConcentricCircleMeshGenerator::ConcentricCircleMeshGenerator(), DGKernelBase::DGKernelBase(), ElementValueSampler::ElementValueSampler(), StitchedMeshGenerator::generate(), MeshCollectionGenerator::generate(), StackGenerator::generate(), init(), IntegratedBC::IntegratedBC(), Kernel::Kernel(), MeshCollectionGenerator::MeshCollectionGenerator(), NodalBC::NodalBC(), NodalEqualValueConstraint::NodalEqualValueConstraint(), NodalKernel::NodalKernel(), NodalValueSampler::NodalValueSampler(), RandomIC::RandomIC(), MultiAppCopyTransfer::transfer(), and TransientMultiApp::TransientMultiApp().

                                                                      {
    auto prefix = param + ": ";
    if (!_pars.inputLocation(param).empty())
      prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
    mooseError(prefix, args...);
  }

parameters()

const InputParameters& MooseObject::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns

The parameters of the object

Definition at line 62 of file MooseObject.h.

Referenced by FEProblemBase::addADJacobianMaterial(), FEProblemBase::addADResidualMaterial(), DumpObjectsProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarKernel(), DumpObjectsProblem::addBoundaryCondition(), FEProblemBase::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), DumpObjectsProblem::addDGKernel(), FEProblemBase::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), FEProblemBase::addIndicator(), DumpObjectsProblem::addInitialCondition(), FEProblemBase::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), FEProblemBase::addInterfaceKernel(), DumpObjectsProblem::addKernel(), FEProblemBase::addKernel(), FEProblem::addLineSearch(), FEProblemBase::addMarker(), DumpObjectsProblem::addMaterial(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addNodalKernel(), FEProblemBase::addOutput(), FEProblemBase::addPostprocessor(), FEProblemBase::addPredictor(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarKernel(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), FEProblemBase::addVectorPostprocessor(), ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), AdvancedOutput::AdvancedOutput(), assemble_l2(), Moose::assemble_matrix(), AuxKernelTempl< ComputeValueType >::AuxKernelTempl(), AuxScalarKernel::AuxScalarKernel(), BoundsAux::BoundsAux(), LibmeshPartitioner::clone(), OversampleOutput::cloneMesh(), Moose::compute_bounds(), Moose::compute_jacobian(), Moose::compute_nearnullspace(), Moose::compute_nullspace(), Moose::compute_postcheck(), Moose::compute_transpose_nullspace(), Console::Console(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), Exodus::Exodus(), FEProblem::FEProblem(), GapValueAux::GapValueAux(), MooseObject::getCheckedPointerParam(), GhostingUserObject::GhostingUserObject(), MooseMesh::init(), BlockRestrictable::initializeBlockRestrictable(), FEProblemBase::initNullSpaceVectors(), InterfaceKernel::InterfaceKernel(), isValid(), LayeredSideIntegral::LayeredSideIntegral(), MooseVariableInterface< Real >::MooseVariableInterface(), NearestPointBase< LayeredAverage >::NearestPointBase(), NodeFaceConstraint::NodeFaceConstraint(), PenetrationAux::PenetrationAux(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), MultiAppProjectionTransfer::projectSolution(), RandomIC::RandomIC(), InputParameterWarehouse::removeInputParameters(), FEProblem::setInputParametersFEProblem(), FEProblemBase::setInputParametersFEProblem(), DumpObjectsProblem::stringifyParameters(), and Transient::Transient().

{ return _pars; }

paramInfo()

template<typename... Args>

void MooseObject::paramInfo ( const std::string &  param, Args...  args  )

inlineinherited

Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseInfo - only printing a message using the given args.

Definition at line 135 of file MooseObject.h.

Referenced by TransientMultiApp::TransientMultiApp().

  {
    auto prefix = param + ": ";
    if (!_pars.inputLocation(param).empty())
      prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
    mooseInfo(prefix, args...);
  }

paramWarning()

template<typename... Args>

void MooseObject::paramWarning ( const std::string &  param, Args...  args  )

inlineinherited

Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseWarning - only printing a message using the given args.

Definition at line 119 of file MooseObject.h.

  {
    auto prefix = param + ": ";
    if (!_pars.inputLocation(param).empty())
      prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
    mooseWarning(prefix, args...);
  }

parentOutputPositionChanged()

void MultiApp::parentOutputPositionChanged ( )

virtual

For apps outputting in position we need to change their output positions if their parent app moves.

Definition at line 588 of file MultiApp.C.

{
  if (_use_positions && _output_in_position)
    for (unsigned int i = 0; i < _apps.size(); i++)
      _apps[i]->setOutputPosition(_app.getOutputPosition() + _positions[_first_local_app + i]);
}

position()

Point MultiApp::position ( unsigned int  app )

inline

The physical position of a global App number.

Parameters

app	The global app number you want the position for.

Returns

the position

Definition at line 236 of file MultiApp.h.

Referenced by MultiAppDTKUserObjectEvaluator::evaluate(), fillPositions(), and getBoundingBox().

{ return _positions[app]; }

postExecute()

void MultiApp::postExecute ( )

virtual

Method called at the end of the simulation (after finalize)

Reimplemented in FullSolveMultiApp.

Definition at line 388 of file MultiApp.C.

{
  for (const auto & app_ptr : _apps)
  {
    auto * executioner = app_ptr->getExecutioner();
    mooseAssert(executioner, "Executioner is nullptr");

    executioner->postExecute();
  }
}

preExecute()

virtual void MultiApp::preExecute ( )

inlinevirtual

Definition at line 63 of file MultiApp.h.

{}

preRunInputFile()

void MultiApp::preRunInputFile ( )

protectedvirtual

call back executed right before app->runInputFile()

Definition at line 806 of file MultiApp.C.

Referenced by createApp().

{
}

preTransfer()

void MultiApp::preTransfer ( Real  dt, Real  target_time  )

virtual

Gets called just before transfers are done to the MultiApp (Which is just before the MultiApp is solved)

Definition at line 346 of file MultiApp.C.

{
  // First, see if any Apps need to be Reset
  if (!_reset_happened && target_time + 1e-14 >= _reset_time)
  {
    _reset_happened = true;
    for (auto & app : _reset_apps)
      resetApp(app);
  }

  // Now move any apps that should be moved
  if (_use_positions && !_move_happened && target_time + 1e-14 >= _move_time)
  {
    _move_happened = true;
    for (unsigned int i = 0; i < _move_apps.size(); i++)
      moveApp(_move_apps[i], _move_positions[i]);
  }
}

problemBase()

FEProblemBase& MultiApp::problemBase ( )

inline

Get the FEProblemBase this MultiApp is part of.

Definition at line 160 of file MultiApp.h.

{ return _fe_problem; }

resetApp()

void MultiApp::resetApp ( unsigned int  global_app, Real  time = 0.0  )

virtual

"Reset" the App corresponding to the global App number passed in.

"Reset" means that the App will be deleted and recreated. The time for the new App will be set to the current simulation time. This might be handy if some sub-app in your simulation needs to get replaced by a "new" piece of material.

Parameters

global_app	The global app number to reset.
time	The time to set as the the time for the new app, this should really be the time the old app was at.

Reimplemented in TransientMultiApp.

Definition at line 552 of file MultiApp.C.

Referenced by preTransfer(), and TransientMultiApp::resetApp().

{
  Moose::ScopedCommSwapper swapper(_my_comm);

  if (hasLocalApp(global_app))
  {
    unsigned int local_app = globalAppToLocal(global_app);

    // Extract the file numbers from the output, so that the numbering is maintained after reset
    std::map<std::string, unsigned int> m = _apps[local_app]->getOutputWarehouse().getFileNumbers();

    createApp(local_app, time);

    // Reset the file numbers of the newly reset apps
    _apps[local_app]->getOutputWarehouse().setFileNumbers(m);
  }
}

residualSetup()

void SetupInterface::residualSetup ( )

virtualinherited

Gets called just before the residual is computed and before this object is asked to do its job.

Definition at line 57 of file SetupInterface.C.

{
}

restore()

void MultiApp::restore ( )

virtual

Restore the state of every Sub App.

This allows us to "Restore" this state later

Reimplemented in FullSolveMultiApp, and TransientMultiApp.

Definition at line 409 of file MultiApp.C.

Referenced by dataLoad(), TransientMultiApp::restore(), and FullSolveMultiApp::restore().

{
  // Must be restarting / recovering so hold off on restoring
  // Instead - the restore will happen in createApp()
  // Note that _backups was already populated by dataLoad()
  if (_apps.empty())
    return;

  _console << "Begining restoring MultiApp " << name() << std::endl;
  for (unsigned int i = 0; i < _my_num_apps; i++)
    _apps[i]->restore(_backups[i]);
  _console << "Finished restoring MultiApp " << name() << std::endl;
}

setupPositions()

void MultiApp::setupPositions

(

)

Called just after construction to allow derived classes to set _positions;.

Definition at line 223 of file MultiApp.C.

Referenced by FEProblemBase::addMultiApp().

{
  if (_use_positions)
  {
    fillPositions();
    init(_positions.size());
  }
}

solveStep()

virtual bool MultiApp::solveStep ( Real  dt, Real  target_time, bool  auto_advance = true  )

pure virtual

Re-solve all of the Apps.

Can be called multiple times to resolve the same timestep if auto_advance=false. Time is not actually advanced until advanceStep() is called.

Note that auto_advance=false might not be compatible with the options for the MultiApp

Returns

Whether or not all of the solves were successful (i.e. all solves made it to the target_time)

Implemented in TransientMultiApp, and FullSolveMultiApp.

subdomainSetup()

void SetupInterface::subdomainSetup ( )

virtualinherited

Gets called when the subdomain changes (i.e.

in a Jacobian or residual loop) and before this object is asked to do its job

Reimplemented in Material, Constraint, GeneralUserObject, NodalUserObject, and ThreadedGeneralUserObject.

Definition at line 62 of file SetupInterface.C.

{
}

timestepSetup()

void SetupInterface::timestepSetup ( )

virtualinherited

Gets called at the beginning of the timestep before this object is asked to do its job.

Reimplemented in SolutionUserObject, Console, VectorPostprocessorVisualizationAux, NumNonlinearIterations, EqualValueEmbeddedConstraint, VectorMemoryUsage, and MemoryUsage.

Definition at line 47 of file SetupInterface.C.

{
}

type()

const std::string& MooseObject::type ( ) const

inlineinherited

Get the type of this object.

Returns

the name of the type of this object

Definition at line 50 of file MooseObject.h.

Referenced by DumpObjectsProblem::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarVariable(), DumpObjectsProblem::addAuxVariable(), DisplacedProblem::addAuxVariable(), FEProblemBase::addAuxVariable(), DumpObjectsProblem::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), DumpObjectsProblem::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), DumpObjectsProblem::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), DumpObjectsProblem::addKernel(), DumpObjectsProblem::addMaterial(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addPredictor(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarVariable(), PhysicsBasedPreconditioner::addSystem(), FEProblemBase::addTimeIntegrator(), DumpObjectsProblem::addVariable(), DisplacedProblem::addVariable(), FEProblemBase::addVariable(), FEProblemBase::advanceMultiApps(), FEProblemBase::backupMultiApps(), MooseMesh::buildRefinementAndCoarseningMaps(), FEProblemBase::computeAuxiliaryKernels(), DGKernel::computeElemNeighJacobian(), ElemElemConstraint::computeElemNeighJacobian(), InterfaceKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighResidual(), ElemElemConstraint::computeElemNeighResidual(), InterfaceKernel::computeElemNeighResidual(), FEProblemBase::computeMultiAppsDT(), DGKernel::computeOffDiagElemNeighJacobian(), InterfaceKernel::computeOffDiagElemNeighJacobian(), DGConvection::computeQpJacobian(), CoupledTiedValueConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), DGDiffusion::computeQpJacobian(), LinearNodalConstraint::computeQpJacobian(), EqualValueBoundaryConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpOffDiagJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), DGConvection::computeQpResidual(), CoupledTiedValueConstraint::computeQpResidual(), TiedValueConstraint::computeQpResidual(), LinearNodalConstraint::computeQpResidual(), DGDiffusion::computeQpResidual(), EqualValueBoundaryConstraint::computeQpResidual(), EqualValueEmbeddedConstraint::computeQpResidual(), FEProblemBase::computeUserObjects(), DisplacedProblem::createQRules(), FEProblemBase::createQRules(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), FEProblemBase::duplicateVariableCheck(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), FEProblemBase::execTransfers(), FEProblemBase::finishMultiAppStep(), ElementSubdomainIDGenerator::generate(), ElementGenerator::getElemType(), FEProblemBase::getMaterial(), FEProblemBase::getMaterialData(), FEProblemBase::getTransfers(), FEProblemBase::hasMultiApps(), AdvancedOutput::hasOutput(), FEProblemBase::incrementMultiAppTStep(), AdvancedOutput::initAvailableLists(), SolutionUserObject::initialSetup(), AdvancedOutput::initShowHideLists(), RelationshipManager::isType(), AssignElementSubdomainID::modify(), ControlOutput::output(), Gnuplot::output(), CSV::output(), Exodus::output(), Console::output(), Nemesis::output(), AdvancedOutput::output(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), FEProblemBase::restoreMultiApps(), FEProblemBase::setCoupling(), PerfGraphOutput::shouldOutput(), FileOutput::shouldOutput(), Output::shouldOutput(), AdvancedOutput::shouldOutput(), DisplacedProblem::updateGeomSearch(), FEProblemBase::updateGeomSearch(), and AdvancedOutput::wantOutput().

{ return _type; }

Member Data Documentation

_app

MooseApp& MooseObject::_app

protectedinherited

The MooseApp this object is associated with.

Definition at line 174 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), AB2PredictorCorrector::AB2PredictorCorrector(), Executioner::addAttributeReporter(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addOutput(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), MooseMesh::buildMeshBaseObject(), FEProblemBase::checkNonlinearConvergence(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), createApp(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::dumpVariableHelper(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), NonlinearEigen::execute(), InversePowerMethod::execute(), Transient::execute(), Steady::execute(), FileOutput::FileOutput(), FEProblemBase::forceOutput(), MeshGenerator::getMesh(), MeshGenerator::getMeshByName(), MooseObject::getMooseApp(), GhostingUserObject::GhostingUserObject(), InversePowerMethod::init(), NonlinearEigen::init(), Transient::init(), Steady::init(), MooseMesh::init(), NumPicardIterations::initialize(), TimePeriod::initialSetup(), Console::initialSetup(), initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutput(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), ElementSideNeighborLayers::internalInit(), InversePowerMethod::InversePowerMethod(), MooseObject::mooseError(), NonlinearEigen::NonlinearEigen(), EigenExecutionerBase::normalizeSolution(), PerfGraphOutput::output(), Tecplot::output(), Exodus::output(), Nemesis::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), parentOutputPositionChanged(), PerformanceData::PerformanceData(), PetscOutput::petscLinearOutput(), PetscOutput::petscNonlinearOutput(), Transient::preExecute(), FEProblemBase::projectSolution(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), FEProblemBase::timestepSetup(), Transient::Transient(), and Console::write().

_app_type

std::string MultiApp::_app_type

protected

The type of application to build.

Definition at line 322 of file MultiApp.h.

Referenced by createApp(), and initialSetup().

_apps

std::vector<std::shared_ptr<MooseApp> > MultiApp::_apps

protected

Pointers to each of the Apps.

Definition at line 367 of file MultiApp.h.

Referenced by appProblem(), appProblemBase(), backup(), createApp(), finalize(), getBoundingBox(), getExecutioner(), TransientMultiApp::incrementTStep(), FullSolveMultiApp::initialSetup(), initialSetup(), localApp(), moveApp(), numLocalApps(), parentOutputPositionChanged(), postExecute(), TransientMultiApp::resetApp(), resetApp(), TransientMultiApp::restore(), restore(), TransientMultiApp::setupApp(), FullSolveMultiApp::solveStep(), and TransientMultiApp::solveStep().

_backups

SubAppBackups& MultiApp::_backups

protected

Backups for each local App.

Definition at line 415 of file MultiApp.h.

Referenced by backup(), createApp(), init(), and restore().

_bounding_box

std::vector<BoundingBox> MultiApp::_bounding_box

protected

This multi-app's bounding box.

Definition at line 373 of file MultiApp.h.

Referenced by getBoundingBox(), and init().

_bounding_box_padding

Point MultiApp::_bounding_box_padding

protected

Additional padding added to the bounding box, useful for 1D meshes.

Definition at line 379 of file MultiApp.h.

Referenced by getBoundingBox().

_cli_args

const std::vector<std::string>& MultiApp::_cli_args

protected

Storage for command line arguments.

Definition at line 418 of file MultiApp.h.

Referenced by createApp(), and init().

_console

const ConsoleStream ConsoleStreamInterface::_console

inherited

An instance of helper class to write streams to the Console objects.

Definition at line 32 of file ConsoleStreamInterface.h.

Referenced by IterationAdaptiveDT::acceptStep(), SetupRecoverFileBaseAction::act(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), SimplePredictor::apply(), backup(), FEProblemBase::backupMultiApps(), FEProblemBase::checkProblemIntegrity(), IterationAdaptiveDT::computeAdaptiveDT(), Transient::computeConstrainedDT(), NonlinearSystemBase::computeDamping(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeResidualTags(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), createApp(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppCopyTransfer::execute(), Steady::execute(), MultiAppDTKUserObjectTransfer::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), FEProblemBase::FEProblemBase(), ElementQualityChecker::finalize(), FEProblemBase::finishMultiAppStep(), globalAppToLocal(), InversePowerMethod::init(), NonlinearEigen::init(), Steady::init(), FEProblemBase::initialAdaptMesh(), FEProblemBase::initialSetup(), EigenExecutionerBase::inversePowerIteration(), Transient::keepGoing(), IterationAdaptiveDT::limitDTByFunction(), IterationAdaptiveDT::limitDTToPostprocessorValue(), EigenExecutionerBase::makeBXConsistent(), Console::meshChanged(), MooseObject::mooseDeprecated(), MooseObject::mooseInfo(), MooseObject::mooseWarning(), PerfGraphOutput::output(), DOFMapOutput::output(), VariableResidualNormsDebugOutput::output(), Console::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Console::outputInput(), Console::outputPostprocessors(), Console::outputScalarVariables(), Console::outputSystemInformation(), FEProblemBase::possiblyRebuildGeomSearchPatches(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), EigenExecutionerBase::printEigenvalue(), MaterialPropertyDebugOutput::printMaterialMap(), SolutionTimeAdaptiveDT::rejectStep(), DT2::rejectStep(), restore(), FEProblemBase::restoreMultiApps(), SimplePredictor::shouldApply(), NonlinearSystem::solve(), PicardSolve::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), LStableDirk4::solve(), AStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), PicardSolve::solveStep(), DT2::step(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().

_current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 98 of file SetupInterface.h.

_enabled

const bool& MooseObject::_enabled

protectedinherited

Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects.

Definition at line 183 of file MooseObject.h.

Referenced by MooseObject::enabled().

_exec_flags

const std::vector<ExecFlagType> SetupInterface::_exec_flags

protectedinherited

(DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType

Definition at line 95 of file SetupInterface.h.

Referenced by SetupInterface::execBitFlags(), MultiAppTransfer::execFlags(), and SetupInterface::execFlags().

_execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this oejct.

Definition at line 92 of file SetupInterface.h.

Referenced by ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), and SetupInterface::getExecuteOnEnum().

_fe_problem

FEProblemBase& MultiApp::_fe_problem

protected

The FEProblemBase this MultiApp is part of.

Definition at line 319 of file MultiApp.h.

Referenced by createApp(), CentroidMultiApp::fillPositions(), and problemBase().

_first_local_app

unsigned int MultiApp::_first_local_app

protected

The number of the first app on this processor.

Definition at line 343 of file MultiApp.h.

Referenced by buildComm(), createApp(), firstLocalApp(), globalAppToLocal(), hasLocalApp(), parentOutputPositionChanged(), TransientMultiApp::setupApp(), and TransientMultiApp::solveStep().

_global_time_offset

const Real MultiApp::_global_time_offset

protected

The offset time so the MultiApp local time relative to the global time.

Definition at line 388 of file MultiApp.h.

Referenced by initialSetup().

_has_an_app

bool MultiApp::_has_an_app

protected

Whether or not this processor as an App at all

Definition at line 412 of file MultiApp.h.

Referenced by appPostprocessorValue(), appProblem(), appProblemBase(), appUserObjectBase(), buildComm(), TransientMultiApp::computeDT(), getBoundingBox(), getExecutioner(), hasApp(), hasLocalApp(), FullSolveMultiApp::initialSetup(), TransientMultiApp::initialSetup(), initialSetup(), FullSolveMultiApp::solveStep(), and TransientMultiApp::solveStep().

_has_bounding_box

std::vector<bool> MultiApp::_has_bounding_box

protected

Flag if this multi-app computed its bounding box (valid only for non-displaced meshes)

Definition at line 370 of file MultiApp.h.

Referenced by getBoundingBox(), and init().

_inflation

Real MultiApp::_inflation

protected

Relative bounding box inflation.

Definition at line 376 of file MultiApp.h.

Referenced by getBoundingBox().

_input_files

std::vector<FileName> MultiApp::_input_files

protected

The input file for each app's simulation.

Definition at line 331 of file MultiApp.h.

Referenced by createApp(), and fillPositions().

_max_procs_per_app

unsigned int MultiApp::_max_procs_per_app

protected

Maximum number of processors to give to each app.

Definition at line 382 of file MultiApp.h.

Referenced by buildComm().

_move_apps

std::vector<unsigned int> MultiApp::_move_apps

protected

The apps to be moved.

Definition at line 403 of file MultiApp.h.

Referenced by fillPositions(), and preTransfer().

_move_happened

bool MultiApp::_move_happened

protected

Whether or not the move has happened.

Definition at line 409 of file MultiApp.h.

Referenced by preTransfer().

_move_positions

std::vector<Point> MultiApp::_move_positions

protected

The new positions for the apps to be moved.

Definition at line 406 of file MultiApp.h.

Referenced by fillPositions(), and preTransfer().

_move_time

Real MultiApp::_move_time

protected

The time at which to move apps.

Definition at line 400 of file MultiApp.h.

Referenced by preTransfer().

_my_comm

MPI_Comm& MultiApp::_my_comm

protected

The MPI communicator this object is going to use.

Definition at line 352 of file MultiApp.h.

Referenced by buildComm(), comm(), TransientMultiApp::computeDT(), createApp(), getBoundingBox(), FullSolveMultiApp::initialSetup(), TransientMultiApp::initialSetup(), initialSetup(), TransientMultiApp::resetApp(), resetApp(), FullSolveMultiApp::solveStep(), and TransientMultiApp::solveStep().

_my_communicator

libMesh::Parallel::Communicator MultiApp::_my_communicator

protected

The communicator object that holds the MPI_Comm that we're going to use.

Definition at line 349 of file MultiApp.h.

Referenced by buildComm().

_my_num_apps

unsigned int MultiApp::_my_num_apps

protected

The number of apps this object is involved in simulating.

Definition at line 340 of file MultiApp.h.

Referenced by backup(), buildComm(), TransientMultiApp::computeDT(), TransientMultiApp::finishStep(), globalAppToLocal(), hasLocalApp(), TransientMultiApp::incrementTStep(), init(), FullSolveMultiApp::initialSetup(), TransientMultiApp::initialSetup(), initialSetup(), TransientMultiApp::restore(), restore(), FullSolveMultiApp::solveStep(), and TransientMultiApp::solveStep().

_my_rank

int MultiApp::_my_rank

protected

The mpi "rank" of this processor in the sub communicator.

Definition at line 364 of file MultiApp.h.

Referenced by buildComm(), and isRootProcessor().

_name

const std::string& MooseObject::_name

protectedinherited

The name of this object, reference to value stored in InputParameters.

Definition at line 180 of file MooseObject.h.

Referenced by ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), DerivativeParsedMaterialHelper::assembleDerivatives(), Piecewise::buildFromFile(), Piecewise::buildFromXandY(), Piecewise::buildFromXY(), CentroidMultiApp::fillPositions(), fillPositions(), FunctionDT::FunctionDT(), PiecewiseBase::initialSetup(), MooseObject::name(), PiecewiseBilinear::parse(), Piecewise::Piecewise(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseBase::setData(), Split::setup(), and VectorPostprocessorFunction::VectorPostprocessorFunction().

_node_name

std::string MultiApp::_node_name

protected

Node Name.

Definition at line 361 of file MultiApp.h.

Referenced by buildComm().

_orig_comm

const MPI_Comm& MultiApp::_orig_comm

protected

The original comm handle.

Definition at line 346 of file MultiApp.h.

_orig_num_procs

int MultiApp::_orig_num_procs

protected

The number of processors in the original comm.

Definition at line 355 of file MultiApp.h.

Referenced by buildComm().

_orig_rank

int MultiApp::_orig_rank

protected

The mpi "rank" of this processor in the original communicator.

Definition at line 358 of file MultiApp.h.

Referenced by appPostprocessorValue(), appProblem(), appProblemBase(), appUserObjectBase(), buildComm(), getBoundingBox(), and getExecutioner().

_output_base

std::string MultiApp::_output_base

protected

The output file basename for each multiapp.

Definition at line 334 of file MultiApp.h.

_output_in_position

bool MultiApp::_output_in_position

protected

Whether or not to move the output of the MultiApp into position.

Definition at line 385 of file MultiApp.h.

Referenced by moveApp(), and parentOutputPositionChanged().

_pars

const InputParameters& MooseObject::_pars

protectedinherited

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition at line 171 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), BreakMeshByBlockBase::checkInputParameter(), PetscExternalPartitioner::clone(), GridPartitioner::clone(), Console::Console(), Eigenvalue::Eigenvalue(), Eigenvalue::execute(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), ExtraNodesetGenerator::generate(), MooseObject::getParam(), GeneralUserObject::getPostprocessorValue(), InitialConditionBase::getUserObject(), InitialConditionBase::getUserObjectBase(), GeneralUserObject::getVectorPostprocessorValue(), Transient::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseObject::isParamValid(), AddExtraNodeset::modify(), MooseObject::paramError(), MooseObject::parameters(), MooseObject::paramInfo(), MooseObject::paramWarning(), and Transient::setupTimeIntegrator().

_positions

std::vector<Point> MultiApp::_positions

protected

The positions of all of the apps.

Definition at line 325 of file MultiApp.h.

Referenced by createApp(), CentroidMultiApp::fillPositions(), fillPositions(), moveApp(), parentOutputPositionChanged(), position(), and setupPositions().

_reset_apps

std::vector<unsigned int> MultiApp::_reset_apps

protected

The apps to be reset.

Definition at line 394 of file MultiApp.h.

Referenced by preTransfer().

_reset_happened

bool MultiApp::_reset_happened

protected

Whether or not apps have been reset.

Definition at line 397 of file MultiApp.h.

Referenced by preTransfer().

_reset_time

Real MultiApp::_reset_time

protected

The time at which to reset apps.

Definition at line 391 of file MultiApp.h.

Referenced by preTransfer().

_total_num_apps

unsigned int MultiApp::_total_num_apps

protected

The total number of apps to simulate.

Definition at line 337 of file MultiApp.h.

Referenced by buildComm(), createApp(), init(), and numGlobalApps().

_type

const std::string& MooseObject::_type

protectedinherited

The type of this object (the Class name)

Definition at line 177 of file MooseObject.h.

Referenced by FEProblemBase::init(), and MooseObject::type().

_use_positions

const bool MultiApp::_use_positions

protected

Toggle use of "positions".

Definition at line 328 of file MultiApp.h.

Referenced by createApp(), moveApp(), parentOutputPositionChanged(), preTransfer(), and setupPositions().

---

The documentation for this class was generated from the following files:

• include/multiapps/MultiApp.h
• src/multiapps/MultiApp.C