Transfers values computed in the origin mesh by the source user object spatialValue() routine at locations in the target mesh. More...

#include <MultiAppGeneralFieldUserObjectTransfer.h>

Inheritance diagram for MultiAppGeneralFieldUserObjectTransfer:

[legend]

Public Types
enum	DIRECTION { TO_MULTIAPP, FROM_MULTIAPP, BETWEEN_MULTIAPP }

using	DataFileParameterType = DataFileName
	The parameter type this interface expects for a data file name. More...

Public Member Functions
	MultiAppGeneralFieldUserObjectTransfer (const InputParameters &parameters)

virtual void	initialSetup () override
	Method called at the beginning of the simulation for checking integrity or doing one-time setup. More...

virtual void	getAppInfo () override
	This method will fill information into the convenience member variables (_to_problems, _from_meshes, etc.) More...

virtual void	postExecute () override
	Add some extra work if necessary after execute(). More...

VariableName	getFromVarName (unsigned int var_index)
	Get the source variable name, with the suffix for array/vector variables. More...

VariableName	getToVarName (unsigned int var_index)
	Get the target variable name, with the suffix for array/vector variables. More...

void	variableIntegrityCheck (const AuxVariableName &var_name, bool is_from_multiapp) const
	Utility to verify that the variable in the destination system exists. More...

const std::shared_ptr< MultiApp >	getMultiApp () const
	Use this getter to obtain the MultiApp for transfers with a single direction. More...

const std::shared_ptr< MultiApp >	getFromMultiApp () const
	Get the MultiApp to transfer data from. More...

const std::shared_ptr< MultiApp >	getToMultiApp () const
	Get the MultiApp to transfer data to. More...

std::string	getFromName () const
	Get the name of thing being transferred from. More...

std::string	getToName () const
	Get the name of thing being transferred to. More...

bool	hasFromMultiApp () const
	Whether the transfer owns a non-null from_multi_app. More...

bool	hasToMultiApp () const
	Whether the transfer owns a non-null to_multi_app. More...

const MultiMooseEnum &	directions ()
	The directions this Transfer should be executed on. More...

void	setCurrentDirection (const int direction)
	Set this Transfer to be executed in a given direction. More...

virtual bool	enabled () const
	Return the enabled status of the object. More...

std::shared_ptr< MooseObject >	getSharedPtr ()
	Get another shared pointer to this object that has the same ownership group. More...

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () const
	Get the MooseApp this class is associated with. More...

const std::string &	type () const
	Get the type of this class. More...

const std::string &	name () const
	Get the name of the class. More...

std::string	typeAndName () const
	Get the class's combined type and name; useful in error handling. More...

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const
	Get the parameters of the object. More...

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

template<typename T >
const T &	getParam (const std::string &name) const
	Retrieve a parameter for the object. More...

template<typename T1 , typename T2 >
std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const
	Retrieve two parameters and provide pair of parameters for the object. More...

template<typename T >
const T *	queryParam (const std::string &name) const
	Query a parameter for the object. More...

template<typename T >
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
	Retrieve a renamed parameter for the object. More...

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...

bool	isParamSetByUser (const std::string &name) const
	Test if the supplied parameter is set by a user, as opposed to not set or set to default. More...

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
	Connect controllable parameter of this action with the controllable parameters of the objects added by this action. More...

template<typename... Args>
void	paramError (const std::string &param, Args... args) const
	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) const
	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) const
	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...

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const
	Deprecated message prefix; the error type is no longer used. More...

template<typename... Args>
void	mooseError (Args &&... args) const
	Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available. More...

template<typename... Args>
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

template<typename... Args>
void	mooseErrorNonPrefixed (Args &&... args) const
	Emits an error without the prefixing included in mooseError(). More...

template<typename... Args>
void	mooseWarning (Args &&... args) const
	Emits a warning prefixed with object name and type. More...

template<typename... Args>
void	mooseWarningNonPrefixed (Args &&... args) const
	Emits a warning without the prefixing included in mooseWarning(). More...

template<typename... Args>
void	mooseDeprecated (Args &&... args) const

template<typename... Args>
void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) const
	External method for calling moose error with added object context. More...

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

std::string	getDataFileName (const std::string &param) const
	Deprecated method. More...

std::string	getDataFileNameByName (const std::string &relative_path) const
	Deprecated method. More...

std::string	getDataFilePath (const std::string &relative_path) const
	Returns the path of a data file for a given relative file path. More...

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...

virtual void	customSetup (const ExecFlagType &)
	Gets called in FEProblemBase::execute() for execute flags other than initial, timestep_begin, nonlinear, linear and subdomain. More...

const ExecFlagEnum &	getExecuteOnEnum () const
	Return the execute on MultiMooseEnum for this object. More...

PerfGraph &	perfGraph ()
	Get the PerfGraph. More...


MooseEnum	direction ()

MooseEnum	currentDirection ()

Static Public Member Functions
static InputParameters	validParams ()

static void	addSkipCoordCollapsingParam (InputParameters &params)
	Add the option to skip coordinate collapsing in coordinate transformation operations Note: this is used by Actions creating transfers as well. More...

static libMesh::System *	find_sys (libMesh::EquationSystems &es, const std::string &var_name)
	Small helper function for finding the system containing the variable. More...

static std::string	possibleDirections ()
	Used to construct InputParameters. More...

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node)
	External method for calling moose error with added object context. More...

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

Static Public Attributes
static const libMesh::Number	OutOfMeshValue = -999999

static const std::string	type_param = "_type"
	The name of the parameter that contains the object type. More...

static const std::string	name_param = "_object_name"
	The name of the parameter that contains the object name. More...

static const std::string	unique_name_param = "_unique_name"
	The name of the parameter that contains the unique object name. More...

static const std::string	app_param = "_moose_app"
	The name of the parameter that contains the MooseApp. More...

static const std::string	moose_base_param = "_moose_base"
	The name of the parameter that contains the moose system base. More...

Protected Types
enum	MeshDivisionTransferUse { RESTRICTION, MATCH_DIVISION_INDEX, MATCH_SUBAPP_INDEX }
	Matching enum for the mesh division behaviors. More...

Protected Member Functions
virtual void	execute () override
	Execute the transfer. More...

virtual void	prepareEvaluationOfInterpValues (const unsigned int) override

virtual void	evaluateInterpValues (const std::vector< std::pair< Point, unsigned int >> &incoming_points, std::vector< std::pair< Real, Real >> &outgoing_vals) override

virtual void	checkSiblingsTransferSupported () const override
	Siblings transfers fully supported. More...

void	extractLocalFromBoundingBoxes (std::vector< BoundingBox > &local_bboxes)

bool	acceptPointInOriginMesh (unsigned int i_from, const std::vector< BoundingBox > &local_bboxes, const Point &pt, const unsigned int mesh_div, Real &distance) const

bool	inMesh (const libMesh::PointLocatorBase *const pl, const Point &pt) const

bool	inBlocks (const std::set< SubdomainID > &blocks, const Elem *elem) const

virtual bool	inBlocks (const std::set< SubdomainID > &blocks, const MooseMesh &mesh, const Elem *elem) const

bool	inBlocks (const std::set< SubdomainID > &blocks, const MooseMesh &mesh, const Node *node) const

bool	inBlocks (const std::set< SubdomainID > &blocks, const libMesh::PointLocatorBase *const pl, const Point &pt) const

bool	onBoundaries (const std::set< BoundaryID > &boundaries, const MooseMesh &mesh, const Node *node) const

bool	onBoundaries (const std::set< BoundaryID > &boundaries, const MooseMesh &mesh, const Elem *elem) const

bool	onBoundaries (const std::set< BoundaryID > &boundaries, const std::set< SubdomainID > &block_restriction, const MooseMesh &mesh, const libMesh::PointLocatorBase *const pl, const Point &pt) const

bool	acceptPointMeshDivision (const Point &pt, const unsigned int i_local, const unsigned int only_from_this_mesh_div) const
	Whether a point lies inside the mesh division delineated by the MeshDivision object. More...

bool	closestToPosition (unsigned int pos_index, const Point &pt) const
	Whether a point is closest to a position at the index specified than any other position. More...

bool	detectConflict (Real value_1, Real value_2, Real distance_1, Real distance_2) const
	Detects whether two source values are valid and equidistant for a desired target location. More...

void	registerConflict (unsigned int problem, dof_id_type dof_id, Point p, Real dist, bool local)
	Register a potential value conflict, e.g. More...

virtual std::vector< VariableName >	getFromVarNames () const override
	Virtual function defining variables to be transferred. More...

virtual std::vector< AuxVariableName >	getToVarNames () const override
	Virtual function defining variables to transfer to. More...

bool	performAdjustment (const PostprocessorValue &from, const PostprocessorValue &to) const

libMesh::EquationSystems &	getEquationSystem (FEProblemBase &problem, bool use_displaced) const
	Returns the Problem's equation system, displaced or not Be careful! If you transfer TO a displaced system you will likely need a synchronization So most transfers reach the non-displaced system directly. More...

std::vector< unsigned int >	getFromsPerProc ()
	Return the number of "from" domains that each processor owns. More...

libMesh::NumericVector< Real > &	getTransferVector (unsigned int i_local, std::string var_name)
	If we are transferring to a multiapp, return the appropriate solution vector. More...

unsigned int	getGlobalSourceAppIndex (unsigned int i_from) const
	Return the global app index from the local index in the "from-multiapp" transfer direction. More...

unsigned int	getGlobalTargetAppIndex (unsigned int i_to) const
	Return the global app index from the local index in the "to-multiapp" transfer direction. More...

unsigned int	getLocalSourceAppIndex (unsigned int i_from) const
	Return the local app index from the global index in the "from-multiapp" transfer direction We use the fact that global app indexes are consecutive on a given rank. More...

void	checkParentAppUserObjectExecuteOn (const std::string &object_name) const
	Checks the execute_on flags for user object transfers with user objects on the source app which is also the parent app. More...

