src/thermophysicalModels/reactionThermo/derivedFvPatchFields/fixedUnburntEnthalpy/fixedUnburntEnthalpyFvPatchScalarField.H

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