src/OpenFOAM/meshes/pointMesh/pointPatches/basic/coupled/coupledPointPatch.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::coupledPointPatch
  26
  27 Description
  28     coupled patch for post-processing.  Used as the base class for processor
  29     and cyclic pointPatches
  30
  31 SourceFiles
  32     coupledPointPatch.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef coupledPointPatch_H
  37 #define coupledPointPatch_H
  38
  39 #include "coupledPolyPatch.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 class pointBoundaryMesh;
  47
  48 /*---------------------------------------------------------------------------*\
  49                       Class coupledPointPatch Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class coupledPointPatch
  53 {
  54     // Private Member Functions
  55
  56         //- Disallow default construct as copy
  57         coupledPointPatch(const coupledPointPatch&);
  58
  59         //- Disallow default assignment
  60         void operator=(const coupledPointPatch&);
  61
  62
  63 protected:
  64
  65     // Protected Member Functions
  66
  67         //- Initialise the calculation of the patch geometry
  68         virtual void initGeometry(PstreamBuffers&) = 0;
  69
  70         //- Calculate the patch geometry
  71         virtual void calcGeometry(PstreamBuffers&) = 0;
  72
  73         //- Initialise the patches for moving points
  74         virtual void initMovePoints(PstreamBuffers&, const pointField&) = 0;
  75
  76         //- Correct patches after moving points
  77         virtual void movePoints(PstreamBuffers&, const pointField&) = 0;
  78
  79         //- Initialise the update of the patch topology
  80         virtual void initUpdateMesh(PstreamBuffers&) = 0;
  81
  82         //- Update of the patch topology
  83         virtual void updateMesh(PstreamBuffers&) = 0;
  84
  85
  86 public:
  87
  88     //- Runtime type information
  89     TypeName(coupledPolyPatch::typeName_());
  90
  91
  92     // Constructors
  93
  94         //- Construct from components
  95         coupledPointPatch(const pointBoundaryMesh& bm);
  96
  97
  98     //- Destructor
  99     virtual ~coupledPointPatch();
 100
 101
 102     // Member Functions
 103
 104         // Access
 105
 106             //- Return true because this patch is coupled
 107             virtual bool coupled() const
 108             {
 109                 return true;
 110             }
 111 };
 112
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 } // End namespace Foam
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 #endif
 121
 122 // ************************************************************************* //