void	errorIfObjectExecutesOnTransferInSourceApp (const std::string &object_name) const
	Error if executing this MooseObject on EXEC_TRANSFER in a source multiapp (from_multiapp, e.g. More...

Point	getPointInTargetAppFrame (const Point &p, unsigned int local_i_to, const std::string &phase) const
	Get the target app point from a point in the reference frame. More...

void	checkMultiAppExecuteOn ()
	Helper method for checking the 'check_multiapp_execute_on' flag. More...

void	checkVariable (const FEProblemBase &fe_problem, const VariableName &var_name, const std::string &param_name="") const
	Helper for checking a problem for a variable. More...

void	extendBoundingBoxes (const Real factor, std::vector< libMesh::BoundingBox > &bboxes) const
	Extends bounding boxes to avoid missing points. More...

template<typename T , typename... Args>
T &	declareRestartableData (const std::string &data_name, Args &&... args)
	Declare a piece of data as "restartable" and initialize it. More...

template<typename T , typename... Args>
ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
	Declares a piece of "managed" restartable data and initialize it. More...

template<typename T , typename... Args>
const T &	getRestartableData (const std::string &data_name) const
	Declare a piece of data as "restartable" and initialize it Similar to `declareRestartableData` but returns a const reference to the object. More...

template<typename T , typename... Args>
T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
	Declare a piece of data as "restartable" and initialize it. More...

template<typename T , typename... Args>
T &	declareRecoverableData (const std::string &data_name, Args &&... args)
	Declare a piece of data as "recoverable" and initialize it. More...

template<typename T , typename... Args>
T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
	Declare a piece of data as "restartable". More...

template<typename T , typename... Args>
T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
	Declare a piece of data as "restartable". More...

std::string	restartableName (const std::string &data_name) const
	Gets the name of a piece of restartable data given a data name, adding the system name and object name prefix. More...

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const
	Call to register a named section for timing. More...

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
	Call to register a named section for timing. More...

std::string	timedSectionName (const std::string &section_name) const


std::vector< libMesh::BoundingBox >	getFromBoundingBoxes ()
	Return the bounding boxes of all the "from" domains, including all the domains not local to this processor. More...

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes (BoundaryID boundary_id)

Static Protected Member Functions
static void	addUserObjectExecutionCheckParam (InputParameters &params)
	Add the execution order check parameter (to skip the warning if needed) More...

static void	addBBoxFactorParam (InputParameters &params)
	Add the bounding box factor parameter to the supplied input parameters. More...

static void	transformBoundingBox (libMesh::BoundingBox &box, const MultiAppCoordTransform &transform)
	Transform a bounding box according to the transformations in the provided coordinate transformation object. More...

Protected Attributes
const std::vector< unsigned int >	_from_var_components
	Origin array/vector variable components. More...

const std::vector< unsigned int >	_to_var_components
	Target array/vector variable components. More...

const bool	_use_bounding_boxes
	Whether to use bounding boxes to determine the applications that may receive point requests then send value data, and at other various checks. More...

const bool	_use_nearest_app
	Whether to keep track of the distance from the requested point to the app position. More...

const Positions *	_nearest_positions_obj

bool	_source_app_must_contain_point
	Whether the source app mesh must actually contain the points for them to be considered or whether the bounding box is enough. More...

std::set< SubdomainID >	_from_blocks
	Origin block(s) restriction. More...

std::set< SubdomainID >	_to_blocks
	Target block(s) restriction. More...

std::set< BoundaryID >	_to_boundaries
	Target boundary(ies) restriction. More...

std::set< BoundaryID >	_from_boundaries
	Origin boundary(ies) restriction. More...

std::vector< const MeshDivision * >	_from_mesh_divisions
	Division of the origin mesh. More...

std::vector< const MeshDivision * >	_to_mesh_divisions
	Division of the target mesh. More...

const MooseEnum &	_from_mesh_division_behavior
	How to use the origin mesh divisions to restrict the transfer. More...

const MooseEnum &	_to_mesh_division_behavior
	How to use the target mesh divisions to restrict the transfer. More...

const bool	_elemental_boundary_restriction_on_sides
	Whether elemental variable boundary restriction is considered by element side or element nodes. More...

std::vector< std::unique_ptr< libMesh::PointLocatorBase > >	_from_point_locators
	Point locators, useful to examine point location with regards to domain restriction. More...

std::vector< unsigned int >	_global_app_start_per_proc
	First app each processor owns, indexed by processor If no app on the processor, will have a -1 for the app start instead. More...

bool	_greedy_search
	Whether or not a greedy strategy will be used If true, all the partitions will be checked for a given outgoing point. More...

bool	_search_value_conflicts
	Whether to look for conflicts between origin points, multiple valid values for a target point. More...

bool	_already_output_search_value_conflicts
	Whether we already output the search value conflicts. More...

const unsigned int	_search_value_conflicts_max_log
	How many conflicts are output to console. More...

const std::vector< VariableName >	_from_var_names
	Name of variables transferring from. More...

const std::vector< AuxVariableName >	_to_var_names
	Name of variables transferring to. More...

VariableName	_from_var_name
	This values are used if a derived class only supports one variable. More...

AuxVariableName	_to_var_name

bool	_preserve_transfer
	If this transfer is going to conserve the physics. More...

std::vector< PostprocessorName >	_from_postprocessors_to_be_preserved
	Postprocessor evaluates an adjuster for the source physics. More...

std::vector< PostprocessorName >	_to_postprocessors_to_be_preserved
	Postprocessor evaluates an adjuster for the target physics. More...

std::shared_ptr< MultiApp >	_multi_app
	Deprecated class attribute for compatibility with the apps. More...

std::vector< FEProblemBase * >	_to_problems

std::vector< FEProblemBase * >	_from_problems

std::vector< libMesh::EquationSystems * >	_to_es

std::vector< libMesh::EquationSystems * >	_from_es

std::vector< MooseMesh * >	_to_meshes

std::vector< MooseMesh * >	_from_meshes

std::vector< Point >	_to_positions

std::vector< Point >	_from_positions

std::vector< std::unique_ptr< MultiAppCoordTransform > >	_to_transforms

std::vector< std::unique_ptr< MultiAppCoordTransform > >	_from_transforms

const bool	_skip_coordinate_collapsing
	Whether to skip coordinate collapsing (transformations of coordinates between applications using different frames of reference) More...

bool	_displaced_source_mesh
	True if displaced mesh is used for the source mesh, otherwise false. More...

bool	_displaced_target_mesh
	True if displaced mesh is used for the target mesh, otherwise false. More...

std::vector< unsigned int >	_to_local2global_map
	Given local app index, returns global app index. More...

std::vector< unsigned int >	_from_local2global_map
	Given local app index, returns global app index. More...

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

THREAD_ID	_tid

MultiMooseEnum	_directions
	The directions this Transfer is to be executed on. More...

const bool &	_enabled
	Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects. More...

MooseApp &	_app
	The MOOSE application this is associated with. More...

Factory &	_factory
	The Factory associated with the MooseApp. More...

ActionFactory &	_action_factory
	Builds Actions. More...

const std::string &	_type
	The type of this class. More...

const std::string &	_name
	The name of this class. More...

const InputParameters &	_pars
	The object's parameters. More...

const Parallel::Communicator &	_communicator

const ExecFlagEnum &	_execute_enum
	Execute settings for this object. More...

const ExecFlagType &	_current_execute_flag
	Reference to FEProblemBase. More...

MooseApp &	_restartable_app
	Reference to the application. More...

const std::string	_restartable_system_name
	The system name this object is in. More...

const THREAD_ID	_restartable_tid
	The thread ID for this object. More...

const bool	_restartable_read_only
	Flag for toggling read only status (see ReporterData) More...

MooseApp &	_pg_moose_app
	The MooseApp that owns the PerfGraph. More...

const std::string	_prefix
	A prefix to use for all sections. More...


MooseEnum	_direction

MooseEnum	_current_direction

Private Member Functions
bool	usesMooseAppCoordTransform () const override
	Whether this transfer handles non-translation-based transformations, e.g. More...

void	evaluateInterpValuesWithUserObjects (const std::vector< BoundingBox > &local_bboxes, const std::vector< std::pair< Point, unsigned int >> &incoming_points, std::vector< std::pair< Real, Real >> &outgoing_vals)

Private Attributes
const std::string	_user_object_name
	Name of the source user object in all the source problems. More...

std::vector< BoundingBox >	_local_bboxes

Detailed Description

Transfers values computed in the origin mesh by the source user object spatialValue() routine at locations in the target mesh.

Definition at line 20 of file MultiAppGeneralFieldUserObjectTransfer.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

The parameter type this interface expects for a data file name.

Definition at line 27 of file DataFileInterface.h.

Member Enumeration Documentation

◆ DIRECTION

enum Transfer::DIRECTION

inherited

Enumerator
TO_MULTIAPP
FROM_MULTIAPP
BETWEEN_MULTIAPP

Definition at line 68 of file Transfer.h.

   {
     TO_MULTIAPP,
     FROM_MULTIAPP,
     BETWEEN_MULTIAPP
   };

◆ MeshDivisionTransferUse

enum MultiAppGeneralFieldTransfer::MeshDivisionTransferUse

protectedinherited

Matching enum for the mesh division behaviors.

Enumerator
RESTRICTION
MATCH_DIVISION_INDEX
MATCH_SUBAPP_INDEX

Definition at line 246 of file MultiAppGeneralFieldTransfer.h.

   {
     RESTRICTION,
     MATCH_DIVISION_INDEX,
     MATCH_SUBAPP_INDEX
   };

Constructor & Destructor Documentation

◆ MultiAppGeneralFieldUserObjectTransfer()

MultiAppGeneralFieldUserObjectTransfer::MultiAppGeneralFieldUserObjectTransfer ( const InputParameters & parameters )

Definition at line 49 of file MultiAppGeneralFieldUserObjectTransfer.C.

   : MultiAppGeneralFieldTransfer(parameters),
     _user_object_name(getParam<UserObjectName>("source_user_object"))
 {
   if (_to_var_names.size() > 1)
     paramError("variable", "Only one variable at a time is supported by this transfer");
 
   // Block restriction does not make sense if we're ok with extrapolating
   if (isParamValid("from_blocks") && !_source_app_must_contain_point &&
       !parameters.isParamSetByUser("extrapolation_constant"))
     paramError("from_app_must_contain_point",
                "Source block restriction cannot be used at the same type as allowing extrapolation"
                " of values for a user object transfer (with 'from_app_must_contain_point=false') "
                " unless an extrapolation constant is provided (with 'extrapolation_constant')");
 
   // Nearest point isn't well defined for sending app-based data from main app to a multiapp
   if (_nearest_positions_obj && isParamValid("to_multi_app") && !isParamValid("from_multi_app"))
     paramError("use_nearest_position",
                "Cannot use nearest-position algorithm when sending from the main application");
 }

Member Function Documentation

◆ acceptPointInOriginMesh()

bool MultiAppGeneralFieldTransfer::acceptPointInOriginMesh	(	unsigned int	i_from,
		const std::vector< BoundingBox > &	local_bboxes,
		const Point &	pt,
		const unsigned int	mesh_div,
		Real &	distance
	)		const

protectedinherited

Definition at line 1530 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldShapeEvaluationTransfer::evaluateInterpValuesWithMeshFunctions(), and evaluateInterpValuesWithUserObjects().

 {
   if (_use_bounding_boxes && !local_bboxes[i_from].contains_point(pt))
     return false;
   else
   {
     auto * pl = _from_point_locators[i_from].get();
     const auto from_global_num = getGlobalSourceAppIndex(i_from);
     const auto transformed_pt = _from_transforms[from_global_num]->mapBack(pt);
 
     // Check point against source block restriction
     if (!_from_blocks.empty() && !inBlocks(_from_blocks, pl, transformed_pt))
       return false;
 
     // Check point against source boundary restriction. Block restriction will speed up the search
     if (!_from_boundaries.empty() &&
         !onBoundaries(_from_boundaries, _from_blocks, *_from_meshes[i_from], pl, transformed_pt))
       return false;
 
     // Check point against the source mesh division
     if ((!_from_mesh_divisions.empty() || !_to_mesh_divisions.empty()) &&
         !acceptPointMeshDivision(transformed_pt, i_from, only_from_mesh_div))
       return false;
 
     // Get nearest position (often a subapp position) for the target point
     // We want values from the child app that is closest to the same position as the target
     Point nearest_position_source;
     if (_nearest_positions_obj)
     {
       const bool initial = _fe_problem.getCurrentExecuteOnFlag() == EXEC_INITIAL;
       // The search for the nearest position is done in the reference frame
       const Point nearest_position = _nearest_positions_obj->getNearestPosition(pt, initial);
       nearest_position_source = _nearest_positions_obj->getNearestPosition(
           (*_from_transforms[from_global_num])(Point(0, 0, 0)), initial);
 
       if (!_skip_coordinate_collapsing &&
           _from_transforms[from_global_num]->hasNonTranslationTransformation())
         mooseError("Rotation and scaling currently unsupported with nearest positions transfer.");
 
       // Compute distance to nearest position and nearest position source
       const Real distance_to_position_nearest_source = (pt - nearest_position_source).norm();
       const Real distance_to_nearest_position = (pt - nearest_position).norm();
 
       // Source (usually app position) is not closest to the same positions as the target, dont
       // send values. We check the distance instead of the positions because if they are the same
       // that means there's two equidistant positions and we would want to capture that as a "value
       // conflict"
       if (!MooseUtils::absoluteFuzzyEqual(distance_to_position_nearest_source,
                                           distance_to_nearest_position))
         return false;
 
       // Set the distance as the distance from the nearest position to the target point
       distance = distance_to_position_nearest_source;
     }
 
     // Check that the app actually contains the origin point
     // We dont need to check if we already found it in a block or a boundary
     if (_from_blocks.empty() && _from_boundaries.empty() && _source_app_must_contain_point &&
         !inMesh(pl, transformed_pt))
       return false;
   }
   return true;
 }

◆ acceptPointMeshDivision()

bool MultiAppGeneralFieldTransfer::acceptPointMeshDivision	(	const Point &	pt,
		const unsigned int	i_local,
		const unsigned int	only_from_this_mesh_div
	)		const

protectedinherited

Whether a point lies inside the mesh division delineated by the MeshDivision object.

Parameters

pt	point to examine, in the local coordinates (source frame for from_direction=true)
i_local	the index of the problem to consider, holding the mesh division to examine
only_from_this_mesh_div	a mesh division index that must be matched when the to/from_mesh_division_behavior for the direction examined is MATCH_DIVISION/SUBAPP_INDEX It is ignored otherwise

Definition at line 1717 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh().

 {
   // This routine can also be called to examine if the to_mesh_division index matches the current
   // source subapp index
   unsigned int source_mesh_div = MooseMeshDivision::INVALID_DIVISION_INDEX - 1;
   if (!_from_mesh_divisions.empty())
     source_mesh_div = _from_mesh_divisions[i_local]->divisionIndex(pt);
 
   // If the point is not indexed in the source division
   if (!_from_mesh_divisions.empty() && source_mesh_div == MooseMeshDivision::INVALID_DIVISION_INDEX)
     return false;
   // If the point is not the at the same index in the target and the origin meshes, reject
   else if ((_from_mesh_division_behavior == MeshDivisionTransferUse::MATCH_DIVISION_INDEX ||
             _to_mesh_division_behavior == MeshDivisionTransferUse::MATCH_DIVISION_INDEX) &&
            source_mesh_div != only_from_this_mesh_div)
     return false;
   // If the point is at a certain division index that is not the same as the index of the subapp
   // we wanted the information to be from for that point, reject
   else if (_from_mesh_division_behavior == MeshDivisionTransferUse::MATCH_SUBAPP_INDEX &&
            source_mesh_div != only_from_this_mesh_div)
     return false;
   else if (_to_mesh_division_behavior == MeshDivisionTransferUse::MATCH_SUBAPP_INDEX &&
            only_from_this_mesh_div != getGlobalSourceAppIndex(i_local))
     return false;
   else
     return true;
 }

◆ addBBoxFactorParam()

void MultiAppTransfer::addBBoxFactorParam ( InputParameters & params )

staticprotectedinherited

Add the bounding box factor parameter to the supplied input parameters.

Definition at line 59 of file MultiAppTransfer.C.

Referenced by MultiAppShapeEvaluationTransfer::validParams(), MultiAppProjectionTransfer::validParams(), and MultiAppNearestNodeTransfer::validParams().

 {
   params.addRangeCheckedParam<Real>(
       "bbox_factor",
       1 + TOLERANCE,
       "bbox_factor>0",
       "Multiply bounding box width (in all directions) by the prescribed factor. Values less than "
       "1 will shrink the bounding box; values greater than 1 will enlarge the bounding box. It is "
       "generally not advised to ever shrink the bounding box. On the other hand it may be helpful "
       "to enlarge the bounding box. Larger bounding boxes will lead to more accurate determination "
       "of the closest node/element with the tradeoff of more communication.");
 }

◆ addSkipCoordCollapsingParam()

void MultiAppTransfer::addSkipCoordCollapsingParam ( InputParameters & params )

staticinherited

Add the option to skip coordinate collapsing in coordinate transformation operations Note: this is used by Actions creating transfers as well.

Definition at line 73 of file MultiAppTransfer.C.

Referenced by MultiAppTransfer::validParams().

 {
   params.addParam<bool>(
       "skip_coordinate_collapsing",
       true,
       "Whether to skip coordinate collapsing (translation and rotation are still performed, only "
       "XYZ, RZ etc collapsing is skipped) when performing mapping and inverse "
       "mapping coordinate transformation operations. This parameter should only "
       "be set by users who really know what they're doing.");
   params.addParamNamesToGroup("skip_coordinate_collapsing", "Advanced");
 }

◆ addUserObjectExecutionCheckParam()

void MultiAppTransfer::addUserObjectExecutionCheckParam ( InputParameters & params )

staticprotectedinherited

Add the execution order check parameter (to skip the warning if needed)

Definition at line 86 of file MultiAppTransfer.C.

Referenced by MultiAppPostprocessorToAuxScalarTransfer::validParams(), MultiAppVectorPostprocessorTransfer::validParams(), validParams(), MultiAppPostprocessorTransfer::validParams(), and MultiAppUserObjectTransfer::validParams().

 {
   params.addParam<bool>("warn_source_object_execution_schedule",
                         true,
                         "Emit a warning when the transfer execution schedule is detected to lag "
                         "information from the user object. Note that the check cannot detect all "
                         "potential wrong combinations of user-object/transfer execution schedules");
 }

◆ callMooseError() [1/2]

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node = `nullptr`
	)		const

inherited

External method for calling moose error with added object context.

Parameters

msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix

Definition at line 102 of file MooseBase.C.

Referenced by InputParameters::callMooseError(), MooseBase::mooseDocumentedError(), MooseBase::mooseError(), and MooseBase::mooseErrorNonPrefixed().

 {
   callMooseError(&_app, _pars, msg, with_prefix, node);
 }

◆ callMooseError() [2/2]

void MooseBase::callMooseError	(	MooseApp *const	app,
		const InputParameters &	params,
		std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node
	)

staticinherited

External method for calling moose error with added object context.

Needed so that objects without the MooseBase context (InputParameters) can call errors with context

Parameters

app	The app pointer (if available); adds multiapp context and clears the console
params	The parameters, needed to obtain object information
msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix

Definition at line 110 of file MooseBase.C.

 {
   if (!node)
     node = MooseBase::getHitNode(params);
 
   std::string multiapp_prefix = "";
   if (app)
   {
     if (!app->isUltimateMaster())
       multiapp_prefix = app->name();
     app->getOutputWarehouse().mooseConsole();
   }
 
   if (with_prefix)
     // False here because the hit context will get processed by the node
     msg = messagePrefix(params, false) + msg;
 
   moose::internal::mooseErrorRaw(msg, multiapp_prefix, node);
 }

◆ checkMultiAppExecuteOn()

void MultiAppTransfer::checkMultiAppExecuteOn ( )

protectedinherited

Helper method for checking the 'check_multiapp_execute_on' flag.

This method was added to allow the check to be delayed by child classes, see StochasticToolsTransfer for an example.

Definition at line 173 of file MultiAppTransfer.C.

Referenced by MultiAppTransfer::MultiAppTransfer().

 {
   if (_from_multi_app && !_to_multi_app)
     if (getExecuteOnEnum() != _from_multi_app->getExecuteOnEnum())
       mooseDoOnce(
           mooseWarning("MultiAppTransfer execute_on flags do not match associated from_multi_app "
                        "execute_on flags"));
 
   if (_to_multi_app && !_from_multi_app)
     if (getExecuteOnEnum() != _to_multi_app->getExecuteOnEnum())
       mooseDoOnce(
           mooseWarning("MultiAppTransfer execute_on flags do not match associated to_multi_app "
                        "execute_on flags"));
 
   // In the case of siblings transfer, the check will be looser
   if (_from_multi_app && _to_multi_app)
     if (getExecuteOnEnum() != _from_multi_app->getExecuteOnEnum() &&
         getExecuteOnEnum() != _to_multi_app->getExecuteOnEnum())
       mooseDoOnce(
           mooseWarning("MultiAppTransfer execute_on flags do not match associated to_multi_app "
                        "and from_multi_app execute_on flags"));
 }

◆ checkParentAppUserObjectExecuteOn()

void MultiAppTransfer::checkParentAppUserObjectExecuteOn ( const std::string & object_name ) const

protectedinherited

Checks the execute_on flags for user object transfers with user objects on the source app which is also the parent app.

This is to prevent a common mistake lagging the data from the user object

Definition at line 672 of file MultiAppTransfer.C.

Referenced by MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppPostprocessorTransfer::execute(), execute(), MultiAppUserObjectTransfer::execute(), and MultiAppVectorPostprocessorTransfer::executeToMultiapp().

 {
   // Source app is not the parent, most execution schedules are fine since the transfer occurs after
   // the app has run NOTE: not true for siblings transfer
   if (hasFromMultiApp())
     return;
   // Get user object from parent. We don't know the type
   const auto & uo = _fe_problem.getUserObject<UserObject>(object_name);
   // If we are executing on transfers, every additional schedule is not a problem
   if (uo.getExecuteOnEnum().contains(EXEC_TRANSFER))
     return;
   // If we are transferring on the same schedule as we are executing, we are lagging. Is it on
   // purpose? We don't know, so we will give a warning unless silenced.
   // The derived-classes offer the parameter to silence this warning
   // Note: UOs execute before transfers on INITIAL so it's not a problem at this time
   if (uo.getExecuteOnEnum().contains(_fe_problem.getCurrentExecuteOnFlag()) &&
       _fe_problem.getCurrentExecuteOnFlag() != EXEC_INITIAL)
     if (!isParamValid("warn_source_object_execution_schedule") ||
         getParam<bool>("warn_source_object_execution_schedule"))
       uo.paramWarning("execute_on",
                       "This UserObject-derived class is being executed on '" +
                           Moose::stringify(_fe_problem.getCurrentExecuteOnFlag()) +
                           "' and also providing values for the '" + name() +
                           "' transfer, on that same execution schedule. Because user objects are "
                           "executed after transfers are, this means the values provided by this "
                           "user object are lagged. If you are ok with this, then set the "
                           "'warn_source_object_execution_schedule' parameter to false in this "
                           "Transfer. If not, then execute '" +
                           uo.name() +
                           "' on TRANSFER by adding it to the 'execute_on' vector parameter.");
 }

◆ checkSiblingsTransferSupported()

virtual void MultiAppGeneralFieldTransfer::checkSiblingsTransferSupported ( ) const

inlineoverrideprotectedvirtualinherited

Siblings transfers fully supported.

Reimplemented from MultiAppTransfer.

Definition at line 57 of file MultiAppGeneralFieldTransfer.h.

57 {}

◆ checkVariable()

void MultiAppTransfer::checkVariable	(	const FEProblemBase &	fe_problem,
		const VariableName &	var_name,
		const std::string &	param_name = `""`
	)		const

protectedinherited

Helper for checking a problem for a variable.

Parameters

fe_problem	The problem that should contain the variable
var_name	The name of the variable that should exist within the problem
param_name	(optional) The input file parameter name for throwing paramError, if not provided a mooseError is thrown.

Definition at line 613 of file MultiAppTransfer.C.

Referenced by MultiAppDofCopyTransfer::transfer().

 {
   if (!fe_problem.hasVariable(var_name))
   {
     if (param_name.empty())
       mooseError("The variable '", var_name, "' does not exist.");
     else
       paramError(param_name, "The variable '", var_name, "' does not exist.");
   }
 }

◆ closestToPosition()

bool MultiAppGeneralFieldTransfer::closestToPosition	(	unsigned int	pos_index,
		const Point &	pt
	)		const

protectedinherited

Whether a point is closest to a position at the index specified than any other position.

Parameters

pos_index	the index of the position to consider in the positions vector
pt	the point

Returns: whether the point is closest to this position than any other in the positions vector

Definition at line 1747 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldNearestLocationTransfer::buildKDTrees(), and MultiAppGeneralFieldNearestLocationTransfer::checkRestrictionsForSource().

 {
   mooseAssert(_nearest_positions_obj, "Should not be here without a positions object");
   if (!_skip_coordinate_collapsing)
     paramError("skip_coordinate_collapsing", "Coordinate collapsing not implemented");
   bool initial = _fe_problem.getCurrentExecuteOnFlag() == EXEC_INITIAL;
   if (!_search_value_conflicts)
     // Faster to just compare the index
     return pos_index == _nearest_positions_obj->getNearestPositionIndex(pt, initial);
   else
   {
     // Get the distance to the position and see if we are missing a value just because the position
     // is not officially the closest, but it is actually at the same distance
     const auto nearest_position = _nearest_positions_obj->getNearestPosition(pt, initial);
     const auto nearest_position_at_index = _nearest_positions_obj->getPosition(pos_index, initial);
     Real distance_to_position_at_index = (pt - nearest_position_at_index).norm();
     const Real distance_to_nearest_position = (pt - nearest_position).norm();
 
     if (!MooseUtils::absoluteFuzzyEqual(distance_to_position_at_index,
                                         distance_to_nearest_position))
       return false;
     // Actually the same position (point)
     else if (nearest_position == nearest_position_at_index)
       return true;
     else
     {
       mooseWarning("Two equidistant positions ",
                    nearest_position,
                    " and ",
                    nearest_position_at_index,
                    " detected near point ",
                    pt);
       return true;
     }
   }
 }

