Transfers mutable coefficient arrays between supported object types. More...

#include <MultiAppFXTransfer.h>

Inheritance diagram for MultiAppFXTransfer:

Public Types
enum	DIRECTION

typedef DataFileName	DataFileParameterType

Public Member Functions
	MultiAppFXTransfer (const InputParameters &parameters)

virtual void	execute () override

virtual void	initialSetup () override

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

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

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

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

std::string	getFromName () const

std::string	getToName () const

bool	hasFromMultiApp () const

bool	hasToMultiApp () const

virtual void	getAppInfo ()

const MultiMooseEnum &	directions ()

void	setCurrentDirection (const int direction)

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

bool	isKokkosObject (IsKokkosObjectKey &&) const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

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

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

PerfGraph &	perfGraph ()

MooseEnum	direction ()

MooseEnum	direction ()

MooseEnum	currentDirection ()

MooseEnum	currentDirection ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

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

static void	addSkipCoordCollapsingParam (InputParameters &params)

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

static std::string	possibleDirections ()

Public Attributes
	TO_MULTIAPP

	FROM_MULTIAPP

	BETWEEN_MULTIAPP

	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const libMesh::Number	OutOfMeshValue

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

Protected Member Functions
virtual GetProblemObject	scanProblemBaseForObject (FEProblemBase &base, const std::string &object_name, const std::string &app_name)
	Searches an FEProblemBase for a MutableCoefficientsInterface-based object and returns a function pointer to the matched function type. More...

std::vector< unsigned int >	getFromsPerProc ()

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

unsigned int	getGlobalSourceAppIndex (unsigned int i_from) const

unsigned int	getGlobalTargetAppIndex (unsigned int i_to) const

unsigned int	getLocalSourceAppIndex (unsigned int i_from) const

virtual void	checkSiblingsTransferSupported () const

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

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

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

void	checkMultiAppExecuteOn ()

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

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

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Static Protected Member Functions
static void	addUserObjectExecutionCheckParam (InputParameters &params)

static void	addBBoxFactorParam (InputParameters &params)

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

Protected Attributes
const std::string	_this_app_object_name
	Name of the MutableCoefficientsInterface-derived object in the creating app. More...

const std::string	_multi_app_object_name
	Name of the MutableCoefficientsInterface-derived object in the MultiApp. More...

GetProblemObject	getMultiAppObject
	Function pointer for grabbing the MultiApp object. More...

GetProblemObject	getSubAppObject
	Function pointer for grabbing the SubApp object. More...

std::shared_ptr< MultiApp >	_multi_app

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

bool	_displaced_source_mesh

bool	_displaced_target_mesh

Real	_bbox_factor

std::vector< unsigned int >	_to_local2global_map

std::vector< unsigned int >	_from_local2global_map

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

THREAD_ID	_tid

MultiMooseEnum	_directions

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

MooseApp &	_pg_moose_app

const std::string	_prefix

MooseEnum	_direction

MooseEnum	_current_direction

const Parallel::Communicator &	_communicator

Private Types
typedef MutableCoefficientsInterface &(MultiAppFXTransfer::*	GetProblemObject) (FEProblemBase &base, const std::string &object_name, THREAD_ID thread)
	Function pointer typedef for functions used to find, convert, and return the appropriate MutableCoefficientsInterface object from an FEProblemBase. More...

Private Member Functions
MutableCoefficientsInterface &	getMutableCoefficientsFunction (FEProblemBase &base, const std::string &object_name, THREAD_ID thread)
	Gets a MutableCoefficientsInterface-based Function, intented for use via function pointer. More...

MutableCoefficientsInterface &	getMutableCoefficientsUserOject (FEProblemBase &base, const std::string &object_name, THREAD_ID thread)
	Gets a MutableCoefficientsInterface-based UserObject, intended for use via function pointer. More...

Detailed Description

Transfers mutable coefficient arrays between supported object types.

Definition at line 19 of file MultiAppFXTransfer.h.

Member Typedef Documentation

◆ GetProblemObject

typedef MutableCoefficientsInterface&(MultiAppFXTransfer::* MultiAppFXTransfer::GetProblemObject) (FEProblemBase &base, const std::string &object_name, THREAD_ID thread)

private

Function pointer typedef for functions used to find, convert, and return the appropriate MutableCoefficientsInterface object from an FEProblemBase.

Definition at line 56 of file MultiAppFXTransfer.h.

Constructor & Destructor Documentation

◆ MultiAppFXTransfer()

MultiAppFXTransfer::MultiAppFXTransfer ( const InputParameters & parameters )

Definition at line 39 of file MultiAppFXTransfer.C.

   : MultiAppTransfer(parameters),
     _this_app_object_name(getParam<std::string>("this_app_object_name")),
     _multi_app_object_name(getParam<std::string>("multi_app_object_name")),
     getMultiAppObject(NULL),
     getSubAppObject(NULL)
 {
   if (_directions.size() != 1)
     paramError("direction", "This transfer is only unidirectional");
   if (hasToMultiApp() && hasFromMultiApp())
     mooseError("This transfer does not currently support between_multiapp transfer");
 }

