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

Go to the source code of this file.

Classes

class  MultiAppMeshFunctionTransfer
 Transfers a vector of variables. More...
 

Functions

template<>
InputParameters validParams< MultiAppMeshFunctionTransfer > ()
 

Function Documentation

Definition at line 32 of file MultiAppMeshFunctionTransfer.C.

33 {
35  params.addRequiredParam<std::vector<AuxVariableName>>(
36  "variable", "The auxiliary variable to store the transferred values in.");
37  params.addRequiredParam<std::vector<VariableName>>("source_variable",
38  "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  params.addParam<bool>(
46  "error_on_miss",
47  false,
48  "Whether or not to error in the case that a target point is not found in the source domain.");
49  return params;
50 }
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...