src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.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::coupledFvPatchField
  27
  28 Description
  29     Foam::coupledFvPatchField
  30
  31 SourceFiles
  32     coupledFvPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef coupledFvPatchField_H
  37 #define coupledFvPatchField_H
  38
  39 #include "lduInterfaceField.H"
  40 #include "fvPatchField.H"
  41 #include "coupledFvPatch.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class coupledFvPatch Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 template<class Type>
  53 class coupledFvPatchField
  54 :
  55     public lduInterfaceField,
  56     public fvPatchField<Type>
  57 {
  58
  59 public:
  60
  61     //- Runtime type information
  62     TypeName(coupledFvPatch::typeName_());
  63
  64
  65     // Constructors
  66
  67         //- Construct from patch and internal field
  68         coupledFvPatchField
  69         (
  70             const fvPatch&,
  71             const DimensionedField<Type, volMesh>&
  72         );
  73
  74         //- Construct from patch and internal field and patch field
  75         coupledFvPatchField
  76         (
  77             const fvPatch&,
  78             const DimensionedField<Type, volMesh>&,
  79             const Field<Type>&
  80         );
  81
  82         //- Construct from patch, internal field and dictionary
  83         coupledFvPatchField
  84         (
  85             const fvPatch&,
  86             const DimensionedField<Type, volMesh>&,
  87             const dictionary&,
  88             const bool valueRequired = false
  89         );
  90
  91         //- Construct by mapping the given coupledFvPatchField onto a new patch
  92         coupledFvPatchField
  93         (
  94             const coupledFvPatchField<Type>&,
  95             const fvPatch&,
  96             const DimensionedField<Type, volMesh>&,
  97             const fvPatchFieldMapper&
  98         );
  99
 100         //- Construct as copy
 101         coupledFvPatchField
 102         (
 103             const coupledFvPatchField<Type>&
 104         );
 105
 106         //- Construct and return a clone
 107         virtual tmp<fvPatchField<Type> > clone() const = 0;
 108
 109         //- Construct as copy setting internal field reference
 110         coupledFvPatchField
 111         (
 112             const coupledFvPatchField<Type>&,
 113             const DimensionedField<Type, volMesh>&
 114         );
 115
 116         //- Construct and return a clone
 117         virtual tmp<fvPatchField<Type> > clone
 118         (
 119             const DimensionedField<Type, volMesh>&
 120         ) const = 0;
 121
 122
 123     // Member functions
 124
 125         // Access
 126
 127             //- Return true if this patch field is derived from
 128             //  coupledFvPatchField<Type>.
 129             virtual bool coupled() const
 130             {
 131                 return true;
 132             }
 133
 134             //- Return neighbour field of internal field
 135             virtual tmp<Field<Type> > patchNeighbourField() const = 0;
 136
 137
 138         // Evaluation functions
 139
 140             //- Return patch-normal gradient
 141             virtual tmp<Field<Type> > snGrad() const;
 142
 143             //- Initialise the evaluation of the patch field
 144             virtual void initEvaluate
 145             (
 146                 const Pstream::commsTypes commsType
 147             );
 148
 149             //- Evaluate the patch field
 150             virtual void evaluate
 151             (
 152                 const Pstream::commsTypes commsType
 153             );
 154
 155             //- Return the matrix diagonal coefficients corresponding to the
 156             //  evaluation of the value of this patchField with given weights
 157             virtual tmp<Field<Type> > valueInternalCoeffs
 158             (
 159                 const tmp<scalarField>&
 160             ) const;
 161
 162             //- Return the matrix source coefficients corresponding to the
 163             //  evaluation of the value of this patchField with given weights
 164             virtual tmp<Field<Type> > valueBoundaryCoeffs
 165             (
 166                 const tmp<scalarField>&
 167             ) const;
 168
 169             //- Return the matrix diagonal coefficients corresponding to the
 170             //  evaluation of the gradient of this patchField
 171             virtual tmp<Field<Type> > gradientInternalCoeffs() const;
 172
 173             //- Return the matrix source coefficients corresponding to the
 174             //  evaluation of the gradient of this patchField
 175             virtual tmp<Field<Type> > gradientBoundaryCoeffs() const;
 176
 177
 178         // Coupled interface functionality
 179
 180             //- Update result field based on interface functionality
 181             virtual void updateInterfaceMatrix
 182             (
 183                 const scalarField& psiInternal,
 184                 scalarField& result,
 185                 const lduMatrix&,
 186                 const scalarField& coeffs,
 187                 const direction,
 188                 const Pstream::commsTypes commsType
 189             ) const = 0;
 190
 191         //- Write
 192         virtual void write(Ostream&) const;
 193 };
 194
 195
 196 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 197
 198 } // End namespace Foam
 199
 200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 201
 202 #ifdef NoRepository
 203 #   include "coupledFvPatchField.C"
 204 #endif
 205
 206 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 207
 208 #endif
 209
 210 // ************************************************************************* //