◆ connectControllableParams()

void MooseBase::connectControllableParams	(	const std::string &	parameter,
		const std::string &	object_type,
		const std::string &	object_name,
		const std::string &	object_parameter
	)		const

inherited

Connect controllable parameter of this action with the controllable parameters of the objects added by this action.

Parameters

parameter	Name of the controllable parameter of this action
object_type	Type of the object added by this action.
object_name	Name of the object added by this action.
object_parameter	Name of the parameter of the object.

Definition at line 74 of file MooseBase.C.

 {
   auto & factory = _app.getFactory();
   auto & ip_warehouse = _app.getInputParameterWarehouse();
 
   MooseObjectParameterName primary_name(uniqueName(), parameter);
   const auto base_type = factory.getValidParams(object_type).getBase();
   MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
   ip_warehouse.addControllableParameterConnection(primary_name, secondary_name);
 
   const auto & tags = _pars.get<std::vector<std::string>>("control_tags");
   for (const auto & tag : tags)
   {
     if (!tag.empty())
     {
       // Only adds the parameter with the different control tags if the derived class
       // properly registers the parameter to its own syntax
       MooseObjectParameterName tagged_name(tag, name(), parameter);
       ip_warehouse.addControllableParameterConnection(
           tagged_name, secondary_name, /*error_on_empty=*/false);
     }
   }
 }

◆ currentDirection()

MooseEnum Transfer::currentDirection ( )

inlineinherited

Definition at line 85 of file Transfer.h.

85 { return _current_direction; }

Transfer::_current_direction

MooseEnum _current_direction

Definition: Transfer.h:106

◆ customSetup()

virtual void SetupInterface::customSetup ( const ExecFlagType & )

inlinevirtualinherited

Gets called in FEProblemBase::execute() for execute flags other than initial, timestep_begin, nonlinear, linear and subdomain.

Reimplemented in Function.

Definition at line 61 of file SetupInterface.h.

61 {}

◆ declareManagedRestartableDataWithContext()

template<typename T , typename... Args>

Restartable::ManagedValue< T > Restartable::declareManagedRestartableDataWithContext	(	const std::string &	data_name,
		void *	context,
		Args &&...	args
	)

protectedinherited

Declares a piece of "managed" restartable data and initialize it.

Here, "managed" restartable data means that the caller can destruct this data upon destruction of the return value of this method. Therefore, this ManagedValue<T> wrapper should survive after the final calls to dataStore() for it. That is... at the very end.

This is needed for objects whose destruction ordering is important, and enables natural c++ destruction in reverse construction order of the object that declares it.

See delcareRestartableData and declareRestartableDataWithContext for more information.

Definition at line 276 of file Restartable.h.

 {
   auto & data_ptr =
       declareRestartableDataHelper<T>(data_name, context, std::forward<Args>(args)...);
   return Restartable::ManagedValue<T>(data_ptr);
 }

◆ declareRecoverableData()

template<typename T , typename... Args>

T & Restartable::declareRecoverableData	(	const std::string &	data_name,
		Args &&...	args
	)

protectedinherited

Declare a piece of data as "recoverable" 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)
args	Arguments to forward to the constructor of the data

Definition at line 351 of file Restartable.h.

 {
   const auto full_name = restartableName(data_name);
 
   registerRestartableNameWithFilterOnApp(full_name, Moose::RESTARTABLE_FILTER::RECOVERABLE);
 
   return declareRestartableDataWithContext<T>(data_name, nullptr, std::forward<Args>(args)...);
 }

◆ declareRestartableData()

template<typename T , typename... Args>

T & Restartable::declareRestartableData	(	const std::string &	data_name,
		Args &&...	args
	)

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)
args	Arguments to forward to the constructor of the data

Definition at line 269 of file Restartable.h.

 {
   return declareRestartableDataWithContext<T>(data_name, nullptr, std::forward<Args>(args)...);
 }

◆ declareRestartableDataWithContext()

template<typename T , typename... Args>

T & Restartable::declareRestartableDataWithContext	(	const std::string &	data_name,
		void *	context,
		Args &&...	args
	)

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)
context	Context pointer that will be passed to the load and store functions
args	Arguments to forward to the constructor of the data

Definition at line 294 of file Restartable.h.

 {
   return declareRestartableDataHelper<T>(data_name, context, std::forward<Args>(args)...).set();
 }

◆ declareRestartableDataWithObjectName()

template<typename T , typename... Args>

T & Restartable::declareRestartableDataWithObjectName	(	const std::string &	data_name,
		const std::string &	object_name,
		Args &&...	args
	)

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.
args	Arguments to forward to the constructor of the data

Definition at line 323 of file Restartable.h.

 {
   return declareRestartableDataWithObjectNameWithContext<T>(
       data_name, object_name, nullptr, std::forward<Args>(args)...);
 }

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T , typename... Args>

T & Restartable::declareRestartableDataWithObjectNameWithContext	(	const std::string &	data_name,
		const std::string &	object_name,
		void *	context,
		Args &&...	args
	)

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
args	Arguments to forward to the constructor of the data

Definition at line 333 of file Restartable.h.

 {
   std::string old_name = _restartable_name;
 
   _restartable_name = object_name;
 
   T & value = declareRestartableDataWithContext<T>(data_name, context, std::forward<Args>(args)...);
 
   _restartable_name = old_name;
 
   return value;
 }

◆ detectConflict()

bool MultiAppGeneralFieldTransfer::detectConflict	(	Real	value_1,
		Real	value_2,
		Real	distance_1,
		Real	distance_2
	)		const

protectedinherited

Detects whether two source values are valid and equidistant for a desired target location.

Parameters

value_1	value from the first value source / subapp
value_2	value from the second value source / subapp
distance_1	distance from the first source
distance_2	distance from the second source

Returns: true if the values are different and distances from the source points/apps are the same

Definition at line 1965 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldTransfer::cacheIncomingInterpVals(), MultiAppGeneralFieldShapeEvaluationTransfer::evaluateInterpValuesWithMeshFunctions(), and evaluateInterpValuesWithUserObjects().

 {
   // No conflict if we're not looking for them
   if (_search_value_conflicts)
     // Only consider conflicts if the values are valid and different
     if (current_value != GeneralFieldTransfer::BetterOutOfMeshValue &&
         new_value != GeneralFieldTransfer::BetterOutOfMeshValue &&
         !MooseUtils::absoluteFuzzyEqual(current_value, new_value))
       // Conflict only occurs if the origin points are equidistant
       if (MooseUtils::absoluteFuzzyEqual(current_distance, new_distance))
         return true;
   return false;
 }

◆ direction()

MooseEnum Transfer::direction ( )

inlineinherited

The current direction that this Transfer is going in. direction() is to be deprecated for currentDirection()

Definition at line 84 of file Transfer.h.

Referenced by Transfer::setCurrentDirection().

84 { return _direction; }

Transfer::_direction

MooseEnum _direction

Definition: Transfer.h:105

◆ directions()

const MultiMooseEnum& Transfer::directions ( )

inlineinherited

The directions this Transfer should be executed on.

Definition at line 79 of file Transfer.h.

79 { return _directions; }

Transfer::_directions

MultiMooseEnum _directions

The directions this Transfer is to be executed on.

Definition: Transfer.h:110

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 39 of file MooseObject.h.

Referenced by EigenKernel::enabled().

39 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

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

Definition: MooseObject.h:50

◆ errorIfObjectExecutesOnTransferInSourceApp()

void MultiAppTransfer::errorIfObjectExecutesOnTransferInSourceApp ( const std::string & object_name ) const

protectedinherited

Error if executing this MooseObject on EXEC_TRANSFER in a source multiapp (from_multiapp, e.g.

child/sibling app). Note that, conversely, when the parent app is the source application, it is usually desired to use EXEC_TRANSFER for a MooseObject that provides the values to transfer.

Parameters

object_name name of the object to check the execute_on flags for

Definition at line 705 of file MultiAppTransfer.C.

Referenced by MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), execute(), MultiAppUserObjectTransfer::execute(), and MultiAppVectorPostprocessorTransfer::executeFromMultiapp().

 {
   // parent app is the source app, EXEC_TRANSFER is fine
   if (!hasFromMultiApp())
     return;
   // Get the app and problem
   const auto & app = getFromMultiApp();
   if (!app->hasApp())
     return;
   const auto & problem = app->appProblemBase(app->firstLocalApp());
   // Use the warehouse to find the object
   std::vector<SetupInterface *> objects_with_exec_on;
   problem.theWarehouse()
       .query()
       .template condition<AttribName>(object_name)
       .template condition<AttribExecOns>(EXEC_TRANSFER)
       .queryInto(objects_with_exec_on);
   if (objects_with_exec_on.size())
     mooseError("Object '" + object_name +
                "' should not be executed on EXEC_TRANSFER, because this transfer has "
                "indicated it does not support it.\nExecuting this object on TIMESTEP_END should be "
                "sufficient to get updated values.");
 }

◆ errorPrefix()

std::string MooseBase::errorPrefix ( const std::string & ) const

inlineinherited

Deprecated message prefix; the error type is no longer used.

Definition at line 260 of file MooseBase.h.

260 { return messagePrefix(); }

MooseBase::messagePrefix

std::string messagePrefix(const bool hit_prefix=true) const

Definition: MooseBase.h:252

◆ evaluateInterpValues()

void MultiAppGeneralFieldUserObjectTransfer::evaluateInterpValues	(	const std::vector< std::pair< Point, unsigned int >> &	incoming_points,
		std::vector< std::pair< Real, Real >> &	outgoing_vals
	)

overrideprotectedvirtual

Implements MultiAppGeneralFieldTransfer.

Definition at line 102 of file MultiAppGeneralFieldUserObjectTransfer.C.

 {
   evaluateInterpValuesWithUserObjects(_local_bboxes, incoming_points, outgoing_vals);
 }

◆ evaluateInterpValuesWithUserObjects()

void MultiAppGeneralFieldUserObjectTransfer::evaluateInterpValuesWithUserObjects	(	const std::vector< BoundingBox > &	local_bboxes,
		const std::vector< std::pair< Point, unsigned int >> &	incoming_points,
		std::vector< std::pair< Real, Real >> &	outgoing_vals
	)

private

Definition at line 110 of file MultiAppGeneralFieldUserObjectTransfer.C.

Referenced by evaluateInterpValues().

 {
   dof_id_type i_pt = 0;
   for (auto & [pt, mesh_div] : incoming_points)
   {
     bool point_found = false;
     outgoing_vals[i_pt].second = GeneralFieldTransfer::BetterOutOfMeshValue;
 
     // Loop on all local origin problems until:
     // - we've found the point in an app and the value at that point is valid
     // - or if looking for conflicts between apps, we must check them all
     for (MooseIndex(_from_problems.size()) i_from = 0;
          i_from < _from_problems.size() &&
          (!point_found || _search_value_conflicts || _nearest_positions_obj);
          ++i_from)
     {
       // User object spatialValue() evaluations do not provide a distance
       Real distance = 1;
       // Check spatial restrictions
       if (!acceptPointInOriginMesh(i_from, local_bboxes, pt, mesh_div, distance))
         continue;
       else
       {
         const auto from_global_num = getGlobalSourceAppIndex(i_from);
 
         // Get user object from the local problem
         const UserObject & user_object =
             _from_problems[i_from]->getUserObjectBase(_user_object_name);
 
         // Use spatial value routine to compute the origin value to transfer
         const auto local_pt = _from_transforms[from_global_num]->mapBack(pt);
         auto val = user_object.spatialValue(local_pt);
 
         // Look for overlaps. The check is not active outside of overlap search because in that
         // case we accept the first value from the lowest ranked process
         // NOTE: There is no guarantee this will be the final value used among all problems
         //       but we register an overlap as soon as two values are possible from this rank
         if (detectConflict(val, outgoing_vals[i_pt].first, distance, outgoing_vals[i_pt].second))
         {
           if (_nearest_positions_obj)
             registerConflict(i_from, 0, pt, distance, true);
           else
             registerConflict(i_from, 0, local_pt, distance, true);
         }
 
         // No need to consider decision factors if value is invalid
         if (val == GeneralFieldTransfer::BetterOutOfMeshValue)
           continue;
         else
           point_found = true;
 
         // Assign value
         if (distance < outgoing_vals[i_pt].second)
         {
           outgoing_vals[i_pt].first = val;
           outgoing_vals[i_pt].second = distance;
         }
       }
     }
 
     if (!point_found)
       outgoing_vals[i_pt] = {GeneralFieldTransfer::BetterOutOfMeshValue,
                              GeneralFieldTransfer::BetterOutOfMeshValue};
 
     // Move to next point
     i_pt++;
   }
 }

◆ execute()

void MultiAppGeneralFieldUserObjectTransfer::execute ( )

overrideprotectedvirtual

Execute the transfer.

Reimplemented from MultiAppGeneralFieldTransfer.

Definition at line 72 of file MultiAppGeneralFieldUserObjectTransfer.C.

 {
   // Execute the user object if it was specified to execute on TRANSFER
   switch (_current_direction)
   {
     case TO_MULTIAPP:
     {
       checkParentAppUserObjectExecuteOn(_user_object_name);
       _fe_problem.computeUserObjectByName(EXEC_TRANSFER, Moose::PRE_AUX, _user_object_name);
       _fe_problem.computeUserObjectByName(EXEC_TRANSFER, Moose::POST_AUX, _user_object_name);
       break;
     }
     case FROM_MULTIAPP:
       errorIfObjectExecutesOnTransferInSourceApp(_user_object_name);
   }
 
   // Perfom the actual transfer
   MultiAppGeneralFieldTransfer::execute();
 }

◆ extendBoundingBoxes()

void MultiAppTransfer::extendBoundingBoxes	(	const Real	factor,
		std::vector< libMesh::BoundingBox > &	bboxes
	)		const

protectedinherited

Extends bounding boxes to avoid missing points.

Definition at line 466 of file MultiAppTransfer.C.

Referenced by MultiAppTransfer::getFromBoundingBoxes(), and MultiAppGeneralFieldTransfer::prepareToTransfer().

 {
   const auto extension_factor = factor - 1;
 
   // Extend (or contract if the extension factor is negative) bounding boxes along all the
   // directions by the same length. Greater than zero values of this member may be necessary because
   // the nearest bounding box does not necessarily give you the closest node/element. It will depend
   // on the partition and geometry. A node/element will more likely find its nearest source
   // element/node by extending bounding boxes. If each of the bounding boxes covers the entire
   // domain, a node/element will be able to find its nearest source element/node for sure, but at
   // the same time, more communication will be involved and can be expensive.
   for (auto & box : bboxes)
   {
     // libmesh set an invalid bounding box using this code
     // for (unsigned int i=0; i<LIBMESH_DIM; i++)
     // {
     //   this->first(i)  =  std::numeric_limits<Real>::max();
     //   this->second(i) = -std::numeric_limits<Real>::max();
     // }
     // If it is an invalid box, we should skip it
     if (box.first(0) == std::numeric_limits<Real>::max())
       continue;
 
     auto width = box.second - box.first;
     box.second += width * extension_factor;
     box.first -= width * extension_factor;
   }
 }

◆ extractLocalFromBoundingBoxes()

void MultiAppGeneralFieldTransfer::extractLocalFromBoundingBoxes ( std::vector< BoundingBox > & local_bboxes )

protectedinherited

Definition at line 871 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldShapeEvaluationTransfer::prepareEvaluationOfInterpValues(), and prepareEvaluationOfInterpValues().

 {
   local_bboxes.resize(_froms_per_proc[processor_id()]);
   // Find the index to the first of this processor's local bounding boxes.
   unsigned int local_start = 0;
   for (processor_id_type i_proc = 0; i_proc < n_processors() && i_proc != processor_id(); ++i_proc)
     local_start += _froms_per_proc[i_proc];
 
   // Extract the local bounding boxes.
   for (const auto i_from : make_range(_froms_per_proc[processor_id()]))
     local_bboxes[i_from] = _from_bboxes[local_start + i_from];
 }

◆ find_sys()

System * Transfer::find_sys	(	libMesh::EquationSystems &	es,
		const std::string &	var_name
	)

staticinherited

Small helper function for finding the system containing the variable.

Note that this implies that variable names are unique across all systems!

Parameters

es	The EquationSystems object to be searched.
var_name	The name of the variable you are looking for.

Note that this implies that variable names are unique across all systems!

Definition at line 91 of file Transfer.C.

