src/dynamicMesh/polyTopoChange/polyTopoChange/removeObject/polyRemovePoint.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::polyRemovePoint
  27
  28 Description
  29     Class containing data for point removal.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef polyRemovePoint_H
  34 #define polyRemovePoint_H
  35
  36 #include "label.H"
  37 #include "topoAction.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                        Class polyRemovePoint Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 class polyRemovePoint
  49 :
  50     public topoAction
  51 {
  52     // Private data
  53
  54         //- Point ID
  55         label pointID_;
  56
  57         //- Merge point ID or -1
  58         label mergePointID_;
  59
  60
  61 public:
  62
  63     // Static data members
  64
  65         //- Runtime type information
  66         TypeName("removePoint");
  67
  68
  69     // Constructors
  70
  71         //- Construct null.  Used for constructing lists
  72         polyRemovePoint()
  73         :
  74             pointID_(-1),
  75             mergePointID_(-1)
  76         {}
  77
  78         //- Construct from components
  79         polyRemovePoint(const label pointID, const label mergePointID = -1)
  80         :
  81             pointID_(pointID),
  82             mergePointID_(mergePointID)
  83         {}
  84
  85         //- Construct and return a clone
  86         virtual autoPtr<topoAction> clone() const
  87         {
  88             return autoPtr<topoAction>(new polyRemovePoint(*this));
  89         }
  90
  91
  92     // Default Destructor
  93
  94
  95     // Member Functions
  96
  97         //- Return point ID
  98         label pointID() const
  99         {
 100             return pointID_;
 101         }
 102
 103         label mergePointID() const
 104         {
 105             return mergePointID_;
 106         }
 107 };
 108
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 } // End namespace Foam
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 #endif
 117
 118 // ************************************************************************* //