src/OpenFOAM/matrices/lduMatrix/lduAddressing/lduInterfaceFields/ggiLduInterfaceField/ggiLduInterfaceField.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     ggiLduInterfaceField
  27
  28 Description
  29     Abstract base class for ggi coupled interface fields.
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  33
  34 SourceFiles
  35     ggiLduInterfaceField.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef ggiLduInterfaceField_H
  40 #define ggiLduInterfaceField_H
  41
  42 #include "primitiveFieldsFwd.H"
  43 #include "typeInfo.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                   Class ggiLduInterfaceField Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class ggiLduInterfaceField
  55 {
  56
  57 public:
  58
  59     //- Runtime type information
  60     TypeName("ggiLduInterfaceField");
  61
  62
  63     // Constructors
  64
  65         //- Construct given coupled patch
  66         ggiLduInterfaceField()
  67         {}
  68
  69
  70     // Destructor
  71
  72         virtual ~ggiLduInterfaceField();
  73
  74
  75     // Member Functions
  76
  77         // Access
  78
  79             //- Is the transform required
  80             virtual bool doTransform() const = 0;
  81
  82             //- Return face transformation tensor
  83             virtual const tensorField& forwardT() const = 0;
  84
  85             //- Return neighbour-cell transformation tensor
  86             virtual const tensorField& reverseT() const = 0;
  87
  88             //- Return rank of component for transform
  89             virtual int rank() const = 0;
  90
  91
  92         //- Transform given patch internal field
  93         void transformCoupleField
  94         (
  95             scalarField& psiInternal,
  96             const direction cmpt
  97         ) const;
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //