src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/interfaceFields/cyclicGAMGInterfaceField/cyclicGAMGInterfaceField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 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     Foam::cyclicGAMGInterfaceField
  27
  28 Description
  29     GAMG agglomerated cyclic interface field.
  30
  31 SourceFiles
  32     cyclicGAMGInterfaceField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef cyclicGAMGInterfaceField_H
  37 #define cyclicGAMGInterfaceField_H
  38
  39 #include "GAMGInterfaceField.H"
  40 #include "cyclicGAMGInterface.H"
  41 #include "cyclicLduInterfaceField.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                   Class cyclicGAMGInterfaceField Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class cyclicGAMGInterfaceField
  53 :
  54     public GAMGInterfaceField,
  55     virtual public cyclicLduInterfaceField
  56 {
  57     // Private data
  58
  59         //- Local reference cast into the cyclic interface
  60         const cyclicGAMGInterface& cyclicInterface_;
  61
  62         //- Is the transform required
  63         bool doTransform_;
  64
  65         //- Rank of component for transformation
  66         int rank_;
  67
  68
  69     // Private Member Functions
  70
  71         //- Disallow default bitwise copy construct
  72         cyclicGAMGInterfaceField(const cyclicGAMGInterfaceField&);
  73
  74         //- Disallow default bitwise assignment
  75         void operator=(const cyclicGAMGInterfaceField&);
  76
  77
  78 public:
  79
  80     //- Runtime type information
  81     TypeName("cyclic");
  82
  83
  84     // Constructors
  85
  86         //- Construct from GAMG interface and fine level interface field
  87         cyclicGAMGInterfaceField
  88         (
  89             const GAMGInterface& GAMGCp,
  90             const lduInterfaceField& fineInterfaceField
  91         );
  92
  93
  94     // Destructor
  95
  96         virtual ~cyclicGAMGInterfaceField();
  97
  98
  99     // Member Functions
 100
 101         // Access
 102
 103             //- Return size
 104             label size() const
 105             {
 106                 return cyclicInterface_.size();
 107             }
 108
 109
 110         // Interface matrix update
 111
 112             //- Update result field based on interface functionality
 113             virtual void updateInterfaceMatrix
 114             (
 115                 const scalarField& psiInternal,
 116                 scalarField& result,
 117                 const lduMatrix&,
 118                 const scalarField& coeffs,
 119                 const direction cmpt,
 120                 const Pstream::commsTypes commsType
 121             ) const;
 122
 123
 124         //- Cyclic interface functions
 125
 126             //- Does the interface field perform the transfromation
 127             virtual bool doTransform() const
 128             {
 129                 return doTransform_;
 130             }
 131
 132             //- Return face transformation tensor
 133             virtual const tensorField& forwardT() const
 134             {
 135                 return cyclicInterface_.forwardT();
 136             }
 137
 138             //- Return neighbour-cell transformation tensor
 139             virtual const tensorField& reverseT() const
 140             {
 141                 return cyclicInterface_.reverseT();
 142             }
 143
 144             //- Return rank of component for transform
 145             virtual int rank() const
 146             {
 147                 return rank_;
 148             }
 149 };
 150
 151
 152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 153
 154 } // End namespace Foam
 155
 156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 157
 158 #endif
 159
 160 // ************************************************************************* //