src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  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::transformFvPatchField
  26
  27 Description
  28     Foam::transformFvPatchField
  29
  30 SourceFiles
  31     transformFvPatchField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef transformFvPatchField_H
  36 #define transformFvPatchField_H
  37
  38 #include "fvPatchField.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                         Class transformFvPatch Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class Type>
  50 class transformFvPatchField
  51 :
  52     public fvPatchField<Type>
  53 {
  54
  55 public:
  56
  57     //- Runtime type information
  58     TypeName("transform");
  59
  60
  61     // Constructors
  62
  63         //- Construct from patch and internal field
  64         transformFvPatchField
  65         (
  66             const fvPatch&,
  67             const DimensionedField<Type, volMesh>&
  68         );
  69
  70         //- Construct from patch, internal field and dictionary
  71         transformFvPatchField
  72         (
  73             const fvPatch&,
  74             const DimensionedField<Type, volMesh>&,
  75             const dictionary&
  76         );
  77
  78         //- Construct by mapping the given transformFvPatchField<Type>
  79         //  onto a new patch
  80         transformFvPatchField
  81         (
  82             const transformFvPatchField<Type>&,
  83             const fvPatch&,
  84             const DimensionedField<Type, volMesh>&,
  85             const fvPatchFieldMapper&
  86         );
  87
  88         //- Construct as copy
  89         transformFvPatchField
  90         (
  91             const transformFvPatchField<Type>&
  92         );
  93
  94         //- Construct and return a clone
  95         virtual tmp<fvPatchField<Type> > clone() const = 0;
  96
  97         //- Construct as copy setting internal field reference
  98         transformFvPatchField
  99         (
 100             const transformFvPatchField<Type>&,
 101             const DimensionedField<Type, volMesh>&
 102         );
 103
 104         //- Construct and return a clone setting internal field reference
 105         virtual tmp<fvPatchField<Type> > clone
 106         (
 107             const DimensionedField<Type, volMesh>&
 108         ) const = 0;
 109
 110
 111     // Member functions
 112
 113         // Evaluation functions
 114
 115             //- Return gradient at boundary
 116             virtual tmp<Field<Type> > snGrad() const = 0;
 117
 118             //- Return face-gradient transform diagonal
 119             virtual tmp<Field<Type> > snGradTransformDiag() const = 0;
 120
 121             //- Return the matrix diagonal coefficients corresponding to the
 122             //  evaluation of the value of this patchField with given weights
 123             virtual tmp<Field<Type> > valueInternalCoeffs
 124             (
 125                 const tmp<scalarField>&
 126             ) const;
 127
 128             //- Return the matrix source coefficients corresponding to the
 129             //  evaluation of the value of this patchField with given weights
 130             virtual tmp<Field<Type> > valueBoundaryCoeffs
 131             (
 132                 const tmp<scalarField>&
 133             ) const;
 134
 135             //- Return the matrix diagonal coefficients corresponding to the
 136             //  evaluation of the gradient of this patchField
 137             virtual tmp<Field<Type> > gradientInternalCoeffs() const;
 138
 139             //- Return the matrix source coefficients corresponding to the
 140             //  evaluation of the gradient of this patchField
 141             virtual tmp<Field<Type> > gradientBoundaryCoeffs() const;
 142
 143
 144     // Member operators
 145
 146         virtual void operator=(const fvPatchField<Type>&);
 147 };
 148
 149
 150 // * * * * * * * * * * * Template Specialisations  * * * * * * * * * * * * * //
 151
 152 template<>
 153 tmp<scalarField > transformFvPatchField<scalar>::gradientInternalCoeffs() const;
 154
 155
 156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 157
 158 } // End namespace Foam
 159
 160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 161
 162 #ifdef NoRepository
 163 #   include "transformFvPatchField.C"
 164 #endif
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 #endif
 169
 170 // ************************************************************************* //