OpenFOAM: API Guide
v2112
The open source CFD toolbox
bound.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) 2011 OpenFOAM Foundation
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
InNamespace
27
Foam
28
29
Description
30
Bound the given scalar field if it has gone unbounded.
31
32
Used extensively in RAS and LES turbulence models, but also of use
33
within solvers.
34
35
SourceFiles
36
bound.C
37
38
\*---------------------------------------------------------------------------*/
39
40
#ifndef bound_H
41
#define bound_H
42
43
#include "
dimensionedScalar.H
"
44
#include "
volFieldsFwd.H
"
45
46
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47
48
namespace
Foam
49
{
50
51
// * * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * //
52
53
//- Bound the given scalar field if it has gone unbounded.
54
// Return the bounded field.
55
// Used extensively in RAS and LES turbulence models.
56
volScalarField
&
bound
(
volScalarField
&,
const
dimensionedScalar
& lowerBound);
57
58
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
59
60
}
// End namespace Foam
61
62
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
63
64
#endif
65
66
// ************************************************************************* //
dimensionedScalar.H
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:34
Foam::dimensionedScalar
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
Definition:
dimensionedScalarFwd.H:44
Foam::bound
volScalarField & bound(volScalarField &, const dimensionedScalar &lowerBound)
Bound the given scalar field if it has gone unbounded.
Definition:
bound.C:35
Foam::volScalarField
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition:
volFieldsFwd.H:82
volFieldsFwd.H
src
finiteVolume
cfdTools
general
bound
bound.H
Generated by
1.9.5
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.