src/meshTools/sets/topoSets/cellSet.H

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