OpenFOAM logo
Open Source CFD Toolkit

polyRemoveFace.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     polyRemoveFace
00027 
00028 Description
00029     Class containing data for face removal.
00030 
00031 \*---------------------------------------------------------------------------*/
00032 
00033 #ifndef polyRemoveFace_H
00034 #define polyRemoveFace_H
00035 
00036 #include "label.H"
00037 #include "topoAction.H"
00038 
00039 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00040 
00041 namespace Foam
00042 {
00043 
00044 /*---------------------------------------------------------------------------*\
00045                         Class polyRemoveFace Declaration
00046 \*---------------------------------------------------------------------------*/
00047 
00048 class polyRemoveFace
00049 :
00050     public topoAction
00051 {
00052     // Private data
00053 
00054         //- Face ID
00055         label faceID_;
00056 
00057 
00058 public:
00059 
00060     // Static data members
00061 
00062         //- Runtime type information
00063         TypeName("removeFace");
00064 
00065 
00066     // Constructors
00067 
00068         //- Construct null.  Used for constructing lists
00069         polyRemoveFace()
00070         :
00071             faceID_(-1)
00072         {}
00073 
00074         //- Construct from components
00075         polyRemoveFace(const label faceID)
00076         :
00077             faceID_(faceID)
00078         {}
00079 
00080         //- Construct and return a clone
00081         virtual autoPtr<topoAction> clone() const
00082         {
00083             return autoPtr<topoAction>(new polyRemoveFace(*this));
00084         }
00085 
00086 
00087     // Default Destructor
00088 
00089 
00090     // Member Functions
00091 
00092         //- Return face ID
00093         label faceID() const
00094         {
00095             return faceID_;
00096         }
00097 };
00098 
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 } // End namespace Foam
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 #endif
00107 
00108 // ************************************************************************* //
For further information go to www.openfoam.org