www.mooseframework.org
Classes | Functions
MultiAppFXTransfer.h File Reference

Go to the source code of this file.

Classes

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

Functions

template<>
InputParameters validParams< MultiAppFXTransfer > ()
 

Function Documentation

◆ validParams< MultiAppFXTransfer >()

template<>
InputParameters validParams< MultiAppFXTransfer > ( )

Definition at line 21 of file MultiAppFXTransfer.C.

22 {
23  InputParameters params = validParams<MultiAppTransfer>();
24 
25  params.addClassDescription("Transfers coefficient arrays between objects that are derived from "
26  "MutableCoefficientsInterface; currently includes the following "
27  "types: FunctionSeries, FXBoundaryUserObject, and FXVolumeUserObject");
28 
29  params.addRequiredParam<std::string>(
30  "this_app_object_name",
31  "Name of the MutableCoefficientsInterface-derived object in this app (LocalApp).");
32 
33  params.addRequiredParam<std::string>(
34  "multi_app_object_name",
35  "Name of the MutableCoefficientsInterface-derived object in the MultiApp.");
36 
37  return params;
38 }