https://mooseframework.inl.gov
src
functions
FunctionBase.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 "
FunctionBase.h
"
11
12
namespace
Moose
13
{
14
15
InputParameters
16
FunctionBase::validParams
()
17
{
18
InputParameters
params =
MooseObject::validParams
();
19
params +=
SetupInterface::validParams
();
20
21
// Functions should be executed on the fly
22
params.
suppressParameter
<
ExecFlagEnum
>(
"execute_on"
);
23
24
params.
registerBase
(
"Function"
);
25
26
return
params;
27
}
28
29
FunctionBase::FunctionBase
(
const
InputParameters
& parameters)
30
:
MooseObject
(parameters),
31
SetupInterface
(this),
32
TransientInterface
(this),
33
PostprocessorInterface
(this),
34
UserObjectInterface
(this),
35
Restartable
(this,
"Functions"
),
36
MeshChangedInterface
(parameters),
37
ScalarCoupleable
(this)
38
{
39
}
40
41
#ifdef MOOSE_KOKKOS_ENABLED
42
FunctionBase::FunctionBase
(
const
FunctionBase
&
object
,
const
Moose::Kokkos::FunctorCopy
& key)
43
:
MooseObject
(object, key),
44
SetupInterface
(object, key),
45
TransientInterface
(object, key),
46
PostprocessorInterface
(object, key),
47
UserObjectInterface
(object, key),
48
Restartable
(object, key),
49
MeshChangedInterface
(object, key),
50
ScalarCoupleable
(object, key)
51
{
52
}
53
#endif
54
55
FunctionBase::~FunctionBase
() {}
56
57
}
// namespace Moose
Moose::FunctionBase::FunctionBase
FunctionBase(const InputParameters ¶meters)
Definition:
FunctionBase.C:29
ExecFlagEnum
A MultiMooseEnum object to hold "execute_on" flags.
Definition:
ExecFlagEnum.h:21
Restartable
A class for creating restricted objects.
Definition:
Restartable.h:28
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:67
Moose::FunctionBase
Definition:
FunctionBase.h:24
InputParameters::suppressParameter
void suppressParameter(const std::string &name)
This method suppresses an inherited parameter so that it isn't required or valid in the derived class...
Definition:
InputParameters.h:2086
InputParameters::registerBase
void registerBase(const std::string &value)
This method must be called from every base "Moose System" to create linkage with the Action System...
Definition:
InputParameters.C:492
TransientInterface
Interface for objects that needs transient capabilities.
Definition:
TransientInterface.h:31
MeshChangedInterface
Interface for notifications that the mesh has changed.
Definition:
MeshChangedInterface.h:21
MooseObject
Every object that can be built by the factory should be derived from this class.
Definition:
MooseObject.h:28
Moose::Kokkos::FunctorCopy
Definition:
MooseTypes.h:1322
UserObjectInterface
Interface for objects that need to use UserObjects.
Definition:
UserObjectInterface.h:24
SetupInterface
Definition:
SetupInterface.h:23
SetupInterface::validParams
static InputParameters validParams()
Definition:
SetupInterface.C:15
FunctionBase.h
Moose::FunctionBase::~FunctionBase
virtual ~FunctionBase()
Definition:
FunctionBase.C:55
ScalarCoupleable
Interface for objects that needs scalar coupling capabilities.
Definition:
ScalarCoupleable.h:32
Moose::FunctionBase::validParams
static InputParameters validParams()
Definition:
FunctionBase.C:16
Moose
MOOSE now contains C++17 code, so give a reasonable error message stating what the user can do to add...
Definition:
SetAdaptivityOptionsAction.h:14
MooseObject::validParams
static InputParameters validParams()
Definition:
MooseObject.C:25
PostprocessorInterface
Interface class for classes which interact with Postprocessors.
Definition:
PostprocessorInterface.h:34
Generated on Sun Jun 21 2026 21:26:58 for https://mooseframework.inl.gov by
1.8.14