Referenced by MultiAppGeneralFieldTransfer::examineLocalValueConflicts(), MultiAppGeneralFieldTransfer::examineReceivedValueConflicts(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppGeneralFieldTransfer::extractOutgoingPoints(), MultiAppGeneralFieldTransfer::setSolutionVectorValues(), and MultiAppShapeEvaluationTransfer::transferVariable().

 {
   // Find the system this variable is from
   for (unsigned int i = 0; i < es.n_systems(); i++)
     if (es.get_system(i).has_variable(var_name))
       return &es.get_system(i);
 
   ::mooseError("Unable to find variable " + var_name + " in any system.");
 
   // Unreachable
   return &es.get_system(0);
 }

◆ getAppInfo()

void MultiAppGeneralFieldTransfer::getAppInfo ( )

overridevirtualinherited

This method will fill information into the convenience member variables (_to_problems, _from_meshes, etc.)

Reimplemented from MultiAppTransfer.

Definition at line 422 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldTransfer::execute().

 {
   MultiAppFieldTransfer::getAppInfo();
 
   // Create the point locators to locate evaluation points in the origin mesh(es)
   _from_point_locators.resize(_from_problems.size());
   for (const auto i_from : index_range(_from_problems))
   {
     const auto & from_moose_mesh = _from_problems[i_from]->mesh(_displaced_source_mesh);
     _from_point_locators[i_from] =
         PointLocatorBase::build(TREE_LOCAL_ELEMENTS, from_moose_mesh.getMesh());
     _from_point_locators[i_from]->enable_out_of_mesh_mode();
   }
 }

◆ getBase()

const std::string& MooseBase::getBase ( ) const

inlineinherited

Returns: The registered base for this object (set via InputParameters::registerBase())

Definition at line 143 of file MooseBase.h.

Referenced by Factory::copyConstruct(), and MooseBase::uniqueParameterName().

143 { return _pars.getBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

InputParameters::getBase

const std::string & getBase() const

Definition: InputParameters.C:497

◆ getCheckedPointerParam()

template<typename T >

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

inherited

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 428 of file MooseBase.h.

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

◆ getDataFileName()

std::string DataFileInterface::getDataFileName ( const std::string & param ) const

inherited

Deprecated method.

The data file paths are now automatically set within the InputParameters object, so using getParam<DataFileName>("param_name") is now sufficient.

Definition at line 21 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileName() is deprecated. The file path is now directly set "
                           "within the InputParameters.\nUse getParam<DataFileName>(\"",
                           param,
                           "\") instead.");
   return _parent.getParam<DataFileName>(param);
 }

◆ getDataFileNameByName()

std::string DataFileInterface::getDataFileNameByName ( const std::string & relative_path ) const

inherited

Deprecated method.

Use getDataFilePath() instead.

Definition at line 31 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileNameByName() is deprecated. Use getDataFilePath(\"",
                           relative_path,
                           "\") instead.");
   return getDataFilePath(relative_path);
 }

◆ getDataFilePath()

std::string DataFileInterface::getDataFilePath ( const std::string & relative_path ) const

inherited

Returns the path of a data file for a given relative file path.

This can be used for hardcoded datafile names and will search the same locations as getDataFileName

Definition at line 40 of file DataFileInterface.C.

Referenced by DataFileInterface::getDataFileNameByName().

 {
   // This should only ever be used with relative paths. There is no point to
   // use this search path with an absolute path.
   if (std::filesystem::path(relative_path).is_absolute())
     _parent.mooseWarning("While using getDataFilePath(\"",
                          relative_path,
                          "\"): This API should not be used for absolute paths.");
 
   // Throw on error so that if getPath() fails, we can throw an error
   // with the context of _parent.mooseError()
   const auto throw_on_error_before = Moose::_throw_on_error;
   Moose::_throw_on_error = true;
   std::optional<std::string> error;
 
   // This will search the data paths for this relative path
   Moose::DataFileUtils::Path found_path;
   try
   {
     found_path = Moose::DataFileUtils::getPath(relative_path);
   }
   catch (std::exception & e)
   {
     error = e.what();
   }
 
   Moose::_throw_on_error = throw_on_error_before;
   if (error)
     _parent.mooseError(*error);
 
   mooseAssert(found_path.context == Moose::DataFileUtils::Context::DATA,
               "Should only ever obtain data");
   mooseAssert(found_path.data_name, "Should be set");
 
   const std::string msg =
       "Using data file '" + found_path.path + "' from " + *found_path.data_name + " data";
   _parent.mooseInfo(msg);
 
   return found_path.path;
 }

◆ getEquationSystem()

EquationSystems & MultiAppFieldTransfer::getEquationSystem	(	FEProblemBase &	problem,
		bool	use_displaced
	)		const

protectedinherited

Returns the Problem's equation system, displaced or not Be careful! If you transfer TO a displaced system you will likely need a synchronization So most transfers reach the non-displaced system directly.

Definition at line 55 of file MultiAppFieldTransfer.C.

Referenced by MultiAppGeneralFieldShapeEvaluationTransfer::buildMeshFunctions(), MultiAppGeneralFieldTransfer::examineLocalValueConflicts(), MultiAppGeneralFieldTransfer::examineReceivedValueConflicts(), MultiAppGeneralFieldTransfer::extractOutgoingPoints(), MultiAppGeneralFieldTransfer::setSolutionVectorValues(), and MultiAppShapeEvaluationTransfer::transferVariable().

 {
   if (use_displaced)
   {
     if (!problem.getDisplacedProblem())
       mooseError("No displaced problem to provide a displaced equation system");
     return problem.getDisplacedProblem()->es();
   }
   else
     return problem.es();
 }

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 66 of file SetupInterface.C.

Referenced by MultiAppTransfer::checkMultiAppExecuteOn(), EigenProblem::checkProblemIntegrity(), Control::Control(), EigenExecutionerBase::init(), MultiAppConservativeTransfer::initialSetup(), IntegralPreservingFunctionIC::initialSetup(), Terminator::initialSetup(), Exodus::outputSetup(), NodalReporter::shouldStore(), ElementReporter::shouldStore(), and GeneralReporter::shouldStore().

 {
   return _execute_enum;
 }

◆ getFromBoundingBoxes() [1/2]

std::vector< BoundingBox > MultiAppTransfer::getFromBoundingBoxes ( )

protectedinherited

Return the bounding boxes of all the "from" domains, including all the domains not local to this processor.

There is a boundary restricted version which will return a degenerate minimum boundary box (min, min, min, min, min, min) in the case where the source domain doesn't have any active nodes on the boundary. Note: bounding boxes are in the reference space when using coordinate transformations / positions Note: global bounding boxes are not indexed by app number. But rather outer indexing is by process, then the inner indexing is by local app number.

Definition at line 496 of file MultiAppTransfer.C.

Referenced by MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), and MultiAppShapeEvaluationTransfer::transferVariable().

 {
   std::vector<std::pair<Point, Point>> bb_points(_from_meshes.size());
   for (unsigned int i = 0; i < _from_meshes.size(); i++)
   {
     // Get a bounding box around the mesh elements that are local to the current
     // processor.
     BoundingBox bbox = MeshTools::create_local_bounding_box(*_from_meshes[i]);
 
     // Translate the bounding box to the from domain's position. We may have rotations so we must
     // be careful in constructing the new min and max (first and second)
     const auto from_global_num = getGlobalSourceAppIndex(i);
     transformBoundingBox(bbox, *_from_transforms[from_global_num]);
 
     // Cast the bounding box into a pair of points (so it can be put through
     // MPI communication).
     bb_points[i] = static_cast<std::pair<Point, Point>>(bbox);
   }
 
   // Serialize the bounding box points.
   _communicator.allgather(bb_points);
 
   // Recast the points back into bounding boxes and return.
   std::vector<BoundingBox> bboxes(bb_points.size());
   for (unsigned int i = 0; i < bb_points.size(); i++)
     bboxes[i] = static_cast<BoundingBox>(bb_points[i]);
 
   // possibly extend bounding boxes
   extendBoundingBoxes(_bbox_factor, bboxes);
 
   return bboxes;
 }

◆ getFromBoundingBoxes() [2/2]

std::vector< BoundingBox > MultiAppTransfer::getFromBoundingBoxes ( BoundaryID boundary_id )

protectedinherited

Definition at line 530 of file MultiAppTransfer.C.

 {
   std::vector<std::pair<Point, Point>> bb_points(_from_meshes.size());
   const Real min_r = std::numeric_limits<Real>::lowest();
   const Real max_r = std::numeric_limits<Real>::max();
 
   for (unsigned int i = 0; i < _from_meshes.size(); i++)
   {
 
     Point min(max_r, max_r, max_r);
     Point max(min_r, min_r, min_r);
     bool at_least_one = false;
 
     // TODO: Factor this into mesh_tools after adding new boundary bounding box routine.
     const ConstBndNodeRange & bnd_nodes = *_from_meshes[i]->getBoundaryNodeRange();
     for (const auto & bnode : bnd_nodes)
     {
       if (bnode->_bnd_id == boundary_id &&
           bnode->_node->processor_id() == _from_meshes[i]->processor_id())
       {
         at_least_one = true;
         const auto & node = *bnode->_node;
         for (const auto i : make_range(Moose::dim))
         {
           min(i) = std::min(min(i), node(i));
           max(i) = std::max(max(i), node(i));
         }
       }
     }
 
     BoundingBox bbox(min, max);
     if (!at_least_one)
       bbox.min() = max; // If we didn't hit any nodes, this will be _the_ minimum bbox
     else
     {
       // Translate the bounding box to the from domain's position. We may have rotations so we must
       // be careful in constructing the new min and max (first and second)
       const auto from_global_num = getGlobalSourceAppIndex(i);
       transformBoundingBox(bbox, *_from_transforms[from_global_num]);
     }
 
     // Cast the bounding box into a pair of points (so it can be put through
     // MPI communication).
     bb_points[i] = static_cast<std::pair<Point, Point>>(bbox);
   }
 
   // Serialize the bounding box points.
   _communicator.allgather(bb_points);
 
   // Recast the points back into bounding boxes and return.
   std::vector<BoundingBox> bboxes(bb_points.size());
   for (unsigned int i = 0; i < bb_points.size(); i++)
     bboxes[i] = static_cast<BoundingBox>(bb_points[i]);
 
   // possibly extend bounding boxes
   extendBoundingBoxes(_bbox_factor, bboxes);
 
   return bboxes;
 }

◆ getFromMultiApp()

const std::shared_ptr<MultiApp> MultiAppTransfer::getFromMultiApp ( ) const

inlineinherited

Get the MultiApp to transfer data from.

Definition at line 63 of file MultiAppTransfer.h.

