www.mooseframework.org
DiscreteElementUserObject.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
11 
12 template <>
15 {
17 
18  // UOs of this type should not be executed by MOOSE, but only called directly by the user
19  params.set<ExecFlagEnum>("execute_on") = EXEC_CUSTOM;
20  params.suppressParameter<ExecFlagEnum>("execute_on");
21 
22  return params;
23 }
24 
26  : ElementUserObject(parameters)
27 {
28 }
29 
30 void
32 {
33 }
34 
35 void
37 {
38  mooseError("DiscreteElementUserObjects must be called explicitly from Materials");
39 }
40 
41 void
43 {
44  mooseError("DiscreteElementUserObjects must be called explicitly from Materials");
45 }
46 
47 void
49 {
50  mooseError("DiscreteElementUserObjects must be called explicitly from Materials");
51 }
InputParameters validParams< ElementUserObject >()
A MultiMooseEnum object to hold "execute_on" flags.
Definition: ExecFlagEnum.h:24
const ExecFlagType EXEC_CUSTOM
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 mooseError(Args &&... args) const
Definition: MooseObject.h:147
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.
virtual void finalize() override final
Finalize.
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:37