initial commit for version 1.5.x patch release
[OpenFOAM-1.5.x.git] / src / OpenFOAM / meshes / meshShapes / cellMatcher / tetMatcher.H
blob223956fc0fdb01a7db4460cd73af434dae76e224
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.
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::tetMatcher
28 Description
29     A cellMatcher for tet cells
31 See Also
32     cellMatcher
34 SourceFiles
35     tetMatcher.C
37 \*---------------------------------------------------------------------------*/
39 #ifndef tetMatcher_H
40 #define tetMatcher_H
42 #include "cellMatcher.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 namespace Foam
49 /*---------------------------------------------------------------------------*\
50                            Class tetMatcher Declaration
51 \*---------------------------------------------------------------------------*/
53 class tetMatcher
55     public cellMatcher
57     // Static data members
59         //- constants for this shape
60         static const label vertPerCell;
61         static const label facePerCell;
62         static const label maxVertPerFace;
65     // Private Member Functions
67         //- Disallow default bitwise copy construct
68         tetMatcher(const tetMatcher&);
70         //- Disallow default bitwise assignment
71         void operator=(const tetMatcher&);
74 public:
76     // Constructors
78         //- Construct null
79         tetMatcher();
81     // Destructor
83         ~tetMatcher();
86     // Member Functions
88         virtual label nVertPerCell() const
89         {
90             return vertPerCell;
91         }
93         virtual label nFacePerCell() const
94         {
95             return facePerCell;
96         }
98         virtual label nMaxVertPerFace() const
99         {
100             return maxVertPerFace;
101         }
103         virtual label faceHashValue() const;
105         virtual bool faceSizeMatch(const faceList&, const labelList&) const;
107         virtual bool matchShape
108         (
109             const bool checkOnly,
110             const faceList& faces,
111             const labelList& faceOwner,
112             const label cellI,
113             const labelList& myFaces
114         );
116         virtual bool isA(const primitiveMesh& mesh, const label cellI);
118         virtual bool isA(const faceList&);
120         virtual bool matches
121         (
122             const primitiveMesh& mesh,
123             const label cellI,
124             cellShape& shape
125         );
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 } // End namespace Foam
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 #endif
137 // ************************************************************************* //