www.mooseframework.org
Functions
MultiAppTransfer.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< MultiAppTransfer > ()
 
const InputParametersremoveSpecialOption (const InputParameters &parameters)
 

Function Documentation

const InputParameters& removeSpecialOption ( const InputParameters parameters)

Definition at line 61 of file MultiAppTransfer.C.

62 {
63  InputParameters * params = const_cast<InputParameters *>(&parameters);
64  params->set<MultiMooseEnum>("execute_on").erase("SAME_AS_MULTIAPP");
65  return *params;
66 }
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...

Definition at line 29 of file MultiAppTransfer.C.

Referenced by validParams< MultiAppCopyTransfer >(), validParams< MultiAppDTKInterpolationTransfer >(), validParams< MultiAppDTKUserObjectTransfer >(), validParams< MultiAppInterpolationTransfer >(), validParams< MultiAppMeshFunctionTransfer >(), validParams< MultiAppNearestNodeTransfer >(), validParams< MultiAppPostprocessorInterpolationTransfer >(), validParams< MultiAppPostprocessorToAuxScalarTransfer >(), validParams< MultiAppPostprocessorTransfer >(), validParams< MultiAppProjectionTransfer >(), validParams< MultiAppScalarToAuxScalarTransfer >(), validParams< MultiAppUserObjectTransfer >(), validParams< MultiAppVariableValueSamplePostprocessorTransfer >(), and validParams< MultiAppVariableValueSampleTransfer >().

30 {
32  params.addRequiredParam<MultiAppName>("multi_app", "The name of the MultiApp to use.");
33 
34  params.addRequiredParam<MooseEnum>("direction",
36  "Whether this Transfer will be 'to' or 'from' a MultiApp.");
37 
38  // MultiAppTransfers by default will execute with their associated MultiApp. These flags will be
39  // added by FEProblemBase when the transfer is added.
40  MultiMooseEnum multi_transfer_execute_on(params.get<MultiMooseEnum>("execute_on").getRawNames() +
41  " same_as_multiapp",
42  "same_as_multiapp");
43  params.set<MultiMooseEnum>("execute_on") = multi_transfer_execute_on;
44 
45  params.addParam<bool>(
46  "check_multiapp_execute_on",
47  true,
48  "When false the check between the multiapp and transfer execute on flags is not preformed.");
49  params.addParam<bool>("displaced_source_mesh",
50  false,
51  "Whether or not to use the displaced mesh for the source mesh.");
52  params.addParam<bool>("displaced_target_mesh",
53  false,
54  "Whether or not to use the displaced mesh for the target mesh.");
55 
56  return params;
57 }
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
InputParameters validParams< Transfer >()
Definition: Transfer.C:31
static MooseEnum directions()
Used to construct InputParameters.
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:37
std::string getRawNames() const
Method for returning the raw name strings for this instance.
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...