src/finiteVolume/cfdTools/general/bound/bound.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  26
  27 Description
  28     Bound the given scalar field if it has gone unbounded.
  29
  30     Used extensively in RAS and LES turbulence models, but also of use
  31     within solvers.
  32
  33 SourceFiles
  34     bound.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef bound_H
  39 #define bound_H
  40
  41 #include "dimensionedScalar.H"
  42 #include "volFieldsFwd.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // * * * * * * * * * * * * * * * Global Functions  * * * * * * * * * * * * * //
  50
  51 //- Bound the given scalar field if it has gone unbounded.
  52 //  Return the bounded field.
  53 //  Used extensively in RAS and LES turbulence models.
  54 volScalarField& bound(volScalarField&, const dimensionedScalar& lowerBound);
  55
  56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  57
  58 } // End namespace Foam
  59
  60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  61
  62 #endif
  63
  64 // ************************************************************************* //