src/foam/matrices/lduMatrix/solvers/GAMG/interfaces/processorGAMGInterface/processorGAMGInterface.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::processorGAMGInterface
  26
  27 Description
  28     GAMG agglomerated processor interface.
  29
  30 SourceFiles
  31     processorGAMGInterface.C
  32     processorGAMGInterfaceTemplates.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef processorGAMGInterface_H
  37 #define processorGAMGInterface_H
  38
  39 #include "GAMGInterface.H"
  40 #include "processorLduInterface.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                   Class processorGAMGInterface Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class processorGAMGInterface
  52 :
  53     public GAMGInterface,
  54     public processorLduInterface
  55 {
  56     // Private data
  57
  58         //- Reference tor the processorLduInterface from which this is
  59         //  agglomerated
  60         const processorLduInterface& fineProcInterface_;
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow default bitwise copy construct
  66         processorGAMGInterface(const processorGAMGInterface&);
  67
  68         //- Disallow default bitwise assignment
  69         void operator=(const processorGAMGInterface&);
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("processor");
  76
  77     // Constructors
  78
  79         //- Construct from fine-level interface,
  80         //  local and neighbour restrict addressing
  81         processorGAMGInterface
  82         (
  83             const lduPrimitiveMesh& lduMesh,
  84             const lduInterface& fineInterface,
  85             const labelField& localRestrictAddressing,
  86             const labelField& neighbourRestrictAddressing
  87         );
  88
  89
  90     // Destructor
  91
  92         virtual ~processorGAMGInterface();
  93
  94
  95     // Member Functions
  96
  97         // Access
  98
  99             //- Return true if interface is coupled
 100             virtual bool coupled() const
 101             {
 102                 return true;
 103             }
 104
 105
 106         // Interface transfer functions
 107
 108             //- Initialise interface data transfer
 109             virtual void initTransfer
 110             (
 111                 const Pstream::commsTypes commsType,
 112                 const unallocLabelList& interfaceData
 113             ) const;
 114
 115             //- Transfer and return neighbour field
 116             virtual tmp<labelField> transfer
 117             (
 118                 const Pstream::commsTypes commsType,
 119                 const unallocLabelList& interfaceData
 120             ) const;
 121
 122             //- Initialise neighbour field transfer
 123             virtual void initInternalFieldTransfer
 124             (
 125                 const Pstream::commsTypes commsType,
 126                 const unallocLabelList& iF
 127             ) const;
 128
 129             //- Transfer and return internal field adjacent to the interface
 130             virtual tmp<labelField> internalFieldTransfer
 131             (
 132                 const Pstream::commsTypes commsType,
 133                 const unallocLabelList& iF
 134             ) const;
 135
 136
 137         //- Processor interface functions
 138
 139             //- Return processor number
 140             virtual int myProcNo() const
 141             {
 142                 return fineProcInterface_.myProcNo();
 143             }
 144
 145             //- Return neigbour processor number
 146             virtual int neighbProcNo() const
 147             {
 148                 return fineProcInterface_.neighbProcNo();
 149             }
 150
 151             //- Return face transformation tensor
 152             virtual const tensorField& forwardT() const
 153             {
 154                 return fineProcInterface_.forwardT();
 155             }
 156 };
 157
 158
 159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 160
 161 } // End namespace Foam
 162
 163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 164
 165 #endif
 166
 167 // ************************************************************************* //