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) 1991-2008 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::cyclicPointPatch
  27
  28 Description
  29     Cyclic patch for post-processing.
  30
  31 SourceFiles
  32     cyclicPointPatch.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef cyclicPointPatch_H
  37 #define cyclicPointPatch_H
  38
  39 #include "coupledFacePointPatch.H"
  40 #include "cyclicPolyPatch.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         //- The set of pairs of points that require transformation
  73         //  and/or mapping
  74         edgeList transformPairs_;
  75
  76         //- Initialise the calculation of the patch geometry
  77         virtual void initGeometry();
  78
  79         //- Calculate the patch geometry
  80         virtual void calcGeometry();
  81
  82         //- Initialise the patches for moving points
  83         virtual void initMovePoints(const pointField&);
  84
  85         //- Correct patches after moving points
  86         virtual void movePoints(const pointField&);
  87
  88         //- Initialise the update of the patch topology
  89         virtual void initUpdateMesh();
  90
  91         //- Update of the patch topology
  92         virtual void updateMesh();
  93
  94
  95 public:
  96
  97     //- Runtime type information
  98     TypeName(cyclicPolyPatch::typeName_());
  99
 100
 101     // Constructors
 102
 103         //- Construct from components
 104         cyclicPointPatch
 105         (
 106             const polyPatch& patch,
 107             const pointBoundaryMesh& bm
 108         );
 109
 110
 111     // Destructor
 112
 113         virtual ~cyclicPointPatch();
 114
 115
 116     // Member Functions
 117
 118         // Access
 119
 120             //- Return the underlying cyclicPolyPatch
 121             const cyclicPolyPatch& cyclicPatch() const
 122             {
 123                 return cyclicPolyPatch_;
 124             }
 125
 126             //- Are the cyclic planes parallel
 127             bool parallel() const
 128             {
 129                 return cyclicPolyPatch_.parallel();
 130             }
 131
 132             //- Return face transformation tensor
 133             const tensorField& forwardT() const
 134             {
 135                 return cyclicPolyPatch_.forwardT();
 136             }
 137
 138             //- Return neighbour-cell transformation tensor
 139             const tensorField& reverseT() const
 140             {
 141                 return cyclicPolyPatch_.reverseT();
 142             }
 143
 144
 145         // Access functions for demand driven data
 146
 147             //- Return the set of pairs of points that require transformation
 148             //  and/or mapping
 149             virtual const edgeList& transformPairs() const;
 150 };
 151
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 } // End namespace Foam
 156
 157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 158
 159 #endif
 160
 161 // ************************************************************************* //