src/OpenFOAM/meshes/pointMesh/pointPatches/constraint/cyclic/cyclicPointPatch.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::cyclicPointPatch
  26
  27 Description
  28     Cyclic patch for post-processing.
  29
  30 SourceFiles
  31     cyclicPointPatch.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef cyclicPointPatch_H
  36 #define cyclicPointPatch_H
  37
  38 #include "coupledFacePointPatch.H"
  39 #include "cyclicPolyPatch.H"
  40 #include "pointBoundaryMesh.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                       Class cyclicPointPatch Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class cyclicPointPatch
  52 :
  53     public coupledFacePointPatch
  54 {
  55     // Private data
  56
  57         //- Local reference cast into the cyclic patch
  58         const cyclicPolyPatch& cyclicPolyPatch_;
  59
  60
  61     // Private Member Functions
  62
  63         //- Disallow default construct as copy
  64         cyclicPointPatch(const cyclicPointPatch&);
  65
  66         //- Disallow default assignment
  67         void operator=(const cyclicPointPatch&);
  68
  69
  70     // Demand driven private data
  71
  72         //- Initialise the calculation of the patch geometry
  73         virtual void initGeometry(PstreamBuffers&);
  74
  75         //- Calculate the patch geometry
  76         virtual void calcGeometry(PstreamBuffers&);
  77
  78         //- Initialise the patches for moving points
  79         virtual void initMovePoints(PstreamBuffers&, const pointField&);
  80
  81         //- Correct patches after moving points
  82         virtual void movePoints(PstreamBuffers&, const pointField&);
  83
  84         //- Initialise the update of the patch topology
  85         virtual void initUpdateMesh(PstreamBuffers&);
  86
  87         //- Update of the patch topology
  88         virtual void updateMesh(PstreamBuffers&);
  89
  90
  91 public:
  92
  93     //- Runtime type information
  94     TypeName(cyclicPolyPatch::typeName_());
  95
  96
  97     // Constructors
  98
  99         //- Construct from components
 100         cyclicPointPatch
 101         (
 102             const polyPatch& patch,
 103             const pointBoundaryMesh& bm
 104         );
 105
 106
 107     //- Destructor
 108     virtual ~cyclicPointPatch();
 109
 110
 111     // Member Functions
 112
 113         // Access
 114
 115             //- Return the constraint type this pointPatch implements.
 116             virtual const word& constraintType() const
 117             {
 118                 return type();
 119             }
 120
 121             //- Return the underlying cyclicPolyPatch
 122             const cyclicPolyPatch& cyclicPatch() const
 123             {
 124                 return cyclicPolyPatch_;
 125             }
 126
 127             //- Return neighbour point patch
 128             const cyclicPointPatch& neighbPatch() const
 129             {
 130                 label patchI = cyclicPolyPatch_.neighbPatchID();
 131                 const pointPatch& pp = this->boundaryMesh()[patchI];
 132                 return refCast<const cyclicPointPatch>(pp);
 133             }
 134
 135             //- Are the cyclic planes parallel
 136             bool parallel() const
 137             {
 138                 return cyclicPolyPatch_.parallel();
 139             }
 140
 141             //- Return face transformation tensor
 142             const tensorField& forwardT() const
 143             {
 144                 return cyclicPolyPatch_.forwardT();
 145             }
 146
 147             //- Return neighbour-cell transformation tensor
 148             const tensorField& reverseT() const
 149             {
 150                 return cyclicPolyPatch_.reverseT();
 151             }
 152
 153
 154         // Access functions for demand driven data
 155
 156             //- Return the set of pairs of points that require transformation
 157             //  and/or mapping. First index is on this patch, second on the
 158             //  neighbour patch.
 159             virtual const edgeList& transformPairs() const;
 160
 161 };
 162
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 } // End namespace Foam
 167
 168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 169
 170 #endif
 171
 172 // ************************************************************************* //