src/dynamicMesh/polyTopoChange/polyTopoChange/modifyObject/polyModifyPoint.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::polyModifyPoint
  27
  28 Description
  29     Class describing modification of a point.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef polyModifyPoint_H
  34 #define polyModifyPoint_H
  35
  36 #include "label.H"
  37 #include "point.H"
  38 #include "topoAction.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                        Class polyModifyPoint Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class polyModifyPoint
  50 :
  51     public topoAction
  52 {
  53     // Private data
  54
  55         //- Point ID
  56         label pointID_;
  57
  58         //- New point location
  59         point location_;
  60
  61         //- Remove from current zone
  62         bool removeFromZone_;
  63
  64         //- New zone ID
  65         label zoneID_;
  66
  67         //- Does the point support a cell
  68         bool inCell_;
  69
  70
  71 public:
  72
  73     // Static data members
  74
  75         //- Runtime type information
  76         TypeName("modifyPoint");
  77
  78
  79     // Constructors
  80
  81         //- Construct null.  Used only for list construction
  82         polyModifyPoint()
  83         :
  84             pointID_(-1),
  85             location_(vector::zero),
  86             removeFromZone_(false),
  87             zoneID_(-1),
  88             inCell_(false)
  89         {}
  90
  91         //- Construct from components
  92         polyModifyPoint
  93         (
  94             const label pointID,
  95             const point& newP,
  96             const bool removeFromZone,
  97             const label newZoneID,
  98             const bool inCell
  99         )
 100         :
 101             pointID_(pointID),
 102             location_(newP),
 103             removeFromZone_(removeFromZone),
 104             zoneID_(newZoneID),
 105             inCell_(inCell)
 106         {}
 107
 108         //- Construct and return a clone
 109         virtual autoPtr<topoAction> clone() const
 110         {
 111             return autoPtr<topoAction>(new polyModifyPoint(*this));
 112         }
 113
 114
 115     // Default Destructor
 116
 117     // Member Functions
 118
 119         //- Point ID
 120         label pointID() const
 121         {
 122             return pointID_;
 123         }
 124
 125         //- New point location
 126         const point& newPoint() const
 127         {
 128             return location_;
 129         }
 130
 131         //- Does the point belong to a zone?
 132         bool isInZone() const
 133         {
 134             return zoneID_ >= 0;
 135         }
 136
 137         //- Should the point be removed from current zone
 138         bool removeFromZone() const
 139         {
 140             return removeFromZone_;
 141         }
 142
 143         //- Point zone ID
 144         label zoneID() const
 145         {
 146             return zoneID_;
 147         }
 148
 149         //- Does the point support a cell
 150         bool inCell() const
 151         {
 152             return inCell_;
 153         }
 154 };
 155
 156
 157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 158
 159 } // End namespace Foam
 160
 161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 162
 163 #endif
 164
 165 // ************************************************************************* //