src/meshTools/sets/topoSets/topoSet.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::topoSet
  27
  28 Description
  29     General set of labels of mesh quantity (points, cells, faces).
  30
  31     Contains various 'notImplemented' functions, but I do not want to make
  32     this class abstract since it is quite handy to work on topoSets.
  33
  34 SourceFiles
  35     topoSet.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef topoSet_H
  40 #define topoSet_H
  41
  42 #include "HashSet.H"
  43 #include "regIOobject.H"
  44 #include "labelList.H"
  45 #include "typeInfo.H"
  46 #include "autoPtr.H"
  47 #include "pointField.H"
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 namespace Foam
  52 {
  53
  54
  55 class mapPolyMesh;
  56 class polyMesh;
  57 class primitiveMesh;
  58
  59 /*---------------------------------------------------------------------------*\
  60                            Class topoSet Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 class topoSet
  64 :
  65     public regIOobject,
  66     public labelHashSet
  67 {
  68
  69 protected:
  70
  71     // Protected Member Functions
  72
  73         //- Update map from map. Used to update cell/face labels
  74         //  after morphing
  75         void updateLabels(const labelList& map);
  76
  77         //- Check validity of contents.
  78         void check(const label maxLabel);
  79
  80         //- Write part of contents nicely formatted. Prints labels only.
  81         void writeDebug
  82         (
  83             Ostream& os,
  84             const label maxElem,
  85             topoSet::const_iterator& iter,
  86             label& elemI
  87         ) const;
  88
  89         //- Write part of contents nicely formatted. Prints label
  90         //  and corresponding coordinate.
  91         void writeDebug
  92         (
  93             Ostream& os,
  94             const pointField& coords,
  95             const label maxElem,
  96             topoSet::const_iterator& iter,
  97             label& elemI
  98         ) const;
  99
 100         //- Write labels and coordinates columnwise to os. Truncate to maxLen.
 101         void writeDebug
 102         (
 103             Ostream& os,
 104             const pointField& coords,
 105             const label maxLen
 106         ) const;
 107
 108
 109         //- Disallow default bitwise copy construct
 110         topoSet(const topoSet&);
 111
 112 public:
 113
 114     //- Runtime type information
 115     TypeName("topoSet");
 116
 117
 118     // Static
 119
 120         //- Name of file set will use.
 121         static fileName localPath(const polyMesh& mesh, const word& name);
 122
 123
 124     // Declare run-time constructor selection table
 125
 126         // For the direct constructor
 127         declareRunTimeSelectionTable
 128         (
 129             autoPtr,
 130             topoSet,
 131             word,
 132             (
 133                 const polyMesh& mesh,
 134                 const word& name,
 135                 readOption r,
 136                 writeOption w
 137             ),
 138             (mesh, name, r, w)
 139         );
 140
 141         // For the constructor from size
 142         declareRunTimeSelectionTable
 143         (
 144             autoPtr,
 145             topoSet,
 146             size,
 147             (
 148                 const polyMesh& mesh,
 149                 const word& name,
 150                 const label size,
 151                 writeOption w
 152             ),
 153             (mesh, name, size, w)
 154         );
 155
 156         // For the constructor as copy
 157         declareRunTimeSelectionTable
 158         (
 159             autoPtr,
 160             topoSet,
 161             set,
 162             (
 163                 const polyMesh& mesh,
 164                 const word& name,
 165                 const topoSet& set,
 166                 writeOption w
 167             ),
 168             (mesh, name, set, w)
 169         );
 170
 171
 172     // Constructors
 173
 174
 175         //- Construct from IOobject as explicitly passed type.
 176         //  Can't use typeName info here since subclasses not yet instantiated
 177         topoSet(const IOobject&, const word& wantedType);
 178
 179         //- Construct from polyMesh and name
 180         topoSet
 181         (
 182             const polyMesh& mesh,
 183             const word& wantedType,
 184             const word& name,
 185             readOption r=MUST_READ,
 186             writeOption w=NO_WRITE
 187         );
 188
 189         //- Construct empty from additional size of labelHashSet
 190         topoSet
 191         (
 192             const polyMesh& mesh,
 193             const word& name,
 194             const label,
 195             writeOption w=NO_WRITE
 196         );
 197
 198         //- Construct empty from additional labelHashSet
 199         topoSet
 200         (
 201             const polyMesh& mesh,
 202             const word& name,
 203             const labelHashSet&,
 204             writeOption w=NO_WRITE
 205         );
 206
 207         //- Construct empty from IOobject and size
 208         topoSet(const IOobject&, const label size);
 209
 210         //- Construct from IOobject and labelHashSet
 211         topoSet(const IOobject&, const labelHashSet&);
 212
 213
 214
 215         //- Clone
 216         autoPtr<topoSet> clone() const
 217         {
 218             notImplemented("autoPtr<topoSet> clone() const");
 219             return autoPtr<topoSet>(NULL);
 220         }
 221
 222
 223     // Selectors
 224
 225         //- Return a pointer to a toposet read from file
 226         static autoPtr<topoSet> New
 227         (
 228             const word& setType,
 229             const polyMesh& mesh,
 230             const word& name,
 231             readOption r=MUST_READ,
 232             writeOption w=NO_WRITE
 233         );
 234
 235         //- Return a pointer to a new toposet of given size
 236         static autoPtr<topoSet> New
 237         (
 238             const word& setType,
 239             const polyMesh& mesh,
 240             const word& name,
 241             const label size,
 242             writeOption w=NO_WRITE
 243         );
 244
 245         //- Return a pointer to a new toposet as copy of another toposet
 246         static autoPtr<topoSet> New
 247         (
 248             const word& setType,
 249             const polyMesh& mesh,
 250             const word& name,
 251             const topoSet& set,
 252             writeOption w=NO_WRITE
 253         );
 254
 255
 256     // Destructor
 257
 258         virtual ~topoSet();
 259
 260
 261     // Member functions
 262
 263         //- Invert contents. (insert all members 0..maxLen-1 which were not in
 264         //  set)
 265         virtual void invert(const label maxLen);
 266
 267         //- Subset contents. Only elements present in both sets remain.
 268         virtual void subset(const topoSet& set);
 269
 270         //- Add elements present in set.
 271         virtual void addSet(const topoSet& set);
 272
 273         //- Delete elements present in set.
 274         virtual void deleteSet(const topoSet& set);
 275
 276         //- Sync set across coupled patches.
 277         virtual void sync(const polyMesh& mesh);
 278
 279         //- Write labels columnwise to os. Truncate to maxLen.
 280         virtual void writeDebug(Ostream& os, const label maxLen) const;
 281
 282         //- Like above but also writes mesh related quantity
 283         //  (usually coordinate).
 284         virtual void writeDebug
 285         (
 286             Ostream& os,
 287             const primitiveMesh&,
 288             const label maxLen
 289         ) const;    // = 0;
 290
 291         //- Write contents.
 292         virtual bool writeData(Ostream&) const;
 293
 294         //- Update any stored data for new labels. Not implemented.
 295         virtual void updateMesh(const mapPolyMesh& morphMap);
 296
 297         //- Return max allowable index (+1). Not implemented.
 298         virtual label maxSize(const polyMesh& mesh) const;  // = 0;
 299
 300
 301
 302     // Member operators
 303
 304         //- Copy labelHashSet part only
 305         void operator=(const topoSet&);
 306
 307 };
 308
 309
 310 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 311
 312 } // End namespace Foam
 313
 314 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 315
 316 #endif
 317
 318 // ************************************************************************* //