Member Function Documentation

◆ execute()

void MultiAppFXTransfer::execute ( )

overridevirtual

Implements MultiAppTransfer.

Definition at line 160 of file MultiAppFXTransfer.C.

 {
   _console << "Beginning MultiAppFXTransfer: " << name() << std::endl;
 
   switch (_current_direction)
   {
     // LocalApp -> MultiApp
     case TO_MULTIAPP:
     {
       // Get a reference to the object in the LocalApp
       const MutableCoefficientsInterface & from_object =
           (this->*getMultiAppObject)(getToMultiApp()->problemBase(), _this_app_object_name, 0);
 
       for (unsigned int i = 0; i < getToMultiApp()->numGlobalApps(); ++i)
       {
         if (getToMultiApp()->hasLocalApp(i))
           for (THREAD_ID t = 0; t < libMesh::n_threads(); ++t)
           {
             // Get a reference to the object in each MultiApp
             MutableCoefficientsInterface & to_object = (this->*getSubAppObject)(
                 getToMultiApp()->appProblemBase(i), _multi_app_object_name, t);
 
             if (to_object.isCompatibleWith(from_object))
               to_object.importCoefficients(from_object);
             else
               mooseError("'",
                          _multi_app_object_name,
                          "' is not compatible with '",
                          _this_app_object_name,
                          "'");
           }
       }
       break;
     }
 
     // MultiApp -> LocalApp
     case FROM_MULTIAPP:
     {
       /*
        * For now we will assume that the transfers are 1:1 and the coefficients are synchronized
        * among all instances, thus we only need to grab the set of coefficients from the first
        * SubApp.
        */
       if (getFromMultiApp()->hasLocalApp(0))
       {
         // Get a reference to the first thread object in the first MultiApp
         const MutableCoefficientsInterface & from_object = (this->*getSubAppObject)(
             getFromMultiApp()->appProblemBase(0), _multi_app_object_name, 0);
 
         for (THREAD_ID t = 0; t < libMesh::n_threads(); ++t)
         {
           // Get a reference to the object in each LocalApp instance
           MutableCoefficientsInterface & to_object = (this->*getMultiAppObject)(
               getFromMultiApp()->problemBase(), _this_app_object_name, t);
 
           if (to_object.isCompatibleWith(from_object))
             to_object.importCoefficients(from_object);
           else
             mooseError("'",
                        _multi_app_object_name,
                        "' is not compatible with '",
                        _this_app_object_name,
                        "'");
         }
       }
       break;
     }
   }
 
   _console << "Finished MultiAppFXTransfer: " << name() << std::endl;
 }

◆ getMutableCoefficientsFunction()

MutableCoefficientsInterface & MultiAppFXTransfer::getMutableCoefficientsFunction	(	FEProblemBase &	base,
		const std::string &	object_name,
		THREAD_ID	thread
	)

private

Gets a MutableCoefficientsInterface-based Function, intented for use via function pointer.

Definition at line 142 of file MultiAppFXTransfer.C.

Referenced by scanProblemBaseForObject().

 {
   return dynamic_cast<MutableCoefficientsInterface &>(base.getFunction(object_name, thread));
 }

◆ getMutableCoefficientsUserOject()

MutableCoefficientsInterface & MultiAppFXTransfer::getMutableCoefficientsUserOject	(	FEProblemBase &	base,
		const std::string &	object_name,
		THREAD_ID	thread
	)

private

Gets a MutableCoefficientsInterface-based UserObject, intended for use via function pointer.

Definition at line 150 of file MultiAppFXTransfer.C.

Referenced by scanProblemBaseForObject().

 {
   // Get the non-const qualified UserObject, otherwise we would use getUserObject()
   auto & user_object = base.getUserObject<UserObject>(object_name, thread);
   return dynamic_cast<MutableCoefficientsInterface &>(user_object);
 }

◆ initialSetup()

void MultiAppFXTransfer::initialSetup ( )

overridevirtual

Reimplemented from MultiAppTransfer.

Definition at line 53 of file MultiAppFXTransfer.C.

 {
   const auto multi_app = hasFromMultiApp() ? getFromMultiApp() : getToMultiApp();
 
   // Search for the _this_app_object_name in the LocalApp
   getMultiAppObject =
       scanProblemBaseForObject(multi_app->problemBase(), _this_app_object_name, "MultiApp");
   if (getMultiAppObject == NULL)
     mooseError(
         "Transfer '", name(), "': Cannot find object '", _this_app_object_name, "' in MultiApp");
 
   // Search for the _multi_app_object_name in each of the MultiApps
   for (std::size_t i = 0; i < multi_app->numGlobalApps(); ++i)
     if (multi_app->hasLocalApp(i))
     {
       if (i == 0) // First time through, assign without checking against previous values
         getSubAppObject = scanProblemBaseForObject(
             multi_app->appProblemBase(i), _multi_app_object_name, multi_app->name());
       else if (getSubAppObject != scanProblemBaseForObject(multi_app->appProblemBase(i),
                                                            _multi_app_object_name,
                                                            multi_app->name()))
         mooseError("The name '",
                    _multi_app_object_name,
                    "' is assigned to two different object types. Please modify your input file and "
                    "try again.");
     }
   if (getSubAppObject == NULL)
     mooseError(
         "Transfer '", name(), "': Cannot find object '", _multi_app_object_name, "' in SubApp");
 }

