src/meshTools/sets/topoSets/cellSet.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::cellSet
  27
  28 Description
  29     A collection of cell labels.
  30
  31 SourceFiles
  32     cellSet.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef cellSet_H
  37 #define cellSet_H
  38
  39 #include "topoSet.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class cellSet Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class cellSet
  51 :
  52     public topoSet
  53 {
  54     // Private Member Functions
  55
  56         //- Disallow default bitwise copy construct
  57         cellSet(const cellSet&);
  58
  59 public:
  60
  61     //- Runtime type information
  62     TypeName("cellSet");
  63
  64
  65     // Constructors
  66
  67
  68         //- Construct from IOobject. No checking.
  69         cellSet(const IOobject& obj);
  70
  71         //- Construct from polyMesh and name. Checks for valid cell ids.
  72         cellSet
  73         (
  74             const polyMesh& mesh,
  75             const word& name,
  76             readOption r = MUST_READ,
  77             writeOption w = NO_WRITE
  78         );
  79
  80         //- Construct empty from size of labelHashSet
  81         cellSet
  82         (
  83             const polyMesh& mesh,
  84             const word& name,
  85             const label sizes,
  86             writeOption w = NO_WRITE
  87         );
  88
  89         //- Construct from existing set
  90         cellSet
  91         (
  92             const polyMesh& mesh,
  93             const word& name,
  94             const topoSet&,
  95             writeOption w = NO_WRITE
  96         );
  97
  98         //- Construct from labelHashSet
  99         cellSet
 100         (
 101             const polyMesh& mesh,
 102             const word& name,
 103             const labelHashSet&,
 104             writeOption w = NO_WRITE
 105         );
 106
 107
 108         // Used for tetMesh cellSet only.
 109
 110             //- Construct from objectRegistry and name.
 111             cellSet
 112             (
 113                 const Time&,
 114                 const word& name,
 115                 readOption r = MUST_READ,
 116                 writeOption w = NO_WRITE
 117             );
 118
 119             //- Construct empty from objectRegistry.
 120             cellSet
 121             (
 122                 const Time&,
 123                 const word& name,
 124                 const label size,
 125                 writeOption w = NO_WRITE
 126             );
 127
 128             //- Construct from labelHashSet
 129             cellSet
 130             (
 131                 const Time&,
 132                 const word& name,
 133                 const labelHashSet&,
 134                 writeOption w = NO_WRITE
 135             );
 136
 137
 138     // Destructor
 139
 140         virtual ~cellSet();
 141
 142
 143     // Member functions
 144
 145         //- Sync cellSet across coupled patches.
 146         virtual void sync(const polyMesh& mesh)
 147         {}
 148
 149         //- Return max index+1.
 150         virtual label maxSize(const polyMesh& mesh) const;
 151
 152         //- Update any stored data for new labels
 153         virtual void updateMesh(const mapPolyMesh& morphMap);
 154
 155         //- Write maxLen items with label and coordinates.
 156         virtual void writeDebug
 157         (
 158             Ostream& os,
 159             const primitiveMesh&,
 160             const label maxLen
 161         ) const;
 162
 163 };
 164
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 } // End namespace Foam
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 #endif
 173
 174 // ************************************************************************* //