Referenced by MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), MultiAppPostprocessorToAuxScalarTransfer::checkSiblingsTransferSupported(), MultiAppScalarToAuxScalarTransfer::checkSiblingsTransferSupported(), MultiAppPostprocessorTransfer::checkSiblingsTransferSupported(), MultiAppReporterTransfer::checkSiblingsTransferSupported(), MultiAppMFEMCopyTransfer::checkSiblingsTransferSupported(), MultiAppCopyTransfer::checkSiblingsTransferSupported(), MultiAppTransfer::errorIfObjectExecutesOnTransferInSourceApp(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppPostprocessorTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppCopyTransfer::execute(), MultiAppMFEMCopyTransfer::execute(), MultiAppGeometricInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppCloneReporterTransfer::executeFromMultiapp(), MultiAppReporterTransfer::executeFromMultiapp(), MultiAppVectorPostprocessorTransfer::executeFromMultiapp(), MultiAppReporterTransfer::executeToMultiapp(), MultiAppCloneReporterTransfer::initialSetup(), MultiAppReporterTransfer::initialSetup(), MultiAppConservativeTransfer::initialSetup(), MultiAppVariableValueSampleTransfer::initialSetup(), MultiAppVariableValueSamplePostprocessorTransfer::initialSetup(), MultiAppDofCopyTransfer::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), MultiAppGeneralFieldTransfer::locatePointReceivers(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppMFEMCopyTransfer::MultiAppMFEMCopyTransfer(), MultiAppPostprocessorInterpolationTransfer::MultiAppPostprocessorInterpolationTransfer(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), MultiAppConservativeTransfer::postExecute(), and MultiAppVariableValueSamplePostprocessorTransfer::setupPostprocessorCommunication().

   {
     if (!_from_multi_app)
       mooseError(
           "A from_multiapp was requested but is unavailable. Check the from_multi_app parameter");
     else
       return _from_multi_app;
   }

◆ getFromName()

std::string MultiAppTransfer::getFromName ( ) const

inlineinherited

Get the name of thing being transferred from.

Returns: the name of the multiapp or "Parent"

Definition at line 86 of file MultiAppTransfer.h.

   {
     if (_from_multi_app)
       return _from_multi_app->name();
     else
       return "Parent";
   }

◆ getFromsPerProc()

std::vector< unsigned int > MultiAppTransfer::getFromsPerProc ( )

protectedinherited

Return the number of "from" domains that each processor owns.

Note: same indexing as getFromBoundingBoxes

Definition at line 591 of file MultiAppTransfer.C.

Referenced by MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppGeneralFieldTransfer::prepareToTransfer(), and MultiAppShapeEvaluationTransfer::transferVariable().

 {
   std::vector<unsigned int> froms_per_proc;
   if (_to_multi_app)
     froms_per_proc.resize(n_processors(), 1);
   if (_from_multi_app)
   {
     froms_per_proc.resize(n_processors());
     _communicator.allgather(_from_multi_app->numLocalApps(), froms_per_proc);
   }
   return froms_per_proc;
 }

◆ getFromVarName()

VariableName MultiAppGeneralFieldTransfer::getFromVarName ( unsigned int var_index )

inherited

Get the source variable name, with the suffix for array/vector variables.

Definition at line 1927 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldNearestLocationTransfer::buildKDTrees(), MultiAppGeneralFieldShapeEvaluationTransfer::buildMeshFunctions(), and MultiAppGeneralFieldTransfer::outputValueConflicts().

 {
   mooseAssert(var_index < _from_var_names.size(), "No source variable at this index");
   VariableName var_name = _from_var_names[var_index];
   if (_from_var_components.size())
     var_name += "_" + std::to_string(_from_var_components[var_index]);
   return var_name;
 }

◆ getFromVarNames()

virtual std::vector<VariableName> MultiAppConservativeTransfer::getFromVarNames ( ) const

inlineoverrideprotectedvirtualinherited

Virtual function defining variables to be transferred.

Implements MultiAppFieldTransfer.

Definition at line 34 of file MultiAppConservativeTransfer.h.

34 { return _from_var_names; }

MultiAppConservativeTransfer::_from_var_names

const std::vector< VariableName > _from_var_names

Name of variables transferring from.

Definition: MultiAppConservativeTransfer.h:40

◆ getGlobalSourceAppIndex()

unsigned int MultiAppTransfer::getGlobalSourceAppIndex ( unsigned int i_from ) const

protectedinherited

Return the global app index from the local index in the "from-multiapp" transfer direction.

Definition at line 648 of file MultiAppTransfer.C.

 {
   mooseAssert(_current_direction == TO_MULTIAPP || i_from < _from_local2global_map.size(),
               "Out of bounds local from-app index");
   return _current_direction == TO_MULTIAPP ? 0 : _from_local2global_map[i_from];
 }

◆ getGlobalTargetAppIndex()

unsigned int MultiAppTransfer::getGlobalTargetAppIndex ( unsigned int i_to ) const

protectedinherited

Return the global app index from the local index in the "to-multiapp" transfer direction.

Definition at line 656 of file MultiAppTransfer.C.

Referenced by MultiAppGeneralFieldTransfer::cacheIncomingInterpVals(), MultiAppGeneralFieldTransfer::cacheOutgoingPointInfo(), MultiAppGeneralFieldTransfer::extractOutgoingPoints(), MultiAppTransfer::getPointInTargetAppFrame(), MultiAppGeneralFieldTransfer::locatePointReceivers(), and MultiAppGeneralFieldTransfer::setSolutionVectorValues().

 {
   mooseAssert(_current_direction == FROM_MULTIAPP || i_to < _to_local2global_map.size(),
               "Out of bounds local to-app index");
   return _current_direction == FROM_MULTIAPP ? 0 : _to_local2global_map[i_to];
 }

◆ getHitNode()

const hit::Node* MooseBase::getHitNode ( ) const

inlineinherited

Returns: The block-level hit node for this object, if any

Definition at line 132 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MooseBase::callMooseError(), MooseBase::getHitNode(), and MooseBase::messagePrefix().

132 { return getHitNode(_pars); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

MooseBase::getHitNode

const hit::Node * getHitNode() const

Definition: MooseBase.h:132

◆ getLocalSourceAppIndex()

unsigned int MultiAppTransfer::getLocalSourceAppIndex ( unsigned int i_from ) const

protectedinherited

Return the local app index from the global index in the "from-multiapp" transfer direction We use the fact that global app indexes are consecutive on a given rank.

Definition at line 664 of file MultiAppTransfer.C.

 {
   return _current_direction == TO_MULTIAPP
              ? 0
              : _from_local2global_map[i_from] - _from_local2global_map[0];
 }

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 83 of file MooseBase.h.

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), AddDefaultConvergenceAction::addDefaultSteadyStateConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedSteadyStateConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), Coupleable::Coupleable(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultConvergenceBase::getSharedExecutionerParam(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), MultiApp::restore(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

83 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:353

◆ getMultiApp()

const std::shared_ptr<MultiApp> MultiAppTransfer::getMultiApp ( ) const

inlineinherited

Use this getter to obtain the MultiApp for transfers with a single direction.

Definition at line 48 of file MultiAppTransfer.h.

Referenced by MultiAppCloneReporterTransfer::initialSetup().

   {
     if (_from_multi_app && _to_multi_app && _from_multi_app != _to_multi_app)
       mooseError("Unclear which app you want to retrieve from Transfer ", name());
     else if (_from_multi_app)
       return _from_multi_app;
     else if (_to_multi_app)
       return _to_multi_app;
     else if (_multi_app)
       return _multi_app;
     else
       mooseError("Should not get here, there should be a multiapp");
   }

◆ getParam() [1/2]

template<typename T >

const T & MooseBase::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 384 of file MooseBase.h.

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

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBase::getParam	(	const std::string &	param1,
		const std::string &	param2
	)		const

inherited

Retrieve two parameters and provide pair of parameters for the object.

Parameters

param1	The name of first parameter
param2	The name of second parameter

Returns: Vector of pairs of first and second parameters

Definition at line 421 of file MooseBase.h.

 {
   return _pars.get<T1, T2>(param1, param2);
 }

◆ getPointInTargetAppFrame()

Point MultiAppTransfer::getPointInTargetAppFrame	(	const Point &	p,
		unsigned int	local_i_to,
		const std::string &	phase
	)		const

protectedinherited

Get the target app point from a point in the reference frame.

Parameters

p	the point in the reference frame
local_i_to	the local target problem into
phase	the phase of the transfer where this is being attempted in case we have to output an info message that the coordinate collapse is not being applied

Returns: the point in the target app frame

Definition at line 627 of file MultiAppTransfer.C.

Referenced by MultiAppGeneralFieldTransfer::cacheIncomingInterpVals(), and MultiAppGeneralFieldTransfer::examineLocalValueConflicts().

 {
   const auto & to_transform = _to_transforms[getGlobalTargetAppIndex(local_i_to)];
   if (to_transform->hasCoordinateSystemTypeChange())
   {
     if (!_skip_coordinate_collapsing)
       mooseInfo(phase + " cannot use the point in the target app frame due to the "
                         "non-uniqueness of the coordinate collapsing reverse mapping."
                         " Coordinate collapse is ignored for this operation");
     to_transform->skipCoordinateCollapsing(true);
     const auto target_point = to_transform->mapBack(p);
     to_transform->skipCoordinateCollapsing(false);
     return target_point;
   }
   else
     return to_transform->mapBack(p);
 }

◆ getRenamedParam()

template<typename T >

const T & MooseBase::getRenamedParam	(	const std::string &	old_name,
		const std::string &	new_name
	)		const

inherited

Retrieve a renamed parameter for the object.

This helper makes sure we check both names before erroring, and that only one parameter is passed to avoid silent errors

Parameters

old_name	the old name for the parameter
new_name	the new name for the parameter

Definition at line 398 of file MooseBase.h.

 {
   // Most important: accept new parameter
   if (isParamSetByUser(new_name) && !isParamValid(old_name))
     return getParam<T>(new_name);
   // Second most: accept old parameter
   if (isParamValid(old_name) && !isParamSetByUser(new_name))
     return getParam<T>(old_name);
   // Third most: accept default for new parameter
   if (isParamValid(new_name) && !isParamValid(old_name))
     return getParam<T>(new_name);
   // Refuse: no default, no value passed
   if (!isParamValid(old_name) && !isParamValid(new_name))
     mooseError("parameter '" + new_name +
                "' is being retrieved without being set.\nDid you misspell it?");
   // Refuse: both old and new parameters set by user
   else
     mooseError("Parameter '" + new_name + "' may not be provided alongside former parameter '" +
                old_name + "'");
 }

◆ getRestartableData()

template<typename T , typename... Args>

const T & Restartable::getRestartableData ( const std::string & data_name ) const

protectedinherited

Declare a piece of data as "restartable" and initialize it Similar to declareRestartableData but returns a const reference to the object.

Forwarded arguments are not allowed in this case because we assume that the object is restarted and we won't need different constructors to initialize it.

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

Parameters

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

Definition at line 287 of file Restartable.h.

 {
   return declareRestartableDataHelper<T>(data_name, nullptr).get();
 }

◆ getSharedPtr() [1/2]

std::shared_ptr< MooseObject > MooseObject::getSharedPtr ( )

inherited

Get another shared pointer to this object that has the same ownership group.

Wrapper around shared_from_this().

Definition at line 61 of file MooseObject.C.

Referenced by MFEMProblem::addBoundaryCondition(), MFEMProblem::addKernel(), and MFEMProblem::addMFEMSolver().

 {
   try
   {
     return shared_from_this();
   }
   catch (std::bad_weak_ptr &)
   {
     mooseError(not_shared_error);
   }
 }

◆ getSharedPtr() [2/2]

std::shared_ptr< const MooseObject > MooseObject::getSharedPtr ( ) const

inherited

Definition at line 74 of file MooseObject.C.

 {
   try
   {
     return shared_from_this();
   }
   catch (std::bad_weak_ptr &)
   {
     mooseError(not_shared_error);
   }
 }

◆ getToMultiApp()

const std::shared_ptr<MultiApp> MultiAppTransfer::getToMultiApp ( ) const

inlineinherited

Get the MultiApp to transfer data to.

Definition at line 73 of file MultiAppTransfer.h.

Referenced by MultiAppPostprocessorToAuxScalarTransfer::checkSiblingsTransferSupported(), MultiAppScalarToAuxScalarTransfer::checkSiblingsTransferSupported(), MultiAppPostprocessorTransfer::checkSiblingsTransferSupported(), MultiAppReporterTransfer::checkSiblingsTransferSupported(), MultiAppMFEMCopyTransfer::checkSiblingsTransferSupported(), MultiAppCopyTransfer::checkSiblingsTransferSupported(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppPostprocessorTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppMFEMCopyTransfer::execute(), MultiAppCopyTransfer::execute(), MultiAppGeometricInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppReporterTransfer::executeFromMultiapp(), MultiAppReporterTransfer::executeToMultiapp(), MultiAppVectorPostprocessorTransfer::executeToMultiapp(), MultiAppReporterTransfer::initialSetup(), MultiAppCloneReporterTransfer::initialSetup(), MultiAppConservativeTransfer::initialSetup(), MultiAppVariableValueSampleTransfer::initialSetup(), MultiAppVariableValueSamplePostprocessorTransfer::initialSetup(), MultiAppDofCopyTransfer::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), MultiAppMFEMCopyTransfer::MultiAppMFEMCopyTransfer(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), and MultiAppConservativeTransfer::postExecute().

   {
     if (!_to_multi_app)
       mooseError(
           "A to_multiapp was requested but is unavailable. Check the to_multi_app parameter");
     else
       return _to_multi_app;
   }

◆ getToName()

std::string MultiAppTransfer::getToName ( ) const

inlineinherited

Get the name of thing being transferred to.

Returns: the name of the multiapp or "Parent"

Definition at line 98 of file MultiAppTransfer.h.

   {
     if (_to_multi_app)
       return _to_multi_app->name();
     else
       return "Parent";
   }

◆ getToVarName()

VariableName MultiAppGeneralFieldTransfer::getToVarName ( unsigned int var_index )

inherited

Get the target variable name, with the suffix for array/vector variables.

Definition at line 1937 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldTransfer::examineLocalValueConflicts(), MultiAppGeneralFieldTransfer::examineReceivedValueConflicts(), MultiAppGeneralFieldTransfer::extractOutgoingPoints(), MultiAppGeneralFieldTransfer::outputValueConflicts(), and MultiAppGeneralFieldTransfer::setSolutionVectorValues().

 {
   mooseAssert(var_index < _to_var_names.size(), "No target variable at this index");
   VariableName var_name = _to_var_names[var_index];
   if (_to_var_components.size())
     var_name += "_" + std::to_string(_to_var_components[var_index]);
   return var_name;
 }

◆ getToVarNames()

virtual std::vector<AuxVariableName> MultiAppConservativeTransfer::getToVarNames ( ) const

inlineoverrideprotectedvirtualinherited

Virtual function defining variables to transfer to.

Implements MultiAppFieldTransfer.

Definition at line 35 of file MultiAppConservativeTransfer.h.

35 { return _to_var_names; }

MultiAppConservativeTransfer::_to_var_names

const std::vector< AuxVariableName > _to_var_names

Name of variables transferring to.

Definition: MultiAppConservativeTransfer.h:42

◆ getTransferVector()

NumericVector< Real > & MultiAppTransfer::getTransferVector	(	unsigned int	i_local,
		std::string	var_name
	)

protectedinherited

If we are transferring to a multiapp, return the appropriate solution vector.

Definition at line 605 of file MultiAppTransfer.C.

Referenced by MultiAppNearestNodeTransfer::execute(), and MultiAppShapeEvaluationTransfer::transferVariable().

 {
   mooseAssert(_to_multi_app, "getTransferVector only works for transfers to multiapps");
 
   return _to_multi_app->appTransferVector(_to_local2global_map[i_local], var_name);
 }

◆ hasBase()

bool MooseBase::hasBase ( ) const

inlineinherited

Returns: Whether or not this object has a registered base (set via InputParameters::registerBase())

Definition at line 138 of file MooseBase.h.

138 { return _pars.hasBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

InputParameters::hasBase

bool hasBase() const

Definition: InputParameters.C:491

◆ hasFromMultiApp()

bool MultiAppTransfer::hasFromMultiApp ( ) const

inlineinherited

Whether the transfer owns a non-null from_multi_app.

Definition at line 107 of file MultiAppTransfer.h.

Referenced by MultiAppTransfer::checkParentAppUserObjectExecuteOn(), MultiAppTransfer::errorIfObjectExecutesOnTransferInSourceApp(), MultiAppPostprocessorTransfer::execute(), MultiAppGeometricInterpolationTransfer::execute(), MultiAppReporterTransfer::executeFromMultiapp(), MultiAppReporterTransfer::executeToMultiapp(), MultiAppReporterTransfer::initialSetup(), MultiAppConservativeTransfer::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppMFEMCopyTransfer::MultiAppMFEMCopyTransfer(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppVariableValueSampleTransfer::MultiAppVariableValueSampleTransfer(), and MultiAppGeneralFieldTransfer::outputValueConflicts().

107 { return !(!_from_multi_app); }

MultiAppTransfer::_from_multi_app

std::shared_ptr< MultiApp > _from_multi_app

The MultiApps this Transfer is transferring data to or from.

Definition: MultiAppTransfer.h:279

◆ hasToMultiApp()

bool MultiAppTransfer::hasToMultiApp ( ) const

inlineinherited

Whether the transfer owns a non-null to_multi_app.

Definition at line 110 of file MultiAppTransfer.h.

Referenced by MultiAppReporterTransfer::executeFromMultiapp(), MultiAppReporterTransfer::executeToMultiapp(), MultiAppReporterTransfer::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), MultiAppMFEMCopyTransfer::MultiAppMFEMCopyTransfer(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppGeneralFieldTransfer::outputValueConflicts(), and MultiAppGeneralFieldTransfer::setSolutionVectorValues().

110 { return !(!_to_multi_app); }

MultiAppTransfer::_to_multi_app

std::shared_ptr< MultiApp > _to_multi_app

Definition: MultiAppTransfer.h:280

◆ inBlocks() [1/4]

bool MultiAppGeneralFieldTransfer::inBlocks	(	const std::set< SubdomainID > &	blocks,
		const Elem *	elem
	)		const

protectedinherited

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppGeneralFieldTransfer::extractOutgoingPoints(), and MultiAppGeneralFieldTransfer::getRestrictedFromBoundingBoxes().

◆ inBlocks() [2/4]

virtual bool MultiAppGeneralFieldTransfer::inBlocks	(	const std::set< SubdomainID > &	blocks,
		const MooseMesh &	mesh,
		const Elem *	elem
	)		const

protectedvirtualinherited

Reimplemented in MultiAppGeneralFieldNearestLocationTransfer.

◆ inBlocks() [3/4]

bool MultiAppGeneralFieldTransfer::inBlocks	(	const std::set< SubdomainID > &	blocks,
		const MooseMesh &	mesh,
		const Node *	node
	)		const

protectedinherited

◆ inBlocks() [4/4]

bool MultiAppGeneralFieldTransfer::inBlocks	(	const std::set< SubdomainID > &	blocks,
		const libMesh::PointLocatorBase *const	pl,
		const Point &	pt
	)		const

protectedinherited

◆ initialSetup()

void MultiAppGeneralFieldTransfer::initialSetup ( )

overridevirtualinherited

Method called at the beginning of the simulation for checking integrity or doing one-time setup.

Reimplemented from MultiAppConservativeTransfer.

Reimplemented in MultiAppGeneralFieldNearestLocationTransfer.

Definition at line 227 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldNearestLocationTransfer::initialSetup().

 {
   MultiAppConservativeTransfer::initialSetup();
 
   // Use IDs for block and boundary restriction
   // Loop over all source problems
   for (const auto i_from : index_range(_from_problems))
   {
     const auto & from_moose_mesh = _from_problems[i_from]->mesh(_displaced_source_mesh);
     if (isParamValid("from_blocks"))
     {
       auto & blocks = getParam<std::vector<SubdomainName>>("from_blocks");
       std::vector<SubdomainID> ids = from_moose_mesh.getSubdomainIDs(blocks);
       _from_blocks.insert(ids.begin(), ids.end());
       if (_from_blocks.size() != blocks.size())
         paramError("from_blocks", "Some blocks were not found in the mesh");
     }
 
     if (isParamValid("from_boundaries"))
     {
       auto & boundary_names = getParam<std::vector<BoundaryName>>("from_boundaries");
       std::vector<BoundaryID> boundary_ids = from_moose_mesh.getBoundaryIDs(boundary_names);
       _from_boundaries.insert(boundary_ids.begin(), boundary_ids.end());
       if (_from_boundaries.size() != boundary_names.size())
         paramError("from_boundaries", "Some boundaries were not found in the mesh");
     }
 
     if (isParamValid("from_mesh_division"))
     {
       const auto & mesh_div_name = getParam<MeshDivisionName>("from_mesh_division");
       _from_mesh_divisions.push_back(&_from_problems[i_from]->getMeshDivision(mesh_div_name));
       // Check that the behavior set makes sense
       if (_from_mesh_division_behavior == MeshDivisionTransferUse::RESTRICTION)
       {
         if (_from_mesh_divisions[i_from]->coversEntireMesh())
           mooseInfo("'from_mesh_division_usage' is set to use a spatial restriction but the "
                     "'from_mesh_division' for source app of global index " +
                     std::to_string(getGlobalSourceAppIndex(i_from)) +
                     " covers the entire mesh. Do not expect any restriction from a mesh "
                     "division that covers the entire mesh");
       }
       else if (_from_mesh_division_behavior == MeshDivisionTransferUse::MATCH_DIVISION_INDEX &&
                !isParamValid("to_mesh_division"))
         paramError("to_mesh_division_usage",
                    "Source mesh division cannot match target mesh division if no target mesh "
                    "division is specified");
       else if (_from_mesh_division_behavior == MeshDivisionTransferUse::MATCH_SUBAPP_INDEX)
       {
         if (!hasToMultiApp())
           paramError("from_mesh_division_usage",
                      "Cannot match source mesh division index to target subapp index if there is "
                      "only one target: the parent app (not a subapp)");
         else if (getToMultiApp()->numGlobalApps() !=
                  _from_mesh_divisions[i_from]->getNumDivisions())
           mooseWarning("Attempting to match target subapp index with the number of source mesh "
                        "divisions, which is " +
                        std::to_string(_from_mesh_divisions[i_from]->getNumDivisions()) +
                        " while there are " + std::to_string(getToMultiApp()->numGlobalApps()) +
                        " target subapps");
         if (_to_mesh_division_behavior == MeshDivisionTransferUse::MATCH_DIVISION_INDEX)
           // We do not support it because it would require sending the point + target app index +
           // target app division index, and we only send the Point + one number
           paramError("from_mesh_division_usage",
                      "We do not support using target subapp index for source division behavior and "
                      "matching the division index for the target mesh division behavior.");
       }
       else if (_from_mesh_division_behavior == "none")
         paramError("from_mesh_division_usage", "User must specify a 'from_mesh_division_usage'");
     }
     else if (_from_mesh_division_behavior != "none")
       paramError("from_mesh_division",
                  "'from_mesh_division' must be specified if the usage method is specified");
   }
 
   // Loop over all target problems
   for (const auto i_to : index_range(_to_problems))
   {
     const auto & to_moose_mesh = _to_problems[i_to]->mesh(_displaced_target_mesh);
     if (isParamValid("to_blocks"))
     {
       auto & blocks = getParam<std::vector<SubdomainName>>("to_blocks");
       std::vector<SubdomainID> ids = to_moose_mesh.getSubdomainIDs(blocks);
       _to_blocks.insert(ids.begin(), ids.end());
       if (_to_blocks.size() != blocks.size())
         paramError("to_blocks", "Some blocks were not found in the mesh");
     }
 
     if (isParamValid("to_boundaries"))
     {
       auto & boundary_names = getParam<std::vector<BoundaryName>>("to_boundaries");
       std::vector<BoundaryID> boundary_ids = to_moose_mesh.getBoundaryIDs(boundary_names);
       _to_boundaries.insert(boundary_ids.begin(), boundary_ids.end());
       if (_to_boundaries.size() != boundary_names.size())
         paramError("to_boundaries", "Some boundaries were not found in the mesh");
     }
 
     if (isParamValid("to_mesh_division"))
     {
       const auto & mesh_div_name = getParam<MeshDivisionName>("to_mesh_division");
       _to_mesh_divisions.push_back(&_to_problems[i_to]->getMeshDivision(mesh_div_name));
       // Check that the behavior set makes sense
       if (_to_mesh_division_behavior == MeshDivisionTransferUse::RESTRICTION)
       {
         if (_to_mesh_divisions[i_to]->coversEntireMesh())
           mooseInfo("'to_mesh_division_usage' is set to use a spatial restriction but the "
                     "'to_mesh_division' for target application of global index " +
                     std::to_string(getGlobalSourceAppIndex(i_to)) +
                     " covers the entire mesh. Do not expect any restriction from a mesh "
                     "division that covers the entire mesh");
       }
       else if (_to_mesh_division_behavior == MeshDivisionTransferUse::MATCH_DIVISION_INDEX)
       {
         if (!isParamValid("from_mesh_division"))
           paramError("to_mesh_division_usage",
                      "Target mesh division cannot match source mesh division if no source mesh "
                      "division is specified");
         else if ((*_from_mesh_divisions.begin())->getNumDivisions() !=
                  _to_mesh_divisions[i_to]->getNumDivisions())
           mooseWarning("Source and target mesh divisions do not have the same number of bins. If "
                        "this is what you expect, please reach out to a MOOSE or app developer to "
                        "ensure appropriate use");
       }
       else if (_to_mesh_division_behavior == MeshDivisionTransferUse::MATCH_SUBAPP_INDEX)
       {
         if (!hasFromMultiApp())
           paramError(
               "to_mesh_division_usage",
               "Cannot match target mesh division index to source subapp index if there is only one "
               "source: the parent app (not a subapp)");
         else if (getFromMultiApp()->numGlobalApps() != _to_mesh_divisions[i_to]->getNumDivisions())
           mooseWarning("Attempting to match source subapp index with the number of target mesh "
                        "divisions, which is " +
                        std::to_string(_to_mesh_divisions[i_to]->getNumDivisions()) +
                        " while there are " + std::to_string(getFromMultiApp()->numGlobalApps()) +
                        " source subapps");
         if (_from_mesh_division_behavior == MeshDivisionTransferUse::MATCH_DIVISION_INDEX)
           paramError(
               "from_mesh_division_usage",
               "We do not support using source subapp index for the target division behavior and "
               "matching the division index for the source mesh division behavior.");
       }
       else if (_to_mesh_division_behavior == "none")
         paramError("to_mesh_division_usage", "User must specify a 'to_mesh_division_usage'");
     }
     else if (_to_mesh_division_behavior != "none")
       paramError("to_mesh_division",
                  "'to_mesh_division' must be specified if usage method '" +
                      Moose::stringify(_to_mesh_division_behavior) + "' is specified");
   }
 
   // Check if components are set correctly if using an array variable
   for (const auto i_from : index_range(_from_problems))
   {
     for (const auto var_index : make_range(_from_var_names.size()))
     {
       MooseVariableFieldBase & from_var =
           _from_problems[i_from]->getVariable(0,
                                               _from_var_names[var_index],
                                               Moose::VarKindType::VAR_ANY,
                                               Moose::VarFieldType::VAR_FIELD_ANY);
       if (from_var.count() > 1 && _from_var_components.empty())
         paramError("source_variable_components", "Component must be passed for an array variable");
       if (_from_var_components.size() && from_var.count() < _from_var_components[var_index])
         paramError("source_variable_components",
                    "Component passed is larger than size of variable");
     }
   }
   for (const auto i_to : index_range(_to_problems))
   {
     for (const auto var_index : make_range(_to_var_names.size()))
     {
       MooseVariableFieldBase & to_var =
           _to_problems[i_to]->getVariable(0,
                                           _to_var_names[var_index],
                                           Moose::VarKindType::VAR_ANY,
                                           Moose::VarFieldType::VAR_FIELD_ANY);
       if (to_var.count() > 1 && _to_var_components.empty())
         paramError("target_variable_components", "Component must be passed for an array variable");
       if (_to_var_components.size() && to_var.count() < _to_var_components[var_index])
         paramError("target_variable_components",
                    "Component passed is larger than size of variable");
     }
   }
 
   // Cache some quantities to avoid having to get them on every transferred point
   if (_to_problems.size())
   {
     _to_variables.resize(_to_var_names.size());
     for (const auto i_var : index_range(_to_var_names))
       _to_variables[i_var] = &_to_problems[0]->getVariable(
           0, _to_var_names[i_var], Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
   }
 }

◆ inMesh()

bool MultiAppGeneralFieldTransfer::inMesh	(	const libMesh::PointLocatorBase *const	pl,
		const Point &	pt
	)		const

protectedinherited

Definition at line 1599 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), and MultiAppGeneralFieldNearestLocationTransfer::checkRestrictionsForSource().

 {
   // Note: we do not take advantage of a potential block restriction of the mesh here. This is
   // because we can avoid this routine by calling inBlocks() instead
   const Elem * elem = (*pl)(point);
   return (elem != nullptr);
 }

◆ isParamSetByUser()

bool MooseBase::isParamSetByUser ( const std::string & name ) const

inlineinherited

Test if the supplied parameter is set by a user, as opposed to not set or set to default.

Parameters

name	The name of the parameter to test

Definition at line 201 of file MooseBase.h.

Referenced by SetupDebugAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), MFEMMesh::buildMesh(), LibtorchNeuralNetControl::conditionalParameterError(), MooseApp::copyInputs(), DiffusionPhysicsBase::DiffusionPhysicsBase(), ElementSubdomainModifierBase::ElementSubdomainModifierBase(), MooseApp::errorCheck(), MooseBase::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PiecewiseTabularBase::PiecewiseTabularBase(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), PhysicsBase::reportPotentiallyMissedParameters(), MooseApp::runInputFile(), MooseApp::runInputs(), MFEMSolverBase::setPreconditioner(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), TimedSubdomainModifier::TimedSubdomainModifier(), and XYDelaunayGenerator::XYDelaunayGenerator().

   {
     return _pars.isParamSetByUser(name);
   }

◆ isParamValid()

bool MooseBase::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 195 of file MooseBase.h.

195 { return _pars.isParamValid(name); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

MooseBase::name

const std::string & name() const

Get the name of the class.

Definition: MooseBase.h:99

InputParameters::isParamValid

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

This method returns parameters that have been initialized in one fashion or another, i.e.

Definition: InputParameters.C:386

◆ 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 MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, Positions, Times, DiffusionLHDGKernel, IPHDGKernel, EqualValueEmbeddedConstraintTempl< is_ad >, ADKernelTempl< T >, IPHDGBC, DiffusionLHDGPrescribedGradientBC, and DiffusionLHDGDirichletBC.

Definition at line 51 of file SetupInterface.C.

Referenced by MooseVariableField< Real >::jacobianSetup(), and ComputeFVFluxJacobianThread< RangeType >::setup().

52 {

53 }

◆ messagePrefix()

std::string MooseBase::messagePrefix ( const bool hit_prefix = true ) const

inlineinherited

Returns: A prefix to be used in messages that contain the input file location associated with this object (if any) and the name and type of the object.

Definition at line 252 of file MooseBase.h.

Referenced by MooseBase::callMooseError(), MooseBase::errorPrefix(), MooseBase::mooseDeprecated(), MooseBase::mooseInfo(), and MooseBase::mooseWarning().

   {
     return messagePrefix(_pars, hit_prefix);
   }

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 310 of file MooseBase.h.

Referenced by FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), MooseApp::getRecoverFileBase(), FEProblemBase::getUserObjects(), FEProblemBase::hasPostprocessor(), MooseApp::hasRecoverFileBase(), MatDiffusionBase< Real >::MatDiffusionBase(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), PercentChangePostprocessor::PercentChangePostprocessor(), ReferenceResidualConvergence::ReferenceResidualConvergence(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), MooseApp::setupOptions(), UserForcingFunction::UserForcingFunction(), and VariableResidual::VariableResidual().

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

◆ mooseDocumentedError()

template<typename... Args>

void MooseBase::mooseDocumentedError	(	const std::string &	repo_name,
		const unsigned int	issue_num,
		Args &&...	args
	)		const

inlineinherited

Definition at line 273 of file MooseBase.h.

Referenced by ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), DGLowerDKernel::DGLowerDKernel(), HFEMDirichletBC::HFEMDirichletBC(), and LowerDIntegratedBC::LowerDIntegratedBC().

   {
     callMooseError(moose::internal::formatMooseDocumentedError(
                        repo_name, issue_num, argumentsToString(std::forward<Args>(args)...)),
                    /* with_prefix = */ true);
   }

◆ mooseError()

template<typename... Args>

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

inlineinherited

Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.

Definition at line 267 of file MooseBase.h.

   {
     callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ true);
   }

◆ mooseErrorNonPrefixed()

template<typename... Args>

void MooseBase::mooseErrorNonPrefixed ( Args &&... args ) const

inlineinherited

Emits an error without the prefixing included in mooseError().

Definition at line 286 of file MooseBase.h.

   {
     callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ false);
   }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 317 of file MooseBase.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), PIDTransientControl::execute(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), DataFileInterface::getDataFilePath(), MFEMScalarFESpace::getFECName(), MultiAppTransfer::getPointInTargetAppFrame(), ImplicitMidpoint::ImplicitMidpoint(), ParsedDownSelectionPositions::initialize(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), MooseBase::paramInfo(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), MFEMDataCollection::registerFields(), FEProblemBase::setRestartFile(), MooseApp::setupOptions(), SolutionUserObjectBase::SolutionUserObjectBase(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), and TransientBase::TransientBase().

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

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 295 of file MooseBase.h.

