src/meshTools/directMapped/directMappedPolyPatch/directMappedPolyPatch.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::directMappedPolyPatch
  26
  27 Description
  28     Determines a mapping between patch face centres and mesh cell or face
  29     centres and processors they're on.
  30
  31 Note
  32     Storage is not optimal. It stores all face centres and cells on all
  33     processors to keep the addressing calculation simple.
  34
  35 SourceFiles
  36     directMappedPolyPatch.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef directMappedPolyPatch_H
  41 #define directMappedPolyPatch_H
  42
  43 #include "polyPatch.H"
  44 #include "directMappedPatchBase.H"
  45
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 class polyMesh;
  53
  54 /*---------------------------------------------------------------------------*\
  55                       Class directMappedPolyPatch Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class directMappedPolyPatch
  59 :
  60     public polyPatch,
  61     public directMappedPatchBase
  62 {
  63
  64 protected:
  65
  66         //- Initialise the calculation of the patch geometry
  67         virtual void initGeometry(PstreamBuffers&);
  68
  69         //- Calculate the patch geometry
  70         virtual void calcGeometry(PstreamBuffers&);
  71
  72         //- Initialise the patches for moving points
  73         virtual void initMovePoints(PstreamBuffers&, const pointField&);
  74
  75         //- Correct patches after moving points
  76         virtual void movePoints(PstreamBuffers&, const pointField&);
  77
  78         //- Initialise the update of the patch topology
  79         virtual void initUpdateMesh(PstreamBuffers&);
  80
  81         //- Update of the patch topology
  82         virtual void updateMesh(PstreamBuffers&);
  83
  84
  85 public:
  86
  87     //- Runtime type information
  88     TypeName("directMappedPatch");
  89
  90
  91     // Constructors
  92
  93         //- Construct from components
  94         directMappedPolyPatch
  95         (
  96             const word& name,
  97             const label size,
  98             const label start,
  99             const label index,
 100             const polyBoundaryMesh& bm
 101         );
 102
 103         //- Construct from components
 104         directMappedPolyPatch
 105         (
 106             const word& name,
 107             const label size,
 108             const label start,
 109             const label index,
 110             const word& sampleRegion,
 111             const directMappedPatchBase::sampleMode mode,
 112             const word& samplePatch,
 113             const vectorField& offset,
 114             const polyBoundaryMesh& bm
 115         );
 116
 117         //- Construct from components. Uniform offset.
 118         directMappedPolyPatch
 119         (
 120             const word& name,
 121             const label size,
 122             const label start,
 123             const label index,
 124             const word& sampleRegion,
 125             const directMappedPatchBase::sampleMode mode,
 126             const word& samplePatch,
 127             const vector& offset,
 128             const polyBoundaryMesh& bm
 129         );
 130
 131         //- Construct from dictionary
 132         directMappedPolyPatch
 133         (
 134             const word& name,
 135             const dictionary& dict,
 136             const label index,
 137             const polyBoundaryMesh& bm
 138         );
 139
 140         //- Construct as copy, resetting the boundary mesh
 141         directMappedPolyPatch
 142         (
 143             const directMappedPolyPatch&,
 144             const polyBoundaryMesh&
 145         );
 146
 147         //- Construct given the original patch and resetting the
 148         //  face list and boundary mesh information
 149         directMappedPolyPatch
 150         (
 151             const directMappedPolyPatch& pp,
 152             const polyBoundaryMesh& bm,
 153             const label index,
 154             const label newSize,
 155             const label newStart
 156         );
 157
 158         //- Construct given the original patch and a map
 159         directMappedPolyPatch
 160         (
 161             const directMappedPolyPatch& pp,
 162             const polyBoundaryMesh& bm,
 163             const label index,
 164             const labelUList& mapAddressing,
 165             const label newStart
 166         );
 167
 168         //- Construct and return a clone, resetting the boundary mesh
 169         virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
 170         {
 171             return autoPtr<polyPatch>(new directMappedPolyPatch(*this, bm));
 172         }
 173
 174         //- Construct and return a clone, resetting the face list
 175         //  and boundary mesh
 176         virtual autoPtr<polyPatch> clone
 177         (
 178             const polyBoundaryMesh& bm,
 179             const label index,
 180             const label newSize,
 181             const label newStart
 182         ) const
 183         {
 184             return autoPtr<polyPatch>
 185             (
 186                 new directMappedPolyPatch(*this, bm, index, newSize, newStart)
 187             );
 188         }
 189
 190         //- Construct and return a clone, resetting the face list
 191         //  and boundary mesh
 192         virtual autoPtr<polyPatch> clone
 193         (
 194             const polyBoundaryMesh& bm,
 195             const label index,
 196             const labelUList& mapAddressing,
 197             const label newStart
 198         ) const
 199         {
 200             return autoPtr<polyPatch>
 201             (
 202                 new directMappedPolyPatch
 203                 (
 204                     *this,
 205                     bm,
 206                     index,
 207                     mapAddressing,
 208                     newStart
 209                 )
 210             );
 211         }
 212
 213
 214     //- Destructor
 215     virtual ~directMappedPolyPatch();
 216
 217
 218     // Member functions
 219
 220         //- Write the polyPatch data as a dictionary
 221         virtual void write(Ostream&) const;
 222 };
 223
 224
 225 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 226
 227 } // End namespace Foam
 228
 229 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 230
 231 #endif
 232
 233 // ************************************************************************* //