src/OpenFOAM/meshes/meshShapes/cellMatcher/pyrMatcher.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::pyrMatcher
  26
  27 Description
  28     A cellMatcher for pyr cells
  29
  30 See Also
  31     cellMatcher
  32
  33 SourceFiles
  34     pyrMatcher.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef pyrMatcher_H
  39 #define pyrMatcher_H
  40
  41 #include "cellMatcher.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class pyrMatcher Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class pyrMatcher
  53 :
  54     public cellMatcher
  55 {
  56     // Static data members
  57
  58         //- constants for this shape
  59         static const label vertPerCell;
  60         static const label facePerCell;
  61         static const label maxVertPerFace;
  62
  63
  64     // Private Member Functions
  65
  66         //- Disallow default bitwise copy construct
  67         pyrMatcher(const pyrMatcher&);
  68
  69         //- Disallow default bitwise assignment
  70         void operator=(const pyrMatcher&);
  71
  72
  73 public:
  74
  75     // Constructors
  76
  77         //- Construct null
  78         pyrMatcher();
  79
  80     //- Destructor
  81     ~pyrMatcher();
  82
  83
  84     // Member Functions
  85
  86         virtual label nVertPerCell() const
  87         {
  88             return vertPerCell;
  89         }
  90
  91         virtual label nFacePerCell() const
  92         {
  93             return facePerCell;
  94         }
  95
  96         virtual label nMaxVertPerFace() const
  97         {
  98             return maxVertPerFace;
  99         }
 100
 101         virtual label faceHashValue() const;
 102
 103         virtual bool faceSizeMatch(const faceList&, const labelList&) const;
 104
 105         virtual bool matchShape
 106         (
 107             const bool checkOnly,
 108             const faceList& faces,
 109             const labelList& faceOwner,
 110             const label cellI,
 111             const labelList& myFaces
 112         );
 113
 114         virtual bool isA(const primitiveMesh& mesh, const label cellI);
 115
 116         virtual bool isA(const faceList&);
 117
 118         virtual bool matches
 119         (
 120             const primitiveMesh& mesh,
 121             const label cellI,
 122             cellShape& shape
 123         );
 124 };
 125
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 } // End namespace Foam
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 #endif
 134
 135 // ************************************************************************* //