FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::faceSet
00026 
00027 Description
00028     A list of face labels.
00029 
00030 SourceFiles
00031     faceSet.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef faceSet_H
00036 #define faceSet_H
00037 
00038 #include <meshTools/topoSet.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class faceSet Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class faceSet
00050 :
00051     public topoSet
00052 {
00053 
00054 
00055 public:
00056 
00057     //- Runtime type information
00058     TypeName("faceSet");
00059 
00060 
00061     // Constructors
00062 
00063 
00064         //- Construct from IOobject
00065         faceSet(const IOobject& obj);
00066 
00067         //- Construct from objectRegistry and name
00068         faceSet
00069         (
00070             const polyMesh& mesh,
00071             const word& name,
00072             readOption r=MUST_READ,
00073             writeOption w=NO_WRITE
00074         );
00075 
00076         //- Construct from additional size of labelHashSet
00077         faceSet
00078         (
00079             const polyMesh& mesh,
00080             const word& name,
00081             const label,
00082             writeOption w=NO_WRITE
00083         );
00084 
00085         //- Construct from existing set
00086         faceSet
00087         (
00088             const polyMesh& mesh,
00089             const word& name,
00090             const topoSet&,
00091             writeOption w=NO_WRITE
00092         );
00093 
00094         //- Construct from additional labelHashSet
00095         faceSet
00096         (
00097             const polyMesh& mesh,
00098             const word& name,
00099             const labelHashSet&,
00100             writeOption w=NO_WRITE
00101         );
00102 
00103 
00104     // Destructor
00105 
00106         virtual ~faceSet();
00107 
00108 
00109     // Member functions
00110 
00111         //- Sync faceSet across coupled patches.
00112         virtual void sync(const polyMesh& mesh);
00113 
00114         //- Return max index+1.
00115         virtual label maxSize(const polyMesh& mesh) const;
00116 
00117         //- Update any stored data for new labels
00118         virtual void updateMesh(const mapPolyMesh& morphMap);
00119 
00120         //- Write maxLen items with label and coordinates.
00121         virtual void writeDebug
00122         (
00123             Ostream& os,
00124             const primitiveMesh&,
00125             const label maxLen
00126         ) const;
00127 
00128 };
00129 
00130 
00131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00132 
00133 } // End namespace Foam
00134 
00135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00136 
00137 #endif
00138 
00139 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines