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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::cyclicLduInterface
  27
  28 Description
  29     An abstract base class for cyclic coupled interfaces.
  30
  31 SourceFiles
  32     cyclicLduInterface.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef cyclicLduInterface_H
  37 #define cyclicLduInterface_H
  38
  39 #include "lduInterface.H"
  40 #include "primitiveFieldsFwd.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                   Class cyclicLduInterface Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class cyclicLduInterface
  52 {
  53
  54 public:
  55
  56     //- Runtime type information
  57     TypeName("cyclicLduInterface");
  58
  59     // Constructors
  60
  61     // Destructor
  62
  63         virtual ~cyclicLduInterface();
  64
  65
  66     // Member Functions
  67
  68         // Access
  69
  70             //- Return face transformation tensor
  71             virtual const tensorField& forwardT() const = 0;
  72
  73             //- Return face reverse transformation tensor
  74             virtual const tensorField& reverseT() const = 0;
  75 };
  76
  77
  78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  79
  80 } // End namespace Foam
  81
  82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  83
  84 #endif
  85
  86 // ************************************************************************* //