src/finiteVolume/fields/fvsPatchFields/constraint/regionCouple/regionCoupleFvsPatchField.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     regionCoupleFvsPatchField
  27
  28 Description
  29     Region couple patch field
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  33
  34 SourceFiles
  35     regionCoupleFvsPatchField.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef regionCoupleFvsPatchField_H
  40 #define regionCoupleFvsPatchField_H
  41
  42 #include "coupledFvsPatchField.H"
  43 #include "regionCoupleLduInterfaceField.H"
  44 #include "regionCoupleFvPatch.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                  Class regionCoupleFvsPatchField Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class Type>
  56 class regionCoupleFvsPatchField
  57 :
  58     public coupledFvsPatchField<Type>
  59 {
  60     // Private data
  61
  62         //- Local reference cast into the regionCouple patch
  63         const regionCoupleFvPatch& regionCouplePatch_;
  64
  65         //- Name of remote field to couple to
  66         word remoteFieldName_;
  67
  68         //- Matrix update buffer
  69         mutable scalarField matrixUpdateBuffer_;
  70
  71
  72 protected:
  73
  74         //- Return contents of a matrix update buffer
  75         const scalarField& matrixUpdateBuffer() const
  76         {
  77             return matrixUpdateBuffer_;
  78         }
  79
  80
  81 public:
  82
  83     //- Runtime type information
  84 //     TypeName(regionCoupleFvPatch::typeName_());
  85     TypeName("regionCoupling");
  86
  87
  88     // Constructors
  89
  90         //- Construct from patch and internal field
  91         regionCoupleFvsPatchField
  92         (
  93             const fvPatch&,
  94             const DimensionedField<Type, surfaceMesh>&
  95         );
  96
  97         //- Construct from patch, internal field and dictionary
  98         regionCoupleFvsPatchField
  99         (
 100             const fvPatch&,
 101             const DimensionedField<Type, surfaceMesh>&,
 102             const dictionary&
 103         );
 104
 105         //- Construct by mapping given regionCoupleFvsPatchField
 106         //  onto a new patch
 107         regionCoupleFvsPatchField
 108         (
 109             const regionCoupleFvsPatchField<Type>&,
 110             const fvPatch&,
 111             const DimensionedField<Type, surfaceMesh>&,
 112             const fvPatchFieldMapper&
 113         );
 114
 115         //- Construct as copy setting internal field reference
 116         regionCoupleFvsPatchField
 117         (
 118             const regionCoupleFvsPatchField<Type>&,
 119             const DimensionedField<Type, surfaceMesh>&
 120         );
 121
 122         //- Construct and return a clone
 123         virtual tmp<fvsPatchField<Type> > clone() const
 124         {
 125             return tmp<fvsPatchField<Type> >
 126             (
 127                 new regionCoupleFvsPatchField<Type>(*this)
 128             );
 129         }
 130
 131         //- Construct and return a clone setting internal field reference
 132         virtual tmp<fvsPatchField<Type> > clone
 133         (
 134             const DimensionedField<Type, surfaceMesh>& iF
 135         ) const
 136         {
 137             return tmp<fvsPatchField<Type> >
 138             (
 139                 new regionCoupleFvsPatchField<Type>(*this, iF)
 140             );
 141         }
 142
 143
 144     // Member functions
 145
 146         // Evaluation functions
 147
 148             //- Return remote field name
 149             const word& remoteFieldName() const
 150             {
 151                 return remoteFieldName_;
 152             }
 153
 154             //- Return shadow patch field
 155             const regionCoupleFvsPatchField<Type>& shadowPatchField() const;
 156
 157
 158         //- Write
 159         virtual void write(Ostream&) const;
 160
 161 };
 162
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 } // End namespace Foam
 167
 168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 169
 170 #ifdef NoRepository
 171 #   include "regionCoupleFvsPatchField.C"
 172 #endif
 173
 174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 175
 176 #endif
 177
 178 // ************************************************************************* //