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) 2004-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::cyclicLduInterface
  26
  27 Description
  28     An abstract base class for cyclic coupled interfaces.
  29
  30 SourceFiles
  31     cyclicLduInterface.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef cyclicLduInterface_H
  36 #define cyclicLduInterface_H
  37
  38 #include "lduInterface.H"
  39 #include "primitiveFieldsFwd.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                   Class cyclicLduInterface Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class cyclicLduInterface
  51 {
  52
  53 public:
  54
  55     //- Runtime type information
  56     TypeName("cyclicLduInterface");
  57
  58     // Constructors
  59
  60     //- Destructor
  61     virtual ~cyclicLduInterface();
  62
  63
  64     // Member Functions
  65
  66         // Access
  67
  68             //- Return neighbour
  69             virtual label neighbPatchID() const = 0;
  70
  71             virtual bool owner() const = 0;
  72
  73             //- Return processor number
  74             virtual const cyclicLduInterface& neighbPatch() const = 0;
  75
  76             //- Return face transformation tensor
  77             virtual const tensorField& forwardT() const = 0;
  78
  79             //- Return face reverse transformation tensor
  80             virtual const tensorField& reverseT() const = 0;
  81 };
  82
  83
  84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  85
  86 } // End namespace Foam
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 #endif
  91
  92 // ************************************************************************* //