Referenced by CopyMeshPartitioner::_do_partition(), AddKernelAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), MFEMProblem::addFunction(), MooseMesh::addPeriodicVariable(), DiracKernelBase::addPoint(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), SampledOutput::cloneMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), VariableValueElementSubdomainModifier::computeSubdomainID(), GapValueAux::computeValue(), MultiApp::createApp(), DebugResidualAux::DebugResidualAux(), MeshDiagnosticsGenerator::diagnosticsLog(), CartesianGridDivision::divisionIndex(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), ElementMaterialSampler::ElementMaterialSampler(), Postprocessor::evaluateDotWarning(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), SubdomainPerElementGenerator::generate(), StitchMeshGenerator::generate(), ParsedGenerateSideset::generate(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), DataFileInterface::getDataFilePath(), PointSamplerBase::getLocalElemContainingPoint(), FEProblemBase::getMaterial(), LineValueSampler::getValue(), Terminator::handleMessage(), IndicatorMarker::IndicatorMarker(), CartesianGridDivision::initialize(), CylindricalGridDivision::initialize(), SphericalGridDivision::initialize(), ElementGroupCentroidPositions::initialize(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), BoundsBase::initialSetup(), ReferenceResidualConvergence::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), LeastSquaresFit::LeastSquaresFit(), IterationAdaptiveDT::limitDTToPostprocessorValue(), MooseApp::loadLibraryAndDependencies(), FEProblemBase::mesh(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), MooseBase::paramWarning(), PiecewiseConstantFromCSV::PiecewiseConstantFromCSV(), Executioner::problem(), PropertyReadFile::readData(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), SampledOutput::updateSample(), PiecewiseConstantFromCSV::value(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

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

◆ mooseWarningNonPrefixed()

template<typename... Args>

void MooseBase::mooseWarningNonPrefixed ( Args &&... args ) const

inlineinherited

Emits a warning without the prefixing included in mooseWarning().

Definition at line 304 of file MooseBase.h.

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

◆ name()

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

inlineinherited

Get the name of the class.

Returns: The name of the class

Definition at line 99 of file MooseBase.h.

   {
     mooseAssert(_name.size(), "Empty name");
     return _name;
   }

◆ onBoundaries() [1/3]

bool MultiAppGeneralFieldTransfer::onBoundaries	(	const std::set< BoundaryID > &	boundaries,
		const MooseMesh &	mesh,
		const Node *	node
	)		const

protectedinherited

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppGeneralFieldNearestLocationTransfer::buildKDTrees(), MultiAppGeneralFieldTransfer::extractOutgoingPoints(), and MultiAppGeneralFieldTransfer::getRestrictedFromBoundingBoxes().

◆ onBoundaries() [2/3]

bool MultiAppGeneralFieldTransfer::onBoundaries	(	const std::set< BoundaryID > &	boundaries,
		const MooseMesh &	mesh,
		const Elem *	elem
	)		const

protectedinherited

◆ onBoundaries() [3/3]

bool MultiAppGeneralFieldTransfer::onBoundaries	(	const std::set< BoundaryID > &	boundaries,
		const std::set< SubdomainID > &	block_restriction,
		const MooseMesh &	mesh,
		const libMesh::PointLocatorBase *const	pl,
		const Point &	pt
	)		const

protectedinherited

◆ paramError()

template<typename... Args>

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

inherited

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 435 of file MooseBase.h.

 {
   _pars.paramError(param, std::forward<Args>(args)...);
 }

◆ parameters()

const InputParameters& MooseBase::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 127 of file MooseBase.h.

127 { return _pars; }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

◆ paramInfo()

template<typename... Args>

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

inherited

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 449 of file MooseBase.h.

Referenced by GridPartitioner::_do_partition(), ComboMarker::ComboMarker(), Control::Control(), FunctorIC::FunctorIC(), and TransientMultiApp::TransientMultiApp().

 {
   mooseInfo(_pars.paramMessage(param, std::forward<Args>(args)...));
 }

◆ paramWarning()

template<typename... Args>

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

inherited

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 442 of file MooseBase.h.

Referenced by GridPartitioner::_do_partition(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), EigenProblem::checkProblemIntegrity(), CombinerGenerator::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), UniqueExtraIDMeshGenerator::generate(), PlaneIDMeshGenerator::generate(), Terminator::initialSetup(), SampledOutput::initSample(), MooseMesh::MooseMesh(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

 {
   mooseWarning(_pars.paramMessage(param, std::forward<Args>(args)...));
 }

◆ perfGraph()

PerfGraph & PerfGraphInterface::perfGraph ( )

inherited

Get the PerfGraph.

Definition at line 78 of file PerfGraphInterface.C.

Referenced by CommonOutputAction::act(), PerfGraphData::finalize(), and PerfGraphOutput::output().

 {
   return _pg_moose_app.perfGraph();
 }

◆ performAdjustment()

bool MultiAppConservativeTransfer::performAdjustment	(	const PostprocessorValue &	from,
		const PostprocessorValue &	to
	)		const

protectedinherited

Definition at line 526 of file MultiAppConservativeTransfer.C.

Referenced by MultiAppConservativeTransfer::adjustTransferredSolution(), and MultiAppConservativeTransfer::adjustTransferredSolutionNearestPoint().

 {
   if (from * to > 0)
     return true;
   else if (_allow_skipped_adjustment)
     return false;
   else
     mooseError("Adjustment postprocessors from: ",
                from,
                " to: ",
                to,
                " must both have the same sign and be different from 0");
 }

◆ possibleDirections()

static std::string Transfer::possibleDirections ( )

inlinestaticinherited

Used to construct InputParameters.

Definition at line 76 of file Transfer.h.

Referenced by Transfer::validParams().

76 { return "to_multiapp from_multiapp between_multiapp"; }

◆ postExecute()

void MultiAppGeneralFieldTransfer::postExecute ( )

overridevirtualinherited

Add some extra work if necessary after execute().

For example, adjust the solution to preserve some physics quality of interest.

Reimplemented from MultiAppConservativeTransfer.

Definition at line 481 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldTransfer::execute().

 {
   MultiAppConservativeTransfer::postExecute();
   if (_search_value_conflicts)
     _already_output_search_value_conflicts = true;
 }

◆ prepareEvaluationOfInterpValues()

void MultiAppGeneralFieldUserObjectTransfer::prepareEvaluationOfInterpValues ( const unsigned int )

overrideprotectedvirtual

Implements MultiAppGeneralFieldTransfer.

Definition at line 93 of file MultiAppGeneralFieldUserObjectTransfer.C.

 {
   _local_bboxes.clear();
   if (_use_bounding_boxes)
     extractLocalFromBoundingBoxes(_local_bboxes);
 }

◆ queryParam()

template<typename T >

const T * MooseBase::queryParam ( const std::string & name ) const

inherited

Query a parameter for the object.

If the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

Returns: A pointer to the parameter value, if it exists

Definition at line 391 of file MooseBase.h.

 {
   return isParamValid(name) ? &getParam<T>(name) : nullptr;
 }

◆ registerConflict()

void MultiAppGeneralFieldTransfer::registerConflict	(	unsigned int	problem,
		dof_id_type	dof_id,
		Point	p,
		Real	dist,
		bool	local
	)

protectedinherited

Register a potential value conflict, e.g.

two or more equidistant source points for a single target point, with different values possible

Parameters

problem	problem ID for the point of interest. For local conflicts, use origin problem id, for received conflicts, use target id
dof_id	id id of the DoF is transferring a DoF. If not, use -1
p	point where the conflict happens
dist	distance between the origin and the target
local	if true, local conflict found when gathering data to send, if false, received value conflict found when receiving data from multiple source problems

Definition at line 1030 of file MultiAppGeneralFieldTransfer.C.

Referenced by MultiAppGeneralFieldTransfer::cacheIncomingInterpVals(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), MultiAppGeneralFieldShapeEvaluationTransfer::evaluateInterpValuesWithMeshFunctions(), and evaluateInterpValuesWithUserObjects().

 {
   // NOTE We could be registering the same conflict several times, we could count them instead
   if (local)
     _local_conflicts.push_back(std::make_tuple(problem, dof_id, p, dist));
   else
     _received_conflicts.push_back(std::make_tuple(problem, dof_id, p, dist));
 }

◆ registerTimedSection() [1/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)

Returns: The ID of the section - use when starting timing

Definition at line 53 of file PerfGraphInterface.C.

 {
   const auto timed_section_name = timedSectionName(section_name);
   if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
     return moose::internal::getPerfGraphRegistry().registerSection(timed_section_name, level);
   else
     return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
 }

◆ registerTimedSection() [2/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level,
		const std::string &	live_message,
		const bool	print_dots = `true`
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)
live_message	The message to be printed to the screen during execution
print_dots	Whether or not progress dots should be printed for this section

Returns: The ID of the section - use when starting timing

Definition at line 64 of file PerfGraphInterface.C.

 {
   const auto timed_section_name = timedSectionName(section_name);
   if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
     return moose::internal::getPerfGraphRegistry().registerSection(
         timedSectionName(section_name), level, live_message, print_dots);
   else
     return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
 }

◆ residualSetup()

void SetupInterface::residualSetup ( )

virtualinherited

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

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, NodeFaceConstraint, Positions, and Times.

Definition at line 56 of file SetupInterface.C.

Referenced by MooseVariableField< Real >::residualSetup(), ComputeFVFluxResidualThread< RangeType >::setup(), and ComputeFVFluxRJThread< RangeType >::setup().

57 {

58 }

◆ restartableName()

std::string Restartable::restartableName ( const std::string & data_name ) const

protectedinherited

Gets the name of a piece of restartable data given a data name, adding the system name and object name prefix.

This should only be used in this interface and in testing.

Definition at line 66 of file Restartable.C.

Referenced by Restartable::declareRecoverableData(), and Restartable::declareRestartableDataHelper().

 {
   return _restartable_system_name + "/" + _restartable_name + "/" + data_name;
 }

◆ setCurrentDirection()

void Transfer::setCurrentDirection ( const int direction )

inlineinherited

Set this Transfer to be executed in a given direction.

Definition at line 89 of file Transfer.h.

Referenced by FEProblemBase::execMultiAppTransfers().

   {
     _current_direction = direction;
     _direction = direction;
   }

◆ 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 MaterialBase, Material, GeneralUserObject, NodalUserObject, Constraint, and ThreadedGeneralUserObject.

Definition at line 61 of file SetupInterface.C.

62 {

63 }

◆ timedSectionName()

std::string PerfGraphInterface::timedSectionName ( const std::string & section_name ) const

protectedinherited

Returns: The name of the timed section with the name section_name.

Optionally adds a prefix if one is defined.

Definition at line 47 of file PerfGraphInterface.C.

Referenced by PerfGraphInterface::registerTimedSection().

 {
   return _prefix.empty() ? "" : (_prefix + "::") + section_name;
 }

◆ timestepSetup()

void SetupInterface::timestepSetup ( )

virtualinherited

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

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, Function, Positions, Times, SolutionUserObjectBase, Console, VectorPostprocessorVisualizationAux, EqualValueEmbeddedConstraintTempl< is_ad >, NumNonlinearIterations, VectorMemoryUsage, JSONOutput, and MemoryUsage.

Definition at line 46 of file SetupInterface.C.

Referenced by JSONOutput::timestepSetup(), and MooseVariableField< Real >::timestepSetup().

47 {

48 }

◆ transformBoundingBox()

void MultiAppTransfer::transformBoundingBox	(	libMesh::BoundingBox &	box,
		const MultiAppCoordTransform &	transform
	)

staticprotectedinherited

Transform a bounding box according to the transformations in the provided coordinate transformation object.

Definition at line 460 of file MultiAppTransfer.C.

Referenced by MultiAppTransfer::getFromBoundingBoxes(), and MultiAppGeneralFieldTransfer::getRestrictedFromBoundingBoxes().

 {
   MultiApp::transformBoundingBox(box, transform);
 }

◆ type()

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

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 89 of file MooseBase.h.

   {
     mooseAssert(_type.size(), "Empty type");
     return _type;
   }

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

Get the class's combined type and name; useful in error handling.

Returns: The type and name of this class in the form '<type()> "<name()>"'.

Definition at line 54 of file MooseBase.C.

Referenced by FEProblemBase::addPostprocessor(), MaterialPropertyStorage::addProperty(), FEProblemBase::addReporter(), FEProblemBase::addVectorPostprocessor(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< std::vector< T > >::finalize(), and ReporterData::getReporterInfo().

 {
   return type() + std::string(" \"") + name() + std::string("\"");
 }

◆ uniqueName()

MooseObjectName MooseBase::uniqueName ( ) const

inherited

Returns: The unique name for accessing input parameters of this object in the InputParameterWarehouse

Definition at line 66 of file MooseBase.C.

Referenced by MooseBase::connectControllableParams(), and Action::uniqueActionName().

 {
   if (!_pars.have_parameter<std::string>(unique_name_param))
     mooseError("uniqueName(): Object does not have a unique name");
   return MooseObjectName(_pars.get<std::string>(unique_name_param));
 }

◆ uniqueParameterName()

MooseObjectParameterName MooseBase::uniqueParameterName ( const std::string & parameter_name ) const

inherited

Returns: The unique parameter name of a valid parameter of this object for accessing parameter controls

Definition at line 60 of file MooseBase.C.

 {
   return MooseObjectParameterName(getBase(), name(), parameter_name);
 }

◆ usesMooseAppCoordTransform()

bool MultiAppGeneralFieldUserObjectTransfer::usesMooseAppCoordTransform ( ) const

inlineoverrideprivatevirtual

Whether this transfer handles non-translation-based transformations, e.g.

whether it uses the MooseAppCoordTransform object

Reimplemented from MultiAppTransfer.

Definition at line 37 of file MultiAppGeneralFieldUserObjectTransfer.h.

37 { return true; }

◆ validParams()

InputParameters MultiAppGeneralFieldUserObjectTransfer::validParams ( )

static

Definition at line 27 of file MultiAppGeneralFieldUserObjectTransfer.C.

 {
   InputParameters params = MultiAppGeneralFieldTransfer::validParams();
   params.addClassDescription(
       "Transfers user object spatial evaluations from an origin app onto a variable in the target "
       "application.");
 
   params.set<std::vector<VariableName>>("source_variable") = std::vector<VariableName>{};
   params.suppressParameter<std::vector<VariableName>>("source_variable");
   params.addRequiredParam<UserObjectName>("source_user_object",
                                           "The UserObject you want to transfer values from. "
                                           "It must implement the SpatialValue() class routine");
 
   MultiAppTransfer::addUserObjectExecutionCheckParam(params);
 
   // Blanket ban on origin boundary restriction. User objects tend to extend beyond boundaries,
   // and be able to be evaluated within a volume rather than only on a boundary
   // This could be re-enabled for spatial user objects that are only defined on boundaries
   params.suppressParameter<std::vector<BoundaryName>>("from_boundaries");
   return params;
 }

◆ variableIntegrityCheck()

void MultiAppTransfer::variableIntegrityCheck	(	const AuxVariableName &	var_name,
		bool	is_from_multiapp
	)		const

inherited

Utility to verify that the variable in the destination system exists.

Definition at line 197 of file MultiAppTransfer.C.

Referenced by MultiAppFieldTransfer::initialSetup(), and MultiAppVariableValueSampleTransfer::initialSetup().

 {
   bool variable_found = false;
   bool has_an_app = false;
 
   // Check the from_multi_app for the variable
   if (is_from_multiapp && _from_multi_app)
     for (unsigned int i = 0; i < _from_multi_app->numGlobalApps(); i++)
       if (_from_multi_app->hasLocalApp(i))
       {
         has_an_app = true;
         if (_from_multi_app->appProblemBase(i).hasVariable(var_name))
           variable_found = true;
       }
 
   // Check the to_multi_app for the variable
   if (!is_from_multiapp && _to_multi_app)
     for (unsigned int i = 0; i < _to_multi_app->numGlobalApps(); i++)
       if (_to_multi_app->hasLocalApp(i))
       {
         has_an_app = true;
         if (_to_multi_app->appProblemBase(i).hasVariable(var_name))
           variable_found = true;
       }
 
   if (!variable_found && has_an_app)
     mooseError("Cannot find variable ", var_name, " for ", name(), " Transfer");
 }

Member Data Documentation

◆ _action_factory

ActionFactory& ParallelParamObject::_action_factory

protectedinherited

Builds Actions.

Definition at line 40 of file ParallelParamObject.h.

Referenced by AddActionComponentAction::act(), CreateMeshSetupActionsForComponents::act(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

◆ _already_output_search_value_conflicts

bool MultiAppGeneralFieldTransfer::_already_output_search_value_conflicts

protectedinherited

Whether we already output the search value conflicts.

Definition at line 272 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::postExecute(), and MultiAppGeneralFieldTransfer::prepareToTransfer().

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 353 of file MooseBase.h.

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

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

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _current_direction

MooseEnum Transfer::_current_direction

protectedinherited

Definition at line 106 of file Transfer.h.

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 78 of file SetupInterface.h.

Referenced by PseudoTimestep::execute().

◆ _direction

MooseEnum Transfer::_direction

protectedinherited

The current direction that is being executed for this Transfer. _direction is to be deprecated for _current_direction

Definition at line 105 of file Transfer.h.

Referenced by Transfer::direction(), MultiAppTransfer::MultiAppTransfer(), Transfer::setCurrentDirection(), and Transfer::Transfer().

◆ _directions

MultiMooseEnum Transfer::_directions

protectedinherited

The directions this Transfer is to be executed on.

Definition at line 110 of file Transfer.h.

◆ _displaced_source_mesh

bool MultiAppTransfer::_displaced_source_mesh

protectedinherited

True if displaced mesh is used for the source mesh, otherwise false.

Definition at line 161 of file MultiAppTransfer.h.

Referenced by MultiAppGeneralFieldNearestLocationTransfer::buildKDTrees(), MultiAppGeneralFieldShapeEvaluationTransfer::buildMeshFunctions(), MultiAppUserObjectTransfer::execute(), MultiAppGeometricInterpolationTransfer::fillSourceInterpolationPoints(), MultiAppUserObjectTransfer::findSubAppToTransferFrom(), MultiAppGeneralFieldTransfer::getAppInfo(), MultiAppTransfer::getAppInfo(), MultiAppGeneralFieldTransfer::getRestrictedFromBoundingBoxes(), MultiAppGeneralFieldTransfer::initialSetup(), MultiAppGeneralFieldTransfer::prepareToTransfer(), and MultiAppShapeEvaluationTransfer::transferVariable().

◆ _displaced_target_mesh

bool MultiAppTransfer::_displaced_target_mesh

protectedinherited

True if displaced mesh is used for the target mesh, otherwise false.

Definition at line 163 of file MultiAppTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::cacheIncomingInterpVals(), MultiAppGeneralFieldTransfer::examineLocalValueConflicts(), MultiAppGeneralFieldTransfer::examineReceivedValueConflicts(), MultiAppUserObjectTransfer::execute(), MultiAppGeneralFieldTransfer::extractOutgoingPoints(), MultiAppTransfer::getAppInfo(), MultiAppGeneralFieldTransfer::initialSetup(), MultiAppGeometricInterpolationTransfer::interpolateTargetPoints(), MultiAppGeneralFieldTransfer::prepareToTransfer(), and MultiAppGeneralFieldTransfer::setSolutionVectorValues().

◆ _elemental_boundary_restriction_on_sides

const bool MultiAppGeneralFieldTransfer::_elemental_boundary_restriction_on_sides

protectedinherited

Whether elemental variable boundary restriction is considered by element side or element nodes.

Definition at line 254 of file MultiAppGeneralFieldTransfer.h.

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 50 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this object.

Definition at line 75 of file SetupInterface.h.

◆ _factory

Factory& ParallelParamObject::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 37 of file ParallelParamObject.h.

Referenced by ElementIDOutputAction::act(), AutoCheckpointAction::act(), PartitionerAction::act(), CreateExecutionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), AdaptivityAction::act(), CombineComponentsMeshes::act(), SetupMeshAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), SetupDebugAction::act(), ComposeTimeStepperAction::act(), SetupPreconditionerAction::act(), SetupResidualDebugAction::act(), MaterialDerivativeTestAction::act(), CreateDisplacedProblemAction::act(), SetAdaptivityOptionsAction::act(), DisplayGhostingAction::act(), AddControlAction::act(), MaterialOutputAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), AddNodalNormalsAction::act(), ComponentMeshTransformHelper::addMeshGenerators(), CylinderComponent::addMeshGenerators(), DiffusionPhysicsBase::addPostprocessors(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), SampledOutput::cloneMesh(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), ActionComponent::getFactory(), PhysicsBase::getFactory(), MaterialOutputAction::getParams(), and ProjectedStatefulMaterialStorageAction::processProperty().

