initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / finiteVolume / fvMesh / fvPatches / constraint / empty / emptyFvPatch.H
blobf48984831e0b6f386ecee3009c069b29259cc8ff
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 Class
26     Foam::emptyFvPatch
28 Description
29     A patch which will not exist in the fvMesh. Typical example is a front and
30     back plane of a 2-D geometry
32 SourceFiles
33     emptyFvPatch.C
35 \*---------------------------------------------------------------------------*/
37 #ifndef emptyFvPatch_H
38 #define emptyFvPatch_H
40 #include "fvPatch.H"
41 #include "emptyPolyPatch.H"
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
48 /*---------------------------------------------------------------------------*\
49                            Class emptyFvPatch Declaration
50 \*---------------------------------------------------------------------------*/
52 class emptyFvPatch
54     public fvPatch
56     // Private data
58         //- face-cell addressing
59         const labelList::subList faceCells_;
62 public:
64     //- Runtime type information
65     TypeName(emptyPolyPatch::typeName_());
68     // Constructors
70         //- Construct from polyPatch
71         emptyFvPatch(const polyPatch& patch, const fvBoundaryMesh& bm);
74     // Member Functions
76         // Access
78             virtual label size() const
79             {
80                 return 0;
81             }
83             //- Return faceCells
84             virtual const unallocLabelList& faceCells() const;
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 } // End namespace Foam
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 #endif
96 // ************************************************************************* //