OpenFOAM: API Guide
v2112
The open source CFD toolbox
uniform.H
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) 2016-2018 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
Class
27
Foam::windowModels::uniform
28
29
Description
30
A window that applies uniform scaling.
31
32
SourceFiles
33
uniform.C
34
35
\*---------------------------------------------------------------------------*/
36
37
#ifndef uniform_H
38
#define uniform_H
39
40
#include "
autoPtr.H
"
41
#include "
runTimeSelectionTables.H
"
42
#include "
windowModel.H
"
43
44
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46
namespace
Foam
47
{
48
namespace
windowModels
49
{
50
51
/*---------------------------------------------------------------------------*\
52
Class uniform Declaration
53
\*---------------------------------------------------------------------------*/
54
55
class
uniform
56
:
57
public
windowModel
58
{
59
60
protected
:
61
62
// Protected data
63
64
//- Uniform value
65
scalar
value_
;
66
67
68
public
:
69
70
//- Runtime type information
71
TypeName
(
"uniform"
);
72
73
74
//- Construct from dictionary
75
uniform
(
const
dictionary
&
dict
,
const
label
nSamples
);
76
77
//- Destructor
78
virtual
~uniform
() =
default
;
79
};
80
81
82
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83
84
}
// End namespace windowModels
85
}
// End namespace Foam
86
87
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88
89
#endif
90
91
// ************************************************************************* //
Foam::windowModels::uniform::uniform
uniform(const dictionary &dict, const label nSamples)
Construct from dictionary.
Definition:
uniform.C:47
Foam::windowModels::uniform
A window that applies uniform scaling.
Definition:
uniform.H:54
windowModel.H
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
runTimeSelectionTables.H
Macros to ease declaration of run-time selection tables.
Foam::windowModels::uniform::~uniform
virtual ~uniform()=default
Destructor.
Foam::windowModel::nSamples
label nSamples() const
Return the number of samples in the window.
Definition:
windowModel.C:56
Foam::windowModels::uniform::value_
scalar value_
Uniform value.
Definition:
uniform.H:64
Foam::windowModels::uniform::TypeName
TypeName("uniform")
Runtime type information.
Foam::windowModel
Base class for windowing models.
Definition:
windowModel.H:52
autoPtr.H
src
randomProcesses
windowModels
uniform
uniform.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.