src/finiteVolume/fvMesh/fvPatches/constraint/processor/processorFvPatch.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  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::processorFvPatch
  26
  27 Description
  28     Processor patch.
  29
  30 SourceFiles
  31     processorFvPatch.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef processorFvPatch_H
  36 #define processorFvPatch_H
  37
  38 #include "coupledFvPatch.H"
  39 #include "processorLduInterface.H"
  40 #include "processorPolyPatch.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class processorFvPatch Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class processorFvPatch
  52 :
  53     public coupledFvPatch,
  54     public processorLduInterface
  55 {
  56     // Private Data
  57
  58         const processorPolyPatch& procPolyPatch_;
  59
  60
  61 protected:
  62
  63     // Protected Member functions
  64
  65         //- Make patch weighting factors
  66         void makeWeights(scalarField&) const;
  67
  68         //- Make patch face - neighbour cell distances
  69         void makeDeltaCoeffs(scalarField&) const;
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName(processorPolyPatch::typeName_());
  76
  77
  78     // Constructors
  79
  80         //- Construct from components
  81         processorFvPatch(const polyPatch& patch, const fvBoundaryMesh& bm)
  82         :
  83             coupledFvPatch(patch, bm),
  84             procPolyPatch_(refCast<const processorPolyPatch>(patch))
  85         {}
  86
  87
  88     // Member functions
  89
  90         //- Return processor number
  91         int myProcNo() const
  92         {
  93             return procPolyPatch_.myProcNo();
  94         }
  95
  96         //- Return neigbour processor number
  97         int neighbProcNo() const
  98         {
  99             return procPolyPatch_.neighbProcNo();
 100         }
 101
 102         //- Return message tag used for sending
 103         virtual int tag() const
 104         {
 105             return UPstream::msgType();
 106         }
 107
 108         //- Return true if running parallel
 109         virtual bool coupled() const
 110         {
 111             if (Pstream::parRun())
 112             {
 113                 return true;
 114             }
 115             else
 116             {
 117                 return false;
 118             }
 119         }
 120
 121         const processorPolyPatch& procPolyPatch() const
 122         {
 123             return procPolyPatch_;
 124         }
 125
 126         //- Are the cyclic planes parallel
 127         virtual bool parallel() const
 128         {
 129             return procPolyPatch_.parallel();
 130         }
 131
 132         //- Return face transformation tensor
 133         virtual const tensorField& forwardT() const
 134         {
 135             return procPolyPatch_.forwardT();
 136         }
 137
 138         //- Return neighbour-cell transformation tensor.
 139         virtual const tensorField& reverseT() const
 140         {
 141             return procPolyPatch_.reverseT();
 142         }
 143
 144         //- Return delta (P to N) vectors across coupled patch
 145         virtual tmp<vectorField> delta() const;
 146
 147
 148         // Interface transfer functions
 149
 150             //- Return the values of the given internal data adjacent to
 151             //  the interface as a field
 152             virtual tmp<labelField> interfaceInternalField
 153             (
 154                 const labelUList& internalData
 155             ) const;
 156
 157             //- Initialise neighbour field transfer
 158             virtual void initInternalFieldTransfer
 159             (
 160                 const Pstream::commsTypes commsType,
 161                 const labelUList& internalData
 162             ) const;
 163
 164             //- Return neighbour field
 165             virtual tmp<labelField> internalFieldTransfer
 166             (
 167                 const Pstream::commsTypes commsType,
 168                 const labelUList& internalData
 169             ) const;
 170 };
 171
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 } // End namespace Foam
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 #endif
 180
 181 // ************************************************************************* //