src/OpenFOAM/meshes/pointMesh/pointPatches/derived/global/globalPointPatch.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::globalPointPatch
  27
  28 Description
  29     Foam::globalPointPatch
  30
  31 SourceFiles
  32     globalPointPatch.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef globalPointPatch_H
  37 #define globalPointPatch_H
  38
  39 #include "pointPatch.H"
  40 #include "coupledPointPatch.H"
  41 #include "globalMeshData.H"
  42 #include "pointMesh.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                       Class globalPointPatch Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class globalPointPatch
  54 :
  55     public pointPatch,
  56     public coupledPointPatch
  57 {
  58     // Private data
  59
  60         // //- Reference to the basic globalMeshData
  61         // const globalMeshData& globalMeshData_;
  62
  63         //- Index in the boundary mesh
  64         label index_;
  65
  66
  67     // Protected Member Functions
  68
  69         //- Initialise the calculation of the patch geometry
  70         virtual void initGeometry()
  71         {}
  72
  73         //- Calculate the patch geometry
  74         virtual void calcGeometry()
  75         {}
  76
  77         //- Initialise the patches for moving points
  78         virtual void initMovePoints(const pointField&)
  79         {}
  80
  81         //- Correct patches after moving points
  82         virtual void movePoints(const pointField&)
  83         {}
  84
  85         //- Initialise the update of the patch topology
  86         virtual void initUpdateMesh()
  87         {}
  88
  89         //- Update of the patch topology
  90         virtual void updateMesh()
  91         {}
  92
  93
  94     // Private Member Functions
  95
  96         //- Disallow default construct as copy
  97         globalPointPatch
  98         (
  99             const globalPointPatch&
 100         );
 101
 102         //- Disallow default assignment
 103         void operator=(const globalPointPatch&);
 104
 105
 106 public:
 107
 108     //- Runtime type information
 109     TypeName("global");
 110
 111     // Constructors
 112
 113         //- Construct from components
 114         globalPointPatch
 115         (
 116             const pointBoundaryMesh&,
 117             const label index
 118         );
 119
 120
 121     // Destructor
 122
 123         virtual ~globalPointPatch();
 124
 125
 126     // Member functions
 127
 128         //- Return name
 129         virtual const word& name() const
 130         {
 131             // There can only be a single patch of this type - therefore
 132             // its name is hard-coded.
 133             return type();
 134         }
 135
 136         //- Return size
 137         virtual label size() const
 138         {
 139             return meshPoints().size();
 140         }
 141
 142         //- Return true if running parallel
 143         virtual bool coupled() const
 144         {
 145             if (Pstream::parRun())
 146             {
 147                 return true;
 148             }
 149             else
 150             {
 151                 return false;
 152             }
 153         }
 154
 155         //- Return number of faces
 156         virtual label nFaces() const
 157         {
 158             return 0;
 159         }
 160
 161         //- Return the index of this patch in the pointBoundaryMesh
 162         virtual label index() const
 163         {
 164             return index_;
 165         }
 166
 167         //- Return mesh points
 168         virtual const labelList& meshPoints() const
 169         {
 170             return boundaryMesh().mesh().globalData().sharedPointLabels();
 171         }
 172
 173         //- Return local points.  Not implemented
 174         virtual const pointField& localPoints() const
 175         {
 176             notImplemented("globalPointPatch::localPoints() const");
 177             return pointField::null();
 178         }
 179
 180         //- Return point normals.  Not implemented
 181         virtual const vectorField& pointNormals() const
 182         {
 183             notImplemented("globalPointPatch::pointNormals() const");
 184             return vectorField::null();
 185         }
 186
 187         //- Return total number of shared points
 188         virtual label globalPointSize() const
 189         {
 190             return boundaryMesh().mesh().globalData().nGlobalPoints();
 191         }
 192
 193         //- Return addressing into the global points list
 194         const labelList& sharedPointAddr() const
 195         {
 196             return boundaryMesh().mesh().globalData().sharedPointAddr();
 197         }
 198 };
 199
 200
 201 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 202
 203 } // End namespace Foam
 204
 205 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 206
 207 #endif
 208
 209 // ************************************************************************* //