src/OpenFOAM/meshes/pointMesh/pointPatches/facePointPatch/facePointPatch.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::facePointPatch
  26
  27 Description
  28     A pointPatch based on a polyPatch
  29
  30 SourceFiles
  31     facePointPatch.C
  32     newPointPatch.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef facePointPatch_H
  37 #define facePointPatch_H
  38
  39 #include "pointPatch.H"
  40 #include "polyPatch.H"
  41 #include "autoPtr.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 class processorPointPatch;
  49 class cyclicPointPatch;
  50
  51 /*---------------------------------------------------------------------------*\
  52                   Class facePointPatch Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class facePointPatch
  56 :
  57     public pointPatch
  58 {
  59 protected:
  60
  61     // Protected data
  62
  63         //- Reference to the underlying polyPatch
  64         const polyPatch& polyPatch_;
  65
  66
  67     // Protected Member Functions
  68
  69         //- Initialise the calculation of the patch geometry
  70         virtual void initGeometry(PstreamBuffers&);
  71
  72         //- Calculate the patch geometry
  73         virtual void calcGeometry(PstreamBuffers&);
  74
  75         //- Initialise the patches for moving points
  76         virtual void initMovePoints(PstreamBuffers&, const pointField&);
  77
  78         //- Correct patches after moving points
  79         virtual void movePoints(PstreamBuffers&, const pointField&);
  80
  81         //- Initialise the update of the patch topology
  82         virtual void initUpdateMesh(PstreamBuffers&);
  83
  84         //- Update of the patch topology
  85         virtual void updateMesh(PstreamBuffers&);
  86
  87
  88 private:
  89
  90     // Private Member Functions
  91
  92         //- Disallow default bitwise copy construct
  93         facePointPatch(const facePointPatch&);
  94
  95         //- Disallow default bitwise assignment
  96         void operator=(const facePointPatch&);
  97
  98
  99 public:
 100
 101     // Declare friendship with the coupledPointPatches to allow them to extend
 102     // the set of points with those not associated with faces
 103     friend class processorPointPatch;
 104     friend class cyclicPointPatch;
 105
 106
 107     //- Runtime type information
 108     TypeName(polyPatch::typeName_());
 109
 110
 111     // Declare run-time constructor selection tables
 112
 113         declareRunTimeSelectionTable
 114         (
 115             autoPtr,
 116             facePointPatch,
 117             polyPatch,
 118             (const polyPatch& patch, const pointBoundaryMesh& bm),
 119             (patch, bm)
 120         );
 121
 122
 123     // Constructors
 124
 125         //- Construct from polyPatch
 126         facePointPatch
 127         (
 128             const polyPatch&,
 129             const pointBoundaryMesh&
 130         );
 131
 132
 133     // Selectors
 134
 135         //- Return a pointer to a new patch created on freestore from polyPatch
 136         static autoPtr<facePointPatch> New
 137         (
 138             const polyPatch&,
 139             const pointBoundaryMesh&
 140         );
 141
 142
 143     //- Destructor
 144     virtual ~facePointPatch()
 145     {}
 146
 147
 148     // Member Functions
 149
 150         //- Return the polyPatch
 151         const polyPatch& patch() const
 152         {
 153             return polyPatch_;
 154         }
 155
 156         //- Return name
 157         virtual const word& name() const
 158         {
 159             return polyPatch_.name();
 160         }
 161
 162         //- Return size
 163         virtual label size() const
 164         {
 165             return meshPoints().size();
 166         }
 167
 168         //- Return the index of this patch in the pointBoundaryMesh
 169         virtual label index() const
 170         {
 171             return polyPatch_.index();
 172         }
 173
 174         //- Return mesh points
 175         virtual const labelList& meshPoints() const
 176         {
 177             return polyPatch_.meshPoints();
 178         }
 179
 180
 181         //- Return pointField of points in patch
 182         virtual const pointField& localPoints() const
 183         {
 184             return polyPatch_.localPoints();
 185         }
 186
 187
 188         //- Return point unit normals
 189         virtual const vectorField& pointNormals() const
 190         {
 191             return polyPatch_.pointNormals();
 192         }
 193 };
 194
 195
 196 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 197
 198 } // End namespace Foam
 199
 200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 201
 202 #endif
 203
 204 // ************************************************************************* //