initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / finiteVolume / cfdTools / general / adjustPhi / adjustPhi.H
blobc0a8c28762890eb99690e906a293b6fc326ae502
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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
25 InNamespace
26     Foam
28 Description
29     For cases which do no have a pressure boundary adjust the balance of
30     fluxes to obey continuity.  Return true if the domain is closed.
32 SourceFiles
33     adjustPhi.C
35 \*---------------------------------------------------------------------------*/
37 #ifndef adjustPhi_H
38 #define adjustPhi_H
40 #include "volFieldsFwd.H"
41 #include "surfaceFieldsFwd.H"
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
48 //- Adjust the balance of fluxes to obey continuity.
49 //  For cases which do not have a pressure boundary.
50 //  Return true if the domain is closed.
51 bool adjustPhi
53     surfaceScalarField& phi,
54     const volVectorField& U,
55     volScalarField& p
58 } // End namespace Foam
60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
62 #endif
64 // ************************************************************************* //