www.mooseframework.org
Functions
Transfer.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< Transfer > ()
 

Function Documentation

Definition at line 31 of file Transfer.C.

Referenced by validParams< MultiAppTransfer >().

32 {
34  params.addParam<bool>("use_displaced_mesh",
35  false,
36  "Whether or not this object should use the "
37  "displaced mesh for computation. Note that "
38  "in the case this is true but no "
39  "displacements are provided in the Mesh block "
40  "the undisplaced mesh will still be used.");
41  // Add the SetupInterface parameter, 'execute_on', and set it to a default of 'timestep_begin'
42  params += validParams<SetupInterface>();
43  params.set<MultiMooseEnum>("execute_on") = "timestep_begin";
44 
45  params.registerBase("Transfer");
46 
47  params.addParamNamesToGroup("use_displaced_mesh", "Advanced");
48 
49  params.declareControllable("enable");
50  return params;
51 }
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...
InputParameters validParams< SetupInterface >()
InputParameters validParams< MooseObject >()
Definition: MooseObject.C:22
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...