src/meshTools/sets/topoSets/faceSet.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::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 <meshTools/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
  55
  56 public:
  57
  58     //- Runtime type information
  59     TypeName("faceSet");
  60
  61
  62     // Constructors
  63
  64
  65         //- Construct from IOobject
  66         faceSet(const IOobject& obj);
  67
  68         //- Construct from objectRegistry and name
  69         faceSet
  70         (
  71             const polyMesh& mesh,
  72             const word& name,
  73             readOption r=MUST_READ,
  74             writeOption w=NO_WRITE
  75         );
  76
  77         //- Construct from additional size of labelHashSet
  78         faceSet
  79         (
  80             const polyMesh& mesh,
  81             const word& name,
  82             const label,
  83             writeOption w=NO_WRITE
  84         );
  85
  86         //- Construct from additional labelHashSet
  87         faceSet
  88         (
  89             const polyMesh& mesh,
  90             const word& name,
  91             const labelHashSet&,
  92             writeOption w=NO_WRITE
  93         );
  94
  95
  96     // Destructor
  97
  98         virtual ~faceSet();
  99
 100
 101     // Member functions
 102
 103         //- Sync faceSet across coupled patches.
 104         virtual void sync(const polyMesh& mesh);
 105
 106         //- Return max index+1.
 107         virtual label maxSize(const polyMesh& mesh) const;
 108
 109         //- Update any stored data for new labels
 110         virtual void updateMesh(const mapPolyMesh& morphMap);
 111
 112         //- Write maxLen items with label and coordinates.
 113         virtual void writeDebug
 114         (
 115             Ostream& os,
 116             const primitiveMesh&,
 117             const label maxLen
 118         ) const;
 119
 120 };
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace Foam
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #endif
 130
 131 // ************************ vim: set sw=4 sts=4 et: ************************ //