src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnthalpy/gradientEnthalpyFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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::gradientEnthalpyFvPatchScalarField
  26
  27 Description
  28     Gradient boundary condition for enthalpy
  29
  30 SourceFiles
  31     gradientEnthalpyFvPatchScalarField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef gradientEnthalpyFvPatchScalarField_H
  36 #define gradientEnthalpyFvPatchScalarField_H
  37
  38 #include "fixedGradientFvPatchFields.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46              Class gradientEnthalpyFvPatchScalarField Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class gradientEnthalpyFvPatchScalarField
  50 :
  51     public fixedGradientFvPatchScalarField
  52 {
  53
  54 public:
  55
  56     //- Runtime type information
  57     TypeName("gradientEnthalpy");
  58
  59
  60     // Constructors
  61
  62         //- Construct from patch and internal field
  63         gradientEnthalpyFvPatchScalarField
  64         (
  65             const fvPatch&,
  66             const DimensionedField<scalar, volMesh>&
  67         );
  68
  69         //- Construct from patch, internal field and dictionary
  70         gradientEnthalpyFvPatchScalarField
  71         (
  72             const fvPatch&,
  73             const DimensionedField<scalar, volMesh>&,
  74             const dictionary&
  75         );
  76
  77         //- Construct by mapping given gradientEnthalpyFvPatchScalarField
  78         // onto a new patch
  79         gradientEnthalpyFvPatchScalarField
  80         (
  81             const gradientEnthalpyFvPatchScalarField&,
  82             const fvPatch&,
  83             const DimensionedField<scalar, volMesh>&,
  84             const fvPatchFieldMapper&
  85         );
  86
  87         //- Construct as copy
  88         gradientEnthalpyFvPatchScalarField
  89         (
  90             const gradientEnthalpyFvPatchScalarField&
  91         );
  92
  93         //- Construct and return a clone
  94         virtual tmp<fvPatchScalarField> clone() const
  95         {
  96             return tmp<fvPatchScalarField>
  97             (
  98                 new gradientEnthalpyFvPatchScalarField(*this)
  99             );
 100         }
 101
 102         //- Construct as copy setting internal field reference
 103         gradientEnthalpyFvPatchScalarField
 104         (
 105             const gradientEnthalpyFvPatchScalarField&,
 106             const DimensionedField<scalar, volMesh>&
 107         );
 108
 109         //- Construct and return a clone setting internal field reference
 110         virtual tmp<fvPatchScalarField> clone
 111         (
 112             const DimensionedField<scalar, volMesh>& iF
 113         ) const
 114         {
 115             return tmp<fvPatchScalarField>
 116             (
 117                 new gradientEnthalpyFvPatchScalarField(*this, iF)
 118             );
 119         }
 120
 121
 122     // Member functions
 123
 124         // Evaluation functions
 125
 126             //- Update the coefficients associated with the patch field
 127             virtual void updateCoeffs();
 128 };
 129
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 } // End namespace Foam
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 #endif
 138
 139 // ************************************************************************* //