src/OpenFOAM/matrices/lduMatrix/lduAddressing/lduInterface/ggiLduInterface.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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     ggiLduInterface
  27
  28 Description
  29     An abstract base class for ggi coupled interfaces.
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  33
  34 SourceFiles
  35     ggiLduInterface.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef ggiLduInterface_H
  40 #define ggiLduInterface_H
  41
  42 #include "lduInterface.H"
  43 #include "primitiveFieldsFwd.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                        Class ggiLduInterface Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class ggiLduInterface
  55 {
  56 protected:
  57
  58     // Protected data
  59
  60         //- Transfer buffer
  61         mutable labelField labelTransferBuffer_;
  62
  63         //- Field transfer buffer
  64         mutable scalarField fieldTransferBuffer_;
  65
  66
  67 public:
  68
  69     //- Runtime type information
  70     TypeName("ggiLduInterface");
  71
  72     // Constructors
  73
  74         //- Construct null
  75         ggiLduInterface()
  76         :
  77             labelTransferBuffer_(),
  78             fieldTransferBuffer_()
  79         {}
  80
  81
  82     // Destructor
  83
  84         virtual ~ggiLduInterface();
  85
  86
  87     // Member Functions
  88
  89         //- Is this the master side?
  90         virtual bool master() const = 0;
  91
  92         //- Is this the fine level?
  93         virtual bool fineLevel() const = 0;
  94
  95         //- Return shadow interface index
  96         virtual label shadowIndex() const = 0;
  97
  98         //- Return shadow interface
  99         virtual const ggiLduInterface& shadowInterface() const = 0;
 100
 101         //- Return zone size
 102         virtual label zoneSize() const = 0;
 103
 104         //- Return zone addressing
 105         virtual const labelList& zoneAddressing() const = 0;
 106
 107         //- Return fine level addressing
 108         virtual const labelListList& addressing() const = 0;
 109
 110         //- Is the patch localised on a single processor
 111         virtual bool localParallel() const = 0;
 112
 113         //- Return weights
 114         virtual const scalarListList& weights() const = 0;
 115
 116         //- Return face transformation tensor
 117         virtual const tensorField& forwardT() const = 0;
 118
 119         //- Return face reverse transformation tensor
 120         virtual const tensorField& reverseT() const = 0;
 121
 122
 123         // Transfer buffer access
 124
 125             //- Return contents of the label transfer buffer
 126             const labelField& labelTransferBuffer() const
 127             {
 128                 return labelTransferBuffer_;
 129             }
 130
 131             //- Return contents of the field transfer buffer
 132             const scalarField& fieldTransferBuffer() const
 133             {
 134                 return fieldTransferBuffer_;
 135             }
 136 };
 137
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 } // End namespace Foam
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 #endif
 146
 147 // ************************************************************************* //