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