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) 1991-2009 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::lduInterfaceField
  27
  28 Description
  29     An abstract base class for implicitly-coupled interface fields
  30     e.g. processor and cyclic patch fields.
  31
  32 SourceFiles
  33     lduInterfaceField.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef lduInterfaceField_H
  38 #define lduInterfaceField_H
  39
  40 #include "lduInterface.H"
  41 #include "primitiveFieldsFwd.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
  90         virtual ~lduInterfaceField();
  91
  92
  93     // Member Functions
  94
  95         // Access
  96
  97             //- Return the interface
  98             const lduInterface& interface() const
  99             {
 100                 return interface_;
 101             }
 102
 103             //- Return the interface type
 104             virtual const word& interfaceFieldType() const
 105             {
 106                 return type();
 107             }
 108
 109
 110         // Coupled interface matrix update
 111
 112             //- Initialise neighbour matrix update
 113             virtual void initInterfaceMatrixUpdate
 114             (
 115                 const scalarField&,
 116                 scalarField&,
 117                 const lduMatrix&,
 118                 const scalarField&,
 119                 const direction,
 120                 const Pstream::commsTypes commsType
 121             ) const
 122             {}
 123
 124             //- Update result field based on interface functionality
 125             virtual void updateInterfaceMatrix
 126             (
 127                 const scalarField&,
 128                 scalarField&,
 129                 const lduMatrix&,
 130                 const scalarField&,
 131                 const direction,
 132                 const Pstream::commsTypes commsType
 133             ) const = 0;
 134 };
 135
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 } // End namespace Foam
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 #endif
 144
 145 // ************************************************************************* //