FreeFOAM The Cross-Platform CFD Toolkit
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 | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 InNamespace
25  Foam::bound
26 
27 Description
28  Bound the given scalar field if it has gone unbounded. Used extensively
29  in RAS and LES turbulence models.
30 
31 SourceFiles
32  bound.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef bound_H
37 #define bound_H
38 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 // * * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * //
48 
49 //- Bound the given scalar field if it has gone unbounded.
50 // Used extensively in RAS and LES turbulence models.
51 void bound(volScalarField& vsf, const dimensionedScalar& vsf0);
52 
53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
54 
55 } // End namespace Foam
56 
57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
58 
59 #endif
60 
61 // ************************ vim: set sw=4 sts=4 et: ************************ //