www.mooseframework.org
DiscreteElementUserObject.C
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
16 
17 template <>
20 {
22 
23  // UOs of this type should not be executed by MOOSE, but only called directly by the user
24  params.set<MultiMooseEnum>("execute_on") = "custom";
25  params.suppressParameter<MultiMooseEnum>("execute_on");
26 
27  return params;
28 }
29 
31  : ElementUserObject(parameters)
32 {
33 }
34 
35 void
37 {
38 }
39 
40 void
42 {
43  mooseError("DiscreteElementUserObjects must be called explicitly from Materials");
44 }
45 
46 void
48 {
49  mooseError("DiscreteElementUserObjects must be called explicitly from Materials");
50 }
51 
52 void
54 {
55  mooseError("DiscreteElementUserObjects must be called explicitly from Materials");
56 }
InputParameters validParams< ElementUserObject >()
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
virtual void threadJoin(const UserObject &) override final
Must override.
DiscreteElementUserObject(const InputParameters &parameters)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void suppressParameter(const std::string &name)
This method suppresses an inherited parameter so that it isn&#39;t required or valid in the derived class...
InputParameters validParams< DiscreteElementUserObject >()
virtual void execute() override final
Block all methods that are not used in explicitly called UOs.
void mooseError(Args &&...args) const
Definition: MooseObject.h:80
virtual void finalize() override final
Finalize.
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Base class for user-specific data.
Definition: UserObject.h:42