www.mooseframework.org
Functions
SamplerTransfer.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< SamplerTransfer > ()
 

Function Documentation

template<>
InputParameters validParams< SamplerTransfer > ( )

Definition at line 15 of file SamplerTransfer.C.

16 {
17  InputParameters params = validParams<MultiAppTransfer>();
18  params.addClassDescription("Copies Sampler data to a SamplerReceiver object.");
19  params.set<MooseEnum>("direction") = "to_multiapp";
20  params.suppressParameter<MooseEnum>("direction");
21  params.addParam<std::vector<std::string>>(
22  "parameters",
23  "A list of parameters (on the sub application) to control "
24  "with the Sampler data. The order of the parameters listed "
25  "here should match the order of the items in the Sampler.");
26  params.addRequiredParam<std::string>("to_control",
27  "The name of the 'SamplerReceiver' on the sub application "
28  "to which the Sampler data will be transfered.");
29  return params;
30 }