https://mooseframework.inl.gov
GeneralUserObject.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
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 
10 #include "GeneralUserObject.h"
11 
14 {
17 
18  return params;
19 }
20 
22  : UserObject(parameters),
23  ScalarCoupleable(this),
25  TransientInterface(this)
26 {
27 }
28 
29 void
31 {
32  mooseError("GeneralUserObjects do not execute using threads, this function does nothing and "
33  "should not be used.");
34 }
35 
36 void
38 {
39  mooseError("GeneralUserObjects do not execute subdomainSetup method, this function does nothing "
40  "and should not be used.");
41 }
static InputParameters validParams()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
Interface for objects that needs transient capabilities.
virtual void threadJoin(const UserObject &) override
This method is not used and should not be used in a custom GeneralUserObject.
virtual void subdomainSetup() override
Gets called when the subdomain changes (i.e.
const std::set< SubdomainID > EMPTY_BLOCK_IDS
Definition: MooseTypes.h:683
An interface for accessing Materials.
const std::set< BoundaryID > EMPTY_BOUNDARY_IDS
Definition: MooseTypes.h:684
GeneralUserObject(const InputParameters &parameters)
Interface for objects that needs scalar coupling capabilities.
void mooseError(Args &&... args) const
Emits an error prefixed with object name and type.
MOOSE now contains C++17 code, so give a reasonable error message stating what the user can do to add...
Base class for user-specific data.
Definition: UserObject.h:40
static InputParameters validParams()
Definition: UserObject.C:18