OpenFOAM: API Guide
v2112
The open source CFD toolbox
stepFunction.C
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | www.openfoam.com
6
\\/ M anipulation |
7
-------------------------------------------------------------------------------
8
Copyright (C) 2020-2021 OpenCFD Ltd.
9
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM.
12
13
OpenFOAM is free software: you can redistribute it and/or modify it
14
under the terms of the GNU General Public License as published by
15
the Free Software Foundation, either version 3 of the License, or
16
(at your option) any later version.
17
18
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21
for more details.
22
23
You should have received a copy of the GNU General Public License
24
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26
\*---------------------------------------------------------------------------*/
27
28
#include "
stepFunction.H
"
29
30
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31
32
namespace
Foam
33
{
34
namespace
Function1Types
35
{
36
makeScalarFunction1
(stepFunction);
37
}
38
}
39
40
41
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
42
43
Foam::Function1Types::stepFunction::stepFunction
44
(
45
const
word
& entryName,
46
const
dictionary
&
dict
,
47
const
objectRegistry
* obrPtr
48
)
49
:
50
ramp
(entryName,
dict
, obrPtr)
51
{}
52
53
54
// ************************************************************************* //
stepFunction.H
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:65
Foam::Function1Types::makeScalarFunction1
makeScalarFunction1(halfCosineRamp)
Foam::Function1Types::ramp
Ramp function base class for the set of scalar functions starting from 0 and increasing monotonically...
Definition:
ramp.H:99
Foam::objectRegistry
Registry of regIOobjects.
Definition:
objectRegistry.H:60
dict
dictionary dict
Definition:
searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition:
dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::Function1Types::stepFunction::stepFunction
stepFunction(const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
Construct from entry name, dictionary and optional registry.
Definition:
stepFunction.C:44
src
OpenFOAM
primitives
functions
Function1
step
stepFunction.C
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.