www.mooseframework.org
Functions
MultiAppInterpolationTransfer.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< MultiAppInterpolationTransfer > ()
 

Function Documentation

Definition at line 31 of file MultiAppInterpolationTransfer.C.

32 {
34  params.addClassDescription(
35  "Transfers the value to the target domain from the nearest node in the source domain.");
36  params.addRequiredParam<AuxVariableName>(
37  "variable", "The auxiliary variable to store the transferred values in.");
38  params.addRequiredParam<VariableName>("source_variable", "The variable to transfer from.");
39  params.addParam<bool>("displaced_source_mesh",
40  false,
41  "Whether or not to use the displaced mesh for the source mesh.");
42  params.addParam<bool>("displaced_target_mesh",
43  false,
44  "Whether or not to use the displaced mesh for the target mesh.");
45 
46  params.addParam<unsigned int>(
47  "num_points", 3, "The number of nearest points to use for interpolation.");
48  params.addParam<Real>(
49  "power", 2, "The polynomial power to use for calculation of the decay in the interpolation.");
50 
51  MooseEnum interp_type("inverse_distance radial_basis", "inverse_distance");
52  params.addParam<MooseEnum>("interp_type", interp_type, "The algorithm to use for interpolation.");
53 
54  params.addParam<Real>("radius",
55  -1,
56  "Radius to use for radial_basis interpolation. If negative "
57  "then the radius is taken as the max distance between "
58  "points.");
59 
60  return params;
61 }
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...
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:37
InputParameters validParams< MultiAppTransfer >()
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
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...