◆ scanProblemBaseForObject()

MultiAppFXTransfer::GetProblemObject MultiAppFXTransfer::scanProblemBaseForObject	(	FEProblemBase &	base,
		const std::string &	object_name,
		const std::string &	app_name
	)

protectedvirtual

Searches an FEProblemBase for a MutableCoefficientsInterface-based object and returns a function pointer to the matched function type.

Definition at line 85 of file MultiAppFXTransfer.C.

Referenced by initialSetup().

 {
   /*
    * For now we are only considering Functions and UserObjects, as they are the only types currently
    * implemented with MutableCoefficientsInterface. Others may be added later.
    *
    * Functions:
    *   FunctionSeries
    *
    * UserObjects:
    *   FXBoundaryUserObject (via FXBaseUserObject)
    *   FXVolumeUserObject (via FXBaseUserObject)
    */
   MutableCoefficientsInterface * interface;
 
   // Check to see if the object with object_name is a Function
   if (base.hasFunction(object_name))
   {
     Function & function = base.getFunction(object_name);
     interface = dynamic_cast<MutableCoefficientsInterface *>(&function);
 
     // Check to see if the function is a subclass of MutableCoefficientsInterface
     if (interface)
       return &MultiAppFXTransfer::getMutableCoefficientsFunction;
     else
       mooseError("Function '",
                  object_name,
                  "' in '",
                  app_name,
                  "' does not inherit from MutableCoefficientsInterface.",
                  " Please change the function type and try again.");
   }
   // Check to see if the object with object_name is a UserObject
   else if (base.hasUserObject(object_name))
   {
     // Get the non-const qualified UserObject, otherwise we would use getUserObject()
     auto & user_object = base.getUserObject<UserObject>(object_name);
     interface = dynamic_cast<MutableCoefficientsInterface *>(&user_object);
 
     // Check to see if the userObject is a subclass of MutableCoefficientsInterface
     if (interface)
       return &MultiAppFXTransfer::getMutableCoefficientsUserOject;
     else
       mooseError("UserObject '",
                  object_name,
                  "' in '",
                  app_name,
                  "' does not inherit from MutableCoefficientsInterface.",
                  " Please change the function type and try again.");
   }
 
   return NULL;
 }

◆ validParams()

InputParameters MultiAppFXTransfer::validParams ( )

static

Definition at line 20 of file MultiAppFXTransfer.C.

 {
   InputParameters params = MultiAppTransfer::validParams();
 
   params.addClassDescription("Transfers coefficient arrays between objects that are derived from "
                              "MutableCoefficientsInterface; currently includes the following "
                              "types: FunctionSeries, FXBoundaryUserObject, and FXVolumeUserObject");
 
   params.addRequiredParam<std::string>(
       "this_app_object_name",
       "Name of the MutableCoefficientsInterface-derived object in this app (LocalApp).");
 
   params.addRequiredParam<std::string>(
       "multi_app_object_name",
       "Name of the MutableCoefficientsInterface-derived object in the MultiApp.");
 
   return params;
 }

Member Data Documentation

◆ _multi_app_object_name

const std::string MultiAppFXTransfer::_multi_app_object_name

protected

Name of the MutableCoefficientsInterface-derived object in the MultiApp.

Definition at line 35 of file MultiAppFXTransfer.h.

Referenced by execute(), and initialSetup().

◆ _this_app_object_name

const std::string MultiAppFXTransfer::_this_app_object_name

protected

Name of the MutableCoefficientsInterface-derived object in the creating app.

Definition at line 32 of file MultiAppFXTransfer.h.

Referenced by execute(), and initialSetup().

◆ getMultiAppObject

GetProblemObject MultiAppFXTransfer::getMultiAppObject

protected

Function pointer for grabbing the MultiApp object.

Definition at line 69 of file MultiAppFXTransfer.h.

Referenced by execute(), and initialSetup().

◆ getSubAppObject

GetProblemObject MultiAppFXTransfer::getSubAppObject

protected

Function pointer for grabbing the SubApp object.

Definition at line 72 of file MultiAppFXTransfer.h.

Referenced by execute(), and initialSetup().

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

functional_expansion_tools/include/transfers/MultiAppFXTransfer.h
functional_expansion_tools/src/transfers/MultiAppFXTransfer.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ GetProblemObject

Constructor & Destructor Documentation

◆ MultiAppFXTransfer()

Member Function Documentation

◆ execute()

◆ getMutableCoefficientsFunction()

◆ getMutableCoefficientsUserOject()

◆ initialSetup()

◆ scanProblemBaseForObject()

◆ validParams()

Member Data Documentation

◆ _multi_app_object_name

◆ _this_app_object_name

◆ getMultiAppObject

◆ getSubAppObject