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