www.mooseframework.org
Functions
InterfaceKernel.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< InterfaceKernel > ()
 

Function Documentation

Definition at line 26 of file InterfaceKernel.C.

27 {
32  params.addRequiredParam<NonlinearVariableName>(
33  "variable", "The name of the variable that this boundary condition applies to");
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 in "
38  "the case this is true but no displacements "
39  "are provided in the Mesh block the "
40  "undisplaced mesh will still be used.");
41  params.addParamNamesToGroup("use_displaced_mesh", "Advanced");
42 
43  params.declareControllable("enable");
44  params.addRequiredCoupledVar("neighbor_var", "The variable on the other side of the interface.");
45  params.set<std::string>("_moose_base") = "InterfaceKernel";
46  params.addParam<std::vector<AuxVariableName>>(
47  "save_in",
48  "The name of auxiliary variables to save this Kernel's residual contributions to. "
49  " Everything about that variable must match everything about this variable (the "
50  "type, what blocks it's on, etc.)");
51  params.addParam<std::vector<AuxVariableName>>(
52  "diag_save_in",
53  "The name of auxiliary variables to save this Kernel's diagonal Jacobian "
54  "contributions to. Everything about that variable must match everything "
55  "about this variable (the type, what blocks it's on, etc.)");
56 
57  MultiMooseEnum save_in_var_side("m s");
58  params.addParam<MultiMooseEnum>(
59  "save_in_var_side",
60  save_in_var_side,
61  "This parameter must exist if save_in variables are specified and must have the same length "
62  "as save_in. This vector specifies whether the corresponding aux_var should save-in "
63  "residual contributions from the master ('m') or slave side ('s').");
64  params.addParam<MultiMooseEnum>(
65  "diag_save_in_var_side",
66  save_in_var_side,
67  "This parameter must exist if diag_save_in variables are specified and must have the same "
68  "length as diag_save_in. This vector specifies whether the corresponding aux_var should "
69  "save-in jacobian contributions from the master ('m') or slave side ('s').");
70 
71  return params;
72 }
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< MeshChangedInterface >()
InputParameters validParams< MooseObject >()
Definition: MooseObject.C:22
InputParameters validParams< BoundaryRestrictable >()
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
InputParameters validParams< TransientInterface >()