src/finiteVolume/fvMesh/fvPatches/basic/coupled/coupledFvPatch.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::coupledFvPatch
  26
  27 Description
  28     An abstract base class for patches that couple regions of the
  29     computational domain e.g. cyclic and processor-processor links.
  30
  31 SourceFiles
  32     coupledFvPatch.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef coupledFvPatch_H
  37 #define coupledFvPatch_H
  38
  39 #include "fvPatch.H"
  40 #include "lduInterface.H"
  41 #include "coupledPolyPatch.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                          Class coupledFvPatch Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class coupledFvPatch
  53 :
  54     public lduInterface,
  55     public fvPatch
  56 {
  57     // Private data
  58
  59         const coupledPolyPatch& coupledPolyPatch_;
  60
  61
  62 protected:
  63
  64     // Protected Member Functions
  65
  66         //- Make patch weighting factors
  67         virtual void makeWeights(scalarField&) const = 0;
  68
  69         //- Make patch face - neighbour cell distances
  70         virtual void makeDeltaCoeffs(scalarField&) const = 0;
  71
  72         //- Make patch face non-orthogonality correction vectors
  73         virtual void makeCorrVecs(vectorField&) const;
  74
  75
  76 public:
  77
  78     friend class surfaceInterpolation;
  79
  80
  81     //- Runtime type information
  82     TypeName(coupledPolyPatch::typeName_());
  83
  84
  85     // Constructors
  86
  87         //- Construct from polyPatch
  88         coupledFvPatch(const polyPatch& patch, const fvBoundaryMesh& bm)
  89         :
  90             fvPatch(patch, bm),
  91             coupledPolyPatch_(refCast<const coupledPolyPatch>(patch))
  92         {}
  93
  94
  95     // Destructor
  96
  97         virtual ~coupledFvPatch();
  98
  99
 100     // Member Functions
 101
 102         // Access
 103
 104             //- Return true if patch is coupled
 105             virtual bool coupled() const
 106             {
 107                 return coupledPolyPatch_.coupled();
 108             }
 109
 110             //- Return face transformation tensor
 111             const tensorField& forwardT() const
 112             {
 113                 return coupledPolyPatch_.forwardT();
 114             }
 115
 116             //- Return neighbour-cell transformation tensor
 117             const tensorField& reverseT() const
 118             {
 119                 return coupledPolyPatch_.reverseT();
 120             }
 121
 122             //- Are the cyclic planes parallel
 123             bool parallel() const
 124             {
 125                 return coupledPolyPatch_.parallel();
 126             }
 127
 128             //- Return faceCell addressing
 129             virtual const unallocLabelList& faceCells() const
 130             {
 131                 return fvPatch::faceCells();
 132             }
 133
 134             //- Return delta (P to N) vectors across coupled patch
 135             virtual tmp<vectorField> delta() const = 0;
 136
 137
 138         // Interface transfer functions
 139
 140             //- Return the values of the given internal data adjacent to
 141             //  the interface as a field
 142             virtual tmp<labelField> interfaceInternalField
 143             (
 144                 const unallocLabelList& internalData
 145             ) const = 0;
 146
 147             //- Initialise interface data transfer
 148             virtual void initTransfer
 149             (
 150                 const Pstream::commsTypes commsType,
 151                 const unallocLabelList& interfaceData
 152             ) const
 153             {}
 154
 155             //- Transfer and return neighbour field
 156             virtual tmp<labelField> transfer
 157             (
 158                 const Pstream::commsTypes commsType,
 159                 const unallocLabelList& interfaceData
 160             ) const = 0;
 161
 162             //- Initialise neighbour field transfer
 163             virtual void initInternalFieldTransfer
 164             (
 165                 const Pstream::commsTypes commsType,
 166                 unallocLabelList& iF
 167             ) const
 168             {}
 169
 170             //- Return neighbour field
 171             virtual tmp<labelField> internalFieldTransfer
 172             (
 173                 const Pstream::commsTypes commsType,
 174                 const unallocLabelList& iF
 175             ) const = 0;
 176 };
 177
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 } // End namespace Foam
 182
 183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 184
 185 #endif
 186
 187 // ************************************************************************* //