Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / finiteVolume / fvMesh / extendedStencil / cellToFace / MeshObjects / upwindCPCCellToFaceStencilObject.H
blobf5bf5c05bd1fd6372c42af62b6ca072275d24644
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2008-2010 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
13     the Free Software Foundation, either version 3 of the License, or
14     (at your 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, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::upwindCPCCellToFaceStencilObject
27 Description
29 SourceFiles
31 \*---------------------------------------------------------------------------*/
33 #ifndef upwindCPCCellToFaceStencilObject_H
34 #define upwindCPCCellToFaceStencilObject_H
36 #include "extendedUpwindCellToFaceStencil.H"
37 #include "CPCCellToFaceStencil.H"
38 #include "MeshObject.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46               Class upwindCPCCellToFaceStencilObject Declaration
47 \*---------------------------------------------------------------------------*/
49 class upwindCPCCellToFaceStencilObject
51     public MeshObject<fvMesh, upwindCPCCellToFaceStencilObject>,
52     public extendedUpwindCellToFaceStencil
55 public:
57     TypeName("upwindCPCCellToFaceStencil");
59     // Constructors
61         //- Construct from uncompacted face stencil
62         explicit upwindCPCCellToFaceStencilObject
63         (
64             const fvMesh& mesh,
65             const bool pureUpwind,
66             const scalar minOpposedness
67         )
68         :
69             MeshObject<fvMesh, upwindCPCCellToFaceStencilObject>(mesh),
70             extendedUpwindCellToFaceStencil
71             (
72                 CPCCellToFaceStencil(mesh),
73                 pureUpwind,
74                 minOpposedness
75             )
76         {
77             if (extendedCellToFaceStencil::debug)
78             {
79                 Info<< "Generated off-centred stencil " << type()
80                     << nl << endl;
81                 writeStencilStats(Info, ownStencil(), ownMap());
82             }
83         }
86     //- Destructor
87     virtual ~upwindCPCCellToFaceStencilObject()
88     {}
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 } // End namespace Foam
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 #endif
100 // ************************************************************************* //