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

Go to the source code of this file.

Classes

class  MultiAppNearestNodeTransfer
 Copy the value to the target domain from the nearest node in the source domain. More...
 

Functions

template<>
InputParameters validParams< MultiAppNearestNodeTransfer > ()
 

Function Documentation

Definition at line 31 of file MultiAppNearestNodeTransfer.C.

32 {
34 
35  params.addRequiredParam<AuxVariableName>(
36  "variable", "The auxiliary variable to store the transferred values in.");
37  params.addRequiredParam<VariableName>("source_variable", "The variable to transfer from.");
38  params.addParam<BoundaryName>(
39  "source_boundary",
40  "The boundary we are transferring from (if not specified, whole domain is used).");
41  params.addParam<BoundaryName>(
42  "target_boundary",
43  "The boundary we are transferring to (if not specified, whole domain is used).");
44  params.addParam<bool>("displaced_source_mesh",
45  false,
46  "Whether or not to use the displaced mesh for the source mesh.");
47  params.addParam<bool>("displaced_target_mesh",
48  false,
49  "Whether or not to use the displaced mesh for the target mesh.");
50  params.addParam<bool>("fixed_meshes",
51  false,
52  "Set to true when the meshes are not changing (ie, "
53  "no movement or adaptivity). This will cache "
54  "nearest node neighbors to greatly speed up the "
55  "transfer.");
56 
57  return params;
58 }
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< MultiAppTransfer >()
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...