src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.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::wedgeFvPatchField
  27
  28 Description
  29     Foam::wedgeFvPatchField
  30
  31 SourceFiles
  32     wedgeFvPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef wedgeFvPatchField_H
  37 #define wedgeFvPatchField_H
  38
  39 #include "transformFvPatchField.H"
  40 #include "wedgeFvPatch.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                          Class wedgeFvPatch Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class wedgeFvPatchField
  53 :
  54     public transformFvPatchField<Type>
  55 {
  56
  57 public:
  58
  59     //- Runtime type information
  60     TypeName(wedgeFvPatch::typeName_());
  61
  62
  63     // Constructors
  64
  65         //- Construct from patch and internal field
  66         wedgeFvPatchField
  67         (
  68             const fvPatch&,
  69             const DimensionedField<Type, volMesh>&
  70         );
  71
  72         //- Construct from patch, internal field and dictionary
  73         wedgeFvPatchField
  74         (
  75             const fvPatch&,
  76             const DimensionedField<Type, volMesh>&,
  77             const dictionary&
  78         );
  79
  80         //- Construct by mapping given wedgeFvPatchField onto a new patch
  81         wedgeFvPatchField
  82         (
  83             const wedgeFvPatchField<Type>&,
  84             const fvPatch&,
  85             const DimensionedField<Type, volMesh>&,
  86             const fvPatchFieldMapper&
  87         );
  88
  89         //- Construct as copy
  90         wedgeFvPatchField
  91         (
  92             const wedgeFvPatchField<Type>&
  93         );
  94
  95         //- Construct and return a clone
  96         virtual tmp<fvPatchField<Type> > clone() const
  97         {
  98             return tmp<fvPatchField<Type> >
  99             (
 100                 new wedgeFvPatchField<Type>(*this)
 101             );
 102         }
 103
 104         //- Construct as copy setting internal field reference
 105         wedgeFvPatchField
 106         (
 107             const wedgeFvPatchField<Type>&,
 108             const DimensionedField<Type, volMesh>&
 109         );
 110
 111         //- Construct and return a clone setting internal field reference
 112         virtual tmp<fvPatchField<Type> > clone
 113         (
 114             const DimensionedField<Type, volMesh>& iF
 115         ) const
 116         {
 117             return tmp<fvPatchField<Type> >
 118             (
 119                 new wedgeFvPatchField<Type>(*this, iF)
 120             );
 121         }
 122
 123
 124     // Member functions
 125
 126         // Evaluation functions
 127
 128             //- Return gradient at boundary
 129             virtual tmp<Field<Type> > snGrad() const;
 130
 131             //- Evaluate the patch field
 132             virtual void evaluate
 133             (
 134                 const Pstream::commsTypes commsType=Pstream::blocking
 135             );
 136
 137             //- Return face-gradient transform diagonal
 138             virtual tmp<Field<Type> > snGradTransformDiag() const;
 139 };
 140
 141
 142 // * * * * * * * * * * * Template Specialisations  * * * * * * * * * * * * * //
 143
 144 template<>
 145 tmp<scalarField > wedgeFvPatchField<scalar>::snGrad() const;
 146
 147 template<>
 148 void wedgeFvPatchField<scalar>::evaluate
 149 (
 150     const Pstream::commsTypes commsType
 151 );
 152
 153
 154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 155
 156 } // End namespace Foam
 157
 158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 159
 160 #ifdef NoRepository
 161 #   include "wedgeFvPatchField.C"
 162 #endif
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 #endif
 167
 168 // ************************************************************************* //