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