◆ _fe_problem

FEProblemBase& Transfer::_fe_problem

protectedinherited

Definition at line 97 of file Transfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), MultiAppGeneralFieldTransfer::closestToPosition(), MultiAppGeneralFieldNearestLocationTransfer::computeNumSources(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppPostprocessorTransfer::execute(), execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppVectorPostprocessorTransfer::executeToMultiapp(), MultiAppGeneralFieldNearestLocationTransfer::getNumDivisions(), MultiAppCloneReporterTransfer::initialSetup(), MultiAppGeneralFieldTransfer::locatePointReceivers(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppGeometricInterpolationTransfer::MultiAppGeometricInterpolationTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), and MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer().

◆ _from_blocks

std::set<SubdomainID> MultiAppGeneralFieldTransfer::_from_blocks

protectedinherited

Origin block(s) restriction.

Definition at line 222 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppGeneralFieldNearestLocationTransfer::buildKDTrees(), MultiAppGeneralFieldTransfer::getRestrictedFromBoundingBoxes(), and MultiAppGeneralFieldTransfer::initialSetup().

◆ _from_boundaries

std::set<BoundaryID> MultiAppGeneralFieldTransfer::_from_boundaries

protectedinherited

Origin boundary(ies) restriction.

Definition at line 231 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppGeneralFieldNearestLocationTransfer::buildKDTrees(), MultiAppGeneralFieldTransfer::getRestrictedFromBoundingBoxes(), and MultiAppGeneralFieldTransfer::initialSetup().

◆ _from_es

std::vector<libMesh::EquationSystems *> MultiAppTransfer::_from_es

protectedinherited

Definition at line 148 of file MultiAppTransfer.h.

Referenced by MultiAppTransfer::getAppInfo().

◆ _from_local2global_map

std::vector<unsigned int> MultiAppTransfer::_from_local2global_map

protectedinherited

Given local app index, returns global app index.

Definition at line 205 of file MultiAppTransfer.h.

Referenced by MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppTransfer::getAppInfo(), MultiAppTransfer::getFromMultiAppInfo(), MultiAppTransfer::getGlobalSourceAppIndex(), MultiAppGeneralFieldTransfer::getGlobalStartAppPerProc(), MultiAppTransfer::getLocalSourceAppIndex(), MultiAppGeneralFieldTransfer::outputValueConflicts(), and MultiAppShapeEvaluationTransfer::transferVariable().

◆ _from_mesh_division_behavior

const MooseEnum& MultiAppGeneralFieldTransfer::_from_mesh_division_behavior

protectedinherited

How to use the origin mesh divisions to restrict the transfer.

Definition at line 240 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointMeshDivision(), MultiAppGeneralFieldNearestLocationTransfer::buildKDTrees(), MultiAppGeneralFieldTransfer::cacheOutgoingPointInfo(), MultiAppGeneralFieldNearestLocationTransfer::checkRestrictionsForSource(), MultiAppGeneralFieldTransfer::initialSetup(), MultiAppGeneralFieldNearestLocationTransfer::MultiAppGeneralFieldNearestLocationTransfer(), and MultiAppGeneralFieldShapeEvaluationTransfer::MultiAppGeneralFieldShapeEvaluationTransfer().

◆ _from_mesh_divisions

std::vector<const MeshDivision *> MultiAppGeneralFieldTransfer::_from_mesh_divisions

protectedinherited

Division of the origin mesh.

Definition at line 234 of file MultiAppGeneralFieldTransfer.h.

◆ _from_meshes

std::vector<MooseMesh *> MultiAppTransfer::_from_meshes

protectedinherited

Definition at line 150 of file MultiAppTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppNearestNodeTransfer::execute(), MultiAppTransfer::getAppInfo(), MultiAppTransfer::getFromBoundingBoxes(), MultiAppGeneralFieldNearestLocationTransfer::getNumAppsPerTree(), MultiAppGeneralFieldNearestLocationTransfer::getNumDivisions(), and MultiAppGeneralFieldTransfer::getRestrictedFromBoundingBoxes().

◆ _from_point_locators

std::vector<std::unique_ptr<libMesh::PointLocatorBase> > MultiAppGeneralFieldTransfer::_from_point_locators

protectedinherited

Point locators, useful to examine point location with regards to domain restriction.

Definition at line 257 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppGeneralFieldNearestLocationTransfer::checkRestrictionsForSource(), and MultiAppGeneralFieldTransfer::getAppInfo().

◆ _from_positions

std::vector<Point> MultiAppTransfer::_from_positions

protectedinherited

Definition at line 152 of file MultiAppTransfer.h.

Referenced by MultiAppTransfer::getAppInfo(), MultiAppTransfer::getFromMultiAppInfo(), and MultiAppGeneralFieldNearestLocationTransfer::getPointInLocalSourceFrame().

◆ _from_postprocessors_to_be_preserved

std::vector<PostprocessorName> MultiAppConservativeTransfer::_from_postprocessors_to_be_preserved

protectedinherited

Postprocessor evaluates an adjuster for the source physics.

Definition at line 51 of file MultiAppConservativeTransfer.h.

Referenced by MultiAppConservativeTransfer::initialSetup(), and MultiAppConservativeTransfer::postExecute().

◆ _from_problems

std::vector<FEProblemBase *> MultiAppTransfer::_from_problems

protectedinherited

Definition at line 146 of file MultiAppTransfer.h.

◆ _from_transforms

std::vector<std::unique_ptr<MultiAppCoordTransform> > MultiAppTransfer::_from_transforms

protectedinherited

Definition at line 154 of file MultiAppTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppGeneralFieldNearestLocationTransfer::buildKDTrees(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), MultiAppGeneralFieldShapeEvaluationTransfer::evaluateInterpValuesWithMeshFunctions(), evaluateInterpValuesWithUserObjects(), MultiAppGeneralFieldTransfer::examineLocalValueConflicts(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppGeometricInterpolationTransfer::execute(), MultiAppUserObjectTransfer::findSubAppToTransferFrom(), MultiAppTransfer::getAppInfo(), MultiAppTransfer::getFromBoundingBoxes(), MultiAppGeneralFieldNearestLocationTransfer::getPointInLocalSourceFrame(), MultiAppGeneralFieldTransfer::getRestrictedFromBoundingBoxes(), and MultiAppShapeEvaluationTransfer::transferVariable().

◆ _from_var_components

const std::vector<unsigned int> MultiAppGeneralFieldTransfer::_from_var_components

protectedinherited

Origin array/vector variable components.

Definition at line 195 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::getFromVarName(), MultiAppGeneralFieldTransfer::initialSetup(), and MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer().

◆ _from_var_name

VariableName MultiAppConservativeTransfer::_from_var_name

protectedinherited

This values are used if a derived class only supports one variable.

Definition at line 45 of file MultiAppConservativeTransfer.h.

Referenced by MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), and MultiAppGeometricInterpolationTransfer::execute().

◆ _from_var_names

const std::vector<VariableName> MultiAppConservativeTransfer::_from_var_names

protectedinherited

Name of variables transferring from.

Definition at line 40 of file MultiAppConservativeTransfer.h.

◆ _global_app_start_per_proc

std::vector<unsigned int> MultiAppGeneralFieldTransfer::_global_app_start_per_proc

protectedinherited

First app each processor owns, indexed by processor If no app on the processor, will have a -1 for the app start instead.

Definition at line 261 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::locatePointReceivers(), and MultiAppGeneralFieldTransfer::prepareToTransfer().

◆ _greedy_search

bool MultiAppGeneralFieldTransfer::_greedy_search

protectedinherited

Whether or not a greedy strategy will be used If true, all the partitions will be checked for a given outgoing point.

Definition at line 266 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::locatePointReceivers().

◆ _local_bboxes

std::vector<BoundingBox> MultiAppGeneralFieldUserObjectTransfer::_local_bboxes

private

Definition at line 56 of file MultiAppGeneralFieldUserObjectTransfer.h.

Referenced by evaluateInterpValues(), and prepareEvaluationOfInterpValues().

◆ _multi_app

std::shared_ptr<MultiApp> MultiAppTransfer::_multi_app

protectedinherited

Deprecated class attribute for compatibility with the apps.

Definition at line 143 of file MultiAppTransfer.h.

Referenced by MultiAppUserObjectTransfer::execute(), MultiAppUserObjectTransfer::findSubAppToTransferFrom(), MultiAppTransfer::getMultiApp(), and MultiAppTransfer::MultiAppTransfer().

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 359 of file MooseBase.h.

◆ _nearest_positions_obj

const Positions* MultiAppGeneralFieldTransfer::_nearest_positions_obj

protectedinherited

Definition at line 215 of file MultiAppGeneralFieldTransfer.h.

◆ _pars

const InputParameters& MooseBase::_pars

protectedinherited

The object's parameters.

Definition at line 362 of file MooseBase.h.

Referenced by AddFVICAction::act(), AddICAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupMeshAction::act(), ComposeTimeStepperAction::act(), SetupDebugAction::act(), AddAuxKernelAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PiecewiseTabularBase::buildFromFile(), PNGOutput::calculateRescalingValues(), MooseBase::callMooseError(), MooseBase::connectControllableParams(), Console::Console(), MooseApp::copyInputs(), MaterialBase::declareADProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateData(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), GlobalParamsAction::parameters(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), Eigenvalue::prepareSolverOptions(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _pg_moose_app

MooseApp& PerfGraphInterface::_pg_moose_app

protectedinherited

The MooseApp that owns the PerfGraph.

Definition at line 124 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::perfGraph().

◆ _prefix

const std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 127 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::timedSectionName().

◆ _preserve_transfer

bool MultiAppConservativeTransfer::_preserve_transfer

protectedinherited

If this transfer is going to conserve the physics.

Definition at line 49 of file MultiAppConservativeTransfer.h.

Referenced by MultiAppConservativeTransfer::initialSetup(), and MultiAppConservativeTransfer::postExecute().

◆ _restartable_app

MooseApp& Restartable::_restartable_app

protectedinherited

Reference to the application.

Definition at line 227 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp(), and Restartable::registerRestartableNameWithFilterOnApp().

◆ _restartable_read_only

const bool Restartable::_restartable_read_only

protectedinherited

Flag for toggling read only status (see ReporterData)

Definition at line 236 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp().

◆ _restartable_system_name

const std::string Restartable::_restartable_system_name

protectedinherited

The system name this object is in.

Definition at line 230 of file Restartable.h.

Referenced by Restartable::restartableName().

◆ _restartable_tid

const THREAD_ID Restartable::_restartable_tid

protectedinherited

The thread ID for this object.

Definition at line 233 of file Restartable.h.

Referenced by Restartable::declareRestartableDataHelper().

◆ _search_value_conflicts

bool MultiAppGeneralFieldTransfer::_search_value_conflicts

protectedinherited

Whether to look for conflicts between origin points, multiple valid values for a target point.

Definition at line 269 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::cacheIncomingInterpVals(), MultiAppGeneralFieldTransfer::closestToPosition(), MultiAppGeneralFieldTransfer::detectConflict(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), MultiAppGeneralFieldShapeEvaluationTransfer::evaluateInterpValuesWithMeshFunctions(), evaluateInterpValuesWithUserObjects(), MultiAppGeneralFieldTransfer::locatePointReceivers(), MultiAppGeneralFieldTransfer::postExecute(), MultiAppGeneralFieldTransfer::prepareToTransfer(), and MultiAppGeneralFieldTransfer::transferVariable().

◆ _search_value_conflicts_max_log

const unsigned int MultiAppGeneralFieldTransfer::_search_value_conflicts_max_log

protectedinherited

How many conflicts are output to console.

Definition at line 275 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::outputValueConflicts().

◆ _skip_coordinate_collapsing

const bool MultiAppTransfer::_skip_coordinate_collapsing

protectedinherited

Whether to skip coordinate collapsing (transformations of coordinates between applications using different frames of reference)

Definition at line 158 of file MultiAppTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), MultiAppTransfer::getAppInfo(), MultiAppGeneralFieldNearestLocationTransfer::getPointInLocalSourceFrame(), MultiAppTransfer::getPointInTargetAppFrame(), and MultiAppGeneralFieldTransfer::outputValueConflicts().

◆ _source_app_must_contain_point

bool MultiAppGeneralFieldTransfer::_source_app_must_contain_point

protectedinherited

Whether the source app mesh must actually contain the points for them to be considered or whether the bounding box is enough.

If false, we can interpolate between apps

Definition at line 219 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppGeneralFieldNearestLocationTransfer::checkRestrictionsForSource(), MultiAppGeneralFieldNearestLocationTransfer::MultiAppGeneralFieldNearestLocationTransfer(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), and MultiAppGeneralFieldUserObjectTransfer().

◆ _subproblem

SubProblem& Transfer::_subproblem

protectedinherited

Definition at line 96 of file Transfer.h.

◆ _sys

SystemBase& Transfer::_sys

protectedinherited

Definition at line 98 of file Transfer.h.

◆ _tid

THREAD_ID Transfer::_tid

protectedinherited

Definition at line 100 of file Transfer.h.

Referenced by MultiAppPostprocessorToAuxScalarTransfer::execute(), and MultiAppScalarToAuxScalarTransfer::execute().

◆ _to_blocks

std::set<SubdomainID> MultiAppGeneralFieldTransfer::_to_blocks

protectedinherited

Target block(s) restriction.

Definition at line 225 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::extractOutgoingPoints(), MultiAppGeneralFieldTransfer::initialSetup(), and MultiAppGeneralFieldTransfer::setSolutionVectorValues().

◆ _to_boundaries

std::set<BoundaryID> MultiAppGeneralFieldTransfer::_to_boundaries

protectedinherited

Target boundary(ies) restriction.

Definition at line 228 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::extractOutgoingPoints(), and MultiAppGeneralFieldTransfer::initialSetup().

◆ _to_es

std::vector<libMesh::EquationSystems *> MultiAppTransfer::_to_es

protectedinherited

Definition at line 147 of file MultiAppTransfer.h.

Referenced by MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppTransfer::getAppInfo(), and MultiAppShapeEvaluationTransfer::transferVariable().

◆ _to_local2global_map

std::vector<unsigned int> MultiAppTransfer::_to_local2global_map

protectedinherited

Given local app index, returns global app index.

Definition at line 203 of file MultiAppTransfer.h.

Referenced by MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppTransfer::getAppInfo(), MultiAppTransfer::getGlobalTargetAppIndex(), MultiAppTransfer::getToMultiAppInfo(), MultiAppTransfer::getTransferVector(), MultiAppGeneralFieldTransfer::outputValueConflicts(), and MultiAppShapeEvaluationTransfer::transferVariable().

◆ _to_mesh_division_behavior

const MooseEnum& MultiAppGeneralFieldTransfer::_to_mesh_division_behavior

protectedinherited

How to use the target mesh divisions to restrict the transfer.

Definition at line 243 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointMeshDivision(), MultiAppGeneralFieldNearestLocationTransfer::buildKDTrees(), MultiAppGeneralFieldTransfer::cacheOutgoingPointInfo(), MultiAppGeneralFieldNearestLocationTransfer::checkRestrictionsForSource(), MultiAppGeneralFieldTransfer::initialSetup(), MultiAppGeneralFieldTransfer::locatePointReceivers(), and MultiAppGeneralFieldShapeEvaluationTransfer::MultiAppGeneralFieldShapeEvaluationTransfer().

◆ _to_mesh_divisions

std::vector<const MeshDivision *> MultiAppGeneralFieldTransfer::_to_mesh_divisions

protectedinherited

Division of the target mesh.

Definition at line 237 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppGeneralFieldTransfer::cacheOutgoingPointInfo(), MultiAppGeneralFieldTransfer::extractOutgoingPoints(), MultiAppGeneralFieldTransfer::initialSetup(), and MultiAppGeneralFieldTransfer::locatePointReceivers().

◆ _to_meshes

std::vector<MooseMesh *> MultiAppTransfer::_to_meshes

protectedinherited

Definition at line 149 of file MultiAppTransfer.h.

Referenced by MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppTransfer::getAppInfo(), MultiAppGeneralFieldTransfer::getMaxToProblemsBBoxDimensions(), MultiAppNearestNodeTransfer::getTargetLocalNodes(), MultiAppGeneralFieldTransfer::locatePointReceivers(), MultiAppGeneralFieldTransfer::setSolutionVectorValues(), and MultiAppShapeEvaluationTransfer::transferVariable().

◆ _to_positions

std::vector<Point> MultiAppTransfer::_to_positions

protectedinherited

Definition at line 151 of file MultiAppTransfer.h.

Referenced by MultiAppTransfer::getAppInfo(), and MultiAppTransfer::getToMultiAppInfo().

◆ _to_postprocessors_to_be_preserved

std::vector<PostprocessorName> MultiAppConservativeTransfer::_to_postprocessors_to_be_preserved

protectedinherited

Postprocessor evaluates an adjuster for the target physics.

Definition at line 53 of file MultiAppConservativeTransfer.h.

Referenced by MultiAppConservativeTransfer::initialSetup(), and MultiAppConservativeTransfer::postExecute().

◆ _to_problems

std::vector<FEProblemBase *> MultiAppTransfer::_to_problems

protectedinherited

Definition at line 145 of file MultiAppTransfer.h.

◆ _to_transforms

std::vector<std::unique_ptr<MultiAppCoordTransform> > MultiAppTransfer::_to_transforms

protectedinherited

Definition at line 153 of file MultiAppTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::cacheIncomingInterpVals(), MultiAppGeneralFieldTransfer::cacheOutgoingPointInfo(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppGeometricInterpolationTransfer::execute(), MultiAppGeneralFieldTransfer::extractOutgoingPoints(), MultiAppTransfer::getAppInfo(), MultiAppTransfer::getPointInTargetAppFrame(), MultiAppGeneralFieldTransfer::locatePointReceivers(), MultiAppGeneralFieldTransfer::outputValueConflicts(), and MultiAppShapeEvaluationTransfer::transferVariable().

◆ _to_var_components

const std::vector<unsigned int> MultiAppGeneralFieldTransfer::_to_var_components

protectedinherited

Target array/vector variable components.

Definition at line 198 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::getToVarName(), MultiAppGeneralFieldTransfer::initialSetup(), and MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer().

◆ _to_var_name

AuxVariableName MultiAppConservativeTransfer::_to_var_name

protectedinherited

Definition at line 46 of file MultiAppConservativeTransfer.h.

Referenced by MultiAppConservativeTransfer::adjustTransferredSolution(), MultiAppConservativeTransfer::adjustTransferredSolutionNearestPoint(), MultiAppNearestNodeTransfer::execute(), MultiAppGeometricInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppProjectionTransfer::initialSetup(), MultiAppGeometricInterpolationTransfer::interpolateTargetPoints(), and MultiAppProjectionTransfer::projectSolution().

◆ _to_var_names

const std::vector<AuxVariableName> MultiAppConservativeTransfer::_to_var_names

protectedinherited

Name of variables transferring to.

Definition at line 42 of file MultiAppConservativeTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::getToVarName(), MultiAppConservativeTransfer::getToVarNames(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppGeneralFieldUserObjectTransfer(), MultiAppGeometricInterpolationTransfer::MultiAppGeometricInterpolationTransfer(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppProjectionTransfer::MultiAppProjectionTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), and MultiAppShapeEvaluationTransfer::transferVariable().

◆ _type

const std::string& MooseBase::_type

protectedinherited

The type of this class.

Definition at line 356 of file MooseBase.h.

Referenced by ExplicitTimeIntegrator::ExplicitTimeIntegrator(), FEProblemSolve::FEProblemSolve(), FillBetweenPointVectorsGenerator::generate(), FillBetweenSidesetsGenerator::generate(), FillBetweenCurvesGenerator::generate(), ExplicitTimeIntegrator::init(), FEProblemBase::init(), MooseBase::MooseBase(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), FEProblemBase::solverTypeString(), and MooseBase::type().

◆ _use_bounding_boxes

const bool MultiAppGeneralFieldTransfer::_use_bounding_boxes

protectedinherited

Whether to use bounding boxes to determine the applications that may receive point requests then send value data, and at other various checks.

Definition at line 202 of file MultiAppGeneralFieldTransfer.h.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), MultiAppGeneralFieldTransfer::locatePointReceivers(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppGeneralFieldShapeEvaluationTransfer::prepareEvaluationOfInterpValues(), and prepareEvaluationOfInterpValues().

◆ _use_nearest_app

const bool MultiAppGeneralFieldTransfer::_use_nearest_app

protectedinherited

Whether to keep track of the distance from the requested point to the app position.

Definition at line 205 of file MultiAppGeneralFieldTransfer.h.

◆ _user_object_name

const std::string MultiAppGeneralFieldUserObjectTransfer::_user_object_name

private

Name of the source user object in all the source problems.

Definition at line 51 of file MultiAppGeneralFieldUserObjectTransfer.h.

Referenced by evaluateInterpValuesWithUserObjects(), and execute().

◆ app_param

const std::string MooseBase::app_param = "_moose_app"

staticinherited

The name of the parameter that contains the MooseApp.

Definition at line 59 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MeshGenerator::addMeshSubgenerator(), InputParameters::callMooseError(), ActionFactory::create(), Factory::getValidParams(), ActionFactory::getValidParams(), AutomaticMortarGeneration::initOutput(), SetupMeshAction::modifyParamsForUseSplit(), and MortarNodalGeometryOutput::validParams().

◆ moose_base_param

const std::string MooseBase::moose_base_param = "_moose_base"

staticinherited

The name of the parameter that contains the moose system base.

Definition at line 61 of file MooseBase.h.

Referenced by InputParameters::getBase(), InputParameters::hasBase(), and InputParameters::registerBase().

◆ name_param

const std::string MooseBase::name_param = "_object_name"

staticinherited

The name of the parameter that contains the object name.

Definition at line 55 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), MooseObjectUnitTest::buildObjects(), ActionFactory::create(), AppFactory::create(), InputParameters::getObjectName(), AutomaticMortarGeneration::initOutput(), InputParameters::isMooseBaseObject(), MooseMesh::prepare(), CouplingFunctorCheckAction::validParams(), and MooseBase::validParams().

◆ OutOfMeshValue

const Number Transfer::OutOfMeshValue = -999999

staticinherited

Definition at line 113 of file Transfer.h.

Referenced by MultiAppProjectionTransfer::execute(), and MultiAppShapeEvaluationTransfer::transferVariable().

◆ type_param

const std::string MooseBase::type_param = "_type"

staticinherited

The name of the parameter that contains the object type.

Definition at line 53 of file MooseBase.h.

Referenced by ActionFactory::create(), AppFactory::create(), InputParameters::getObjectType(), Factory::initialize(), InputParameters::isMooseBaseObject(), MooseBase::validParams(), and MortarNodalGeometryOutput::validParams().

◆ unique_name_param

const std::string MooseBase::unique_name_param = "_unique_name"

staticinherited

The name of the parameter that contains the unique object name.

Definition at line 57 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), AppFactory::create(), InputParameterWarehouse::removeInputParameters(), MooseBase::uniqueName(), and MooseBase::validParams().

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

include/transfers/MultiAppGeneralFieldUserObjectTransfer.h
src/transfers/MultiAppGeneralFieldUserObjectTransfer.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

Member Enumeration Documentation

◆ DIRECTION

◆ MeshDivisionTransferUse

Constructor & Destructor Documentation

◆ MultiAppGeneralFieldUserObjectTransfer()

Member Function Documentation

◆ acceptPointInOriginMesh()

◆ acceptPointMeshDivision()

◆ addBBoxFactorParam()

◆ addSkipCoordCollapsingParam()

◆ addUserObjectExecutionCheckParam()

◆ callMooseError() [1/2]

◆ callMooseError() [2/2]

◆ checkMultiAppExecuteOn()

◆ checkParentAppUserObjectExecuteOn()

◆ checkSiblingsTransferSupported()

◆ checkVariable()

◆ closestToPosition()

◆ connectControllableParams()

◆ currentDirection()

◆ customSetup()

◆ declareManagedRestartableDataWithContext()

◆ declareRecoverableData()

◆ declareRestartableData()

◆ declareRestartableDataWithContext()

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ detectConflict()

◆ direction()

◆ directions()

◆ enabled()

◆ errorIfObjectExecutesOnTransferInSourceApp()

◆ errorPrefix()

◆ evaluateInterpValues()

◆ evaluateInterpValuesWithUserObjects()

◆ execute()

◆ extendBoundingBoxes()

◆ extractLocalFromBoundingBoxes()

◆ find_sys()

◆ getAppInfo()

◆ getBase()

◆ getCheckedPointerParam()

◆ getDataFileName()

◆ getDataFileNameByName()

◆ getDataFilePath()

◆ getEquationSystem()

◆ getExecuteOnEnum()

◆ getFromBoundingBoxes() [1/2]

◆ getFromBoundingBoxes() [2/2]

◆ getFromMultiApp()

◆ getFromName()

◆ getFromsPerProc()

◆ getFromVarName()

◆ getFromVarNames()

◆ getGlobalSourceAppIndex()

◆ getGlobalTargetAppIndex()

◆ getHitNode()

◆ getLocalSourceAppIndex()

◆ getMooseApp()

◆ getMultiApp()

◆ getParam() [1/2]

◆ getParam() [2/2]

◆ getPointInTargetAppFrame()

◆ getRenamedParam()

◆ getRestartableData()

◆ getSharedPtr() [1/2]