Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / thermophysicalModels / reactionThermo / derivedFvPatchFields / mixedUnburntEnthalpy / mixedUnburntEnthalpyFvPatchScalarField.H
blobc5dcb4b7ac4c59516059a1a4be6654250635ec20
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.
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.
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.
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/>.
24 Class
25     Foam::mixedUnburntEnthalpyFvPatchScalarField
27 Description
28     Mixed boundary condition for unburnt
30 SourceFiles
31     mixedUnburntEnthalpyFvPatchScalarField.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef mixedUnburntEnthalpyFvPatchScalarField_H
36 #define mixedUnburntEnthalpyFvPatchScalarField_H
38 #include "mixedFvPatchFields.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46            Class mixedUnburntEnthalpyFvPatchScalarField Declaration
47 \*---------------------------------------------------------------------------*/
49 class mixedUnburntEnthalpyFvPatchScalarField
51     public mixedFvPatchScalarField
54 public:
56     //- Runtime type information
57     TypeName("mixedUnburntEnthalpy");
60     // Constructors
62         //- Construct from patch and internal field
63         mixedUnburntEnthalpyFvPatchScalarField
64         (
65             const fvPatch&,
66             const DimensionedField<scalar, volMesh>&
67         );
69         //- Construct from patch, internal field and dictionary
70         mixedUnburntEnthalpyFvPatchScalarField
71         (
72             const fvPatch&,
73             const DimensionedField<scalar, volMesh>&,
74             const dictionary&
75         );
77         //- Construct by mapping given mixedUnburntEnthalpyFvPatchScalarField
78         // onto a new patch
79         mixedUnburntEnthalpyFvPatchScalarField
80         (
81             const mixedUnburntEnthalpyFvPatchScalarField&,
82             const fvPatch&,
83             const DimensionedField<scalar, volMesh>&,
84             const fvPatchFieldMapper&
85         );
87         //- Construct as copy
88         mixedUnburntEnthalpyFvPatchScalarField
89         (
90             const mixedUnburntEnthalpyFvPatchScalarField&
91         );
93         //- Construct and return a clone
94         virtual tmp<fvPatchScalarField> clone() const
95         {
96             return tmp<fvPatchScalarField>
97             (
98                 new mixedUnburntEnthalpyFvPatchScalarField(*this)
99             );
100         }
102         //- Construct as copy setting internal field reference
103         mixedUnburntEnthalpyFvPatchScalarField
104         (
105             const mixedUnburntEnthalpyFvPatchScalarField&,
106             const DimensionedField<scalar, volMesh>&
107         );
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 mixedUnburntEnthalpyFvPatchScalarField(*this, iF)
118             );
119         }
122     // Member functions
124         // Evaluation functions
126             //- Update the coefficients associated with the patch field
127             virtual void updateCoeffs();
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 } // End namespace Foam
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 #endif
139 // ************************************************************************* //