OpenFOAM logo
Open Source CFD Toolkit

faceSet.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     faceSet
00027 
00028 Description
00029     List of face labels.
00030 
00031 SourceFiles
00032     faceSet.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef faceSet_H
00037 #define faceSet_H
00038 
00039 #include "topoSet.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class faceSet Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class faceSet
00051 :
00052     public topoSet
00053 {
00054 
00055 
00056 public:
00057 
00058     //- Runtime type information
00059     TypeName("faceSet");
00060 
00061 
00062     // Constructors
00063 
00064 
00065         //- Construct from IOobject
00066         faceSet(const IOobject& obj);
00067 
00068         //- Construct from objectRegistry and name
00069         faceSet
00070         (
00071             const polyMesh& mesh,
00072             const word& name,
00073             readOption r=MUST_READ,
00074             writeOption w=NO_WRITE
00075         );
00076 
00077         //- Construct from additional size of labelHashSet
00078         faceSet
00079         (
00080             const polyMesh& mesh,
00081             const word& name,
00082             const label,
00083             writeOption w=NO_WRITE
00084         );
00085 
00086         //- Construct from additional labelHashSet
00087         faceSet
00088         (
00089             const polyMesh& mesh,
00090             const word& name,
00091             const labelHashSet&,
00092             writeOption w=NO_WRITE
00093         );
00094 
00095 
00096     // Destructor
00097 
00098         virtual ~faceSet();
00099 
00100 
00101     // Member functions
00102 
00103         //- Sync faceSet across coupled patches.
00104         virtual void sync(const polyMesh& mesh);
00105 
00106         //- Return max index+1.
00107         virtual label maxSize(const polyMesh& mesh) const;
00108 
00109         //- Update any stored data for new labels
00110         virtual void updateMesh(const mapPolyMesh& morphMap);
00111 
00112         //- Update any stored data for new labels
00113         //virtual void updateMesh(const directPolyTopoChange& meshMod);
00114 
00115         //- Write maxLen items with label and coordinates. 
00116         virtual void writeDebug
00117         (
00118             Ostream& os,
00119             const primitiveMesh&,
00120             const label maxLen
00121         ) const;
00122 
00123 };
00124 
00125 
00126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00127 
00128 } // End namespace Foam
00129 
00130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00131 
00132 #endif
00133 
00134 // ************************************************************************* //
For further information go to www.openfoam.org