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) 1991-2008 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 InNamespace
  26     Foam::bound
  27
  28 Description
  29     Bound the given scalar field if it has gone unbounded.  Used extensively
  30     in RAS and LES turbulence models.
  31
  32 SourceFiles
  33     bound.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef bound_H
  38 #define bound_H
  39
  40 #include "dimensionedScalar.H"
  41 #include "volFieldsFwd.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // * * * * * * * * * * * * * * * Global Functions  * * * * * * * * * * * * * //
  49
  50 //- Bound the given scalar field if it has gone unbounded.
  51 //  Used extensively in RAS and LES turbulence models.
  52 void bound(volScalarField& vsf, const dimensionedScalar& vsf0);
  53
  54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  55
  56 } // End namespace Foam
  57
  58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  59
  60 #endif
  61
  62 // ************************************************************************* //