src/OpenFOAM/matrices/lduMatrix/lduAddressing/lduInterfaceFields/lduInterfaceField/lduInterfaceField.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::lduInterfaceField
  26
  27 Description
  28     An abstract base class for implicitly-coupled interface fields
  29     e.g. processor and cyclic patch fields.
  30
  31 SourceFiles
  32     lduInterfaceField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef lduInterfaceField_H
  37 #define lduInterfaceField_H
  38
  39 #include "lduInterface.H"
  40 #include "primitiveFieldsFwd.H"
  41 #include "Pstream.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 class lduMatrix;
  51
  52 /*---------------------------------------------------------------------------*\
  53                      Class lduInterfaceField Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class lduInterfaceField
  57 {
  58     // Private data
  59
  60         //- Reference to the coupled patch this field is defined for
  61         const lduInterface& interface_;
  62
  63
  64     // Private Member Functions
  65
  66         //- Disallow default bitwise copy construct
  67         lduInterfaceField(const lduInterfaceField&);
  68
  69         //- Disallow default bitwise assignment
  70         void operator=(const lduInterfaceField&);
  71
  72
  73 public:
  74
  75     //- Runtime type information
  76     TypeName("lduInterfaceField");
  77
  78
  79     // Constructors
  80
  81         //- Construct given coupled patch
  82         lduInterfaceField(const lduInterface& patch)
  83         :
  84             interface_(patch)
  85         {}
  86
  87
  88     //- Destructor
  89     virtual ~lduInterfaceField();
  90
  91
  92     // Member Functions
  93
  94         // Access
  95
  96             //- Return the interface
  97             const lduInterface& interface() const
  98             {
  99                 return interface_;
 100             }
 101
 102             //- Return the interface type
 103             virtual const word& interfaceFieldType() const
 104             {
 105                 return type();
 106             }
 107
 108
 109         // Coupled interface matrix update
 110
 111             //- Initialise neighbour matrix update
 112             virtual void initInterfaceMatrixUpdate
 113             (
 114                 const scalarField&,
 115                 scalarField&,
 116                 const lduMatrix&,
 117                 const scalarField&,
 118                 const direction,
 119                 const Pstream::commsTypes commsType
 120             ) const
 121             {}
 122
 123             //- Update result field based on interface functionality
 124             virtual void updateInterfaceMatrix
 125             (
 126                 const scalarField&,
 127                 scalarField&,
 128                 const lduMatrix&,
 129                 const scalarField&,
 130                 const direction,
 131                 const Pstream::commsTypes commsType
 132             ) const = 0;
 133 };
 134
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 } // End namespace Foam
 139
 140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 141
 142 #endif
 143
 144 // ************************************************************************* //