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

polyRemoveCell.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::polyRemoveCell
00026 
00027 Description
00028     Class containing data for cell removal.
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef polyRemoveCell_H
00033 #define polyRemoveCell_H
00034 
00035 #include <OpenFOAM/label.H>
00036 #include <dynamicMesh/topoAction.H>
00037 
00038 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00039 
00040 namespace Foam
00041 {
00042 
00043 /*---------------------------------------------------------------------------*\
00044                        Class polyRemoveCell Declaration
00045 \*---------------------------------------------------------------------------*/
00046 
00047 class polyRemoveCell
00048 :
00049     public topoAction
00050 {
00051     // Private data
00052 
00053         //- Cell ID
00054         label cellID_;
00055 
00056         //- Merge cell ID or -1
00057         label mergeCellID_;
00058 
00059 public:
00060 
00061     // Static data members
00062 
00063         //- Runtime type information
00064         TypeName("removeCell");
00065 
00066 
00067     // Constructors
00068 
00069         //- Construct null.  Used for constructing lists
00070         polyRemoveCell()
00071         :
00072             cellID_(-1),
00073             mergeCellID_(-1)
00074         {}
00075 
00076         //- Construct from components
00077         polyRemoveCell(const label cellID, const label mergeCellID = -1)
00078         :
00079             cellID_(cellID),
00080             mergeCellID_(mergeCellID)
00081         {}
00082 
00083         //- Construct and return a clone
00084         virtual autoPtr<topoAction> clone() const
00085         {
00086             return autoPtr<topoAction>(new polyRemoveCell(*this));
00087         }
00088 
00089 
00090     // Default Destructor
00091 
00092 
00093     // Member Functions
00094 
00095         //- Return cell ID
00096         label cellID() const
00097         {
00098             return cellID_;
00099         }
00100 
00101         //- Return cell ID
00102         label mergeCellID() const
00103         {
00104             return mergeCellID_;
00105         }
00106 };
00107 
00108 
00109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00110 
00111 } // End namespace Foam
00112 
00113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00114 
00115 #endif
00116 
00117 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines