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

Go to the source code of this file.

Classes

class  UserObject
 Base class for user-specific data. More...
 

Functions

template<>
InputParameters validParams< UserObject > ()
 

Function Documentation

Definition at line 23 of file UserObject.C.

Referenced by validParams< ElementUserObject >(), validParams< GeneralUserObject >(), validParams< InternalSideUserObject >(), validParams< NodalUserObject >(), validParams< Postprocessor >(), validParams< SideUserObject >(), and validParams< VectorPostprocessor >().

24 {
26 
27  // Add the SetupInterface parameter, 'execute_on', and set it to a default of 'timestep_end'
28  params += validParams<SetupInterface>();
29  params.set<MultiMooseEnum>("execute_on") = "timestep_end";
30 
31  params.addParam<bool>("use_displaced_mesh",
32  false,
33  "Whether or not this object should use the "
34  "displaced mesh for computation. Note that "
35  "in the case this is true but no "
36  "displacements are provided in the Mesh block "
37  "the undisplaced mesh will still be used.");
38  params.addParam<bool>("allow_duplicate_execution_on_initial",
39  false,
40  "In the case where this UserObject is depended upon by an initial "
41  "condition, allow it to be executed twice during the initial setup (once "
42  "before the IC and again after mesh adaptivity (if applicable).");
43 
44  params.declareControllable("enable");
45 
46  params.registerBase("UserObject");
47 
48  params.addParamNamesToGroup("use_displaced_mesh allow_duplicate_execution_on_initial",
49  "Advanced");
50  return params;
51 }
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< SetupInterface >()
InputParameters validParams< MooseObject >()
Definition: MooseObject.C:22
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...