src/meshTools/sets/topoSets/faceSet.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::faceSet
  27
  28 Description
  29     A list of face labels.
  30
  31 SourceFiles
  32     faceSet.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef faceSet_H
  37 #define faceSet_H
  38
  39 #include "topoSet.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class faceSet Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class faceSet
  51 :
  52     public topoSet
  53 {
  54 public:
  55
  56     //- Runtime type information
  57     TypeName("faceSet");
  58
  59
  60     // Constructors
  61
  62
  63         //- Construct from IOobject
  64         faceSet(const IOobject& obj);
  65
  66         //- Construct from objectRegistry and name
  67         faceSet
  68         (
  69             const polyMesh& mesh,
  70             const word& name,
  71             readOption r = MUST_READ,
  72             writeOption w = NO_WRITE
  73         );
  74
  75         //- Construct from additional size of labelHashSet
  76         faceSet
  77         (
  78             const polyMesh& mesh,
  79             const word& name,
  80             const label,
  81             writeOption w = NO_WRITE
  82         );
  83
  84         //- Construct from existing set
  85         faceSet
  86         (
  87             const polyMesh& mesh,
  88             const word& name,
  89             const topoSet&,
  90             writeOption w = NO_WRITE
  91         );
  92
  93         //- Construct from additional labelHashSet
  94         faceSet
  95         (
  96             const polyMesh& mesh,
  97             const word& name,
  98             const labelHashSet&,
  99             writeOption w = NO_WRITE
 100         );
 101
 102
 103     // Destructor
 104
 105         virtual ~faceSet();
 106
 107
 108     // Member functions
 109
 110         //- Sync faceSet across coupled patches.
 111         virtual void sync(const polyMesh& mesh);
 112
 113         //- Return max index+1.
 114         virtual label maxSize(const polyMesh& mesh) const;
 115
 116         //- Update any stored data for new labels
 117         virtual void updateMesh(const mapPolyMesh& morphMap);
 118
 119         //- Write maxLen items with label and coordinates.
 120         virtual void writeDebug
 121         (
 122             Ostream& os,
 123             const primitiveMesh&,
 124             const label maxLen
 125         ) const;
 126
 127 };
 128
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 } // End namespace Foam
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #endif
 137
 138 // ************************************************************************* //