Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / thermophysicalModels / reactionThermo / derivedFvPatchFields / fixedUnburntEnthalpy / fixedUnburntEnthalpyFvPatchScalarField.H
blobfced0cba04a27546224c22285e1b8f19a1ce0d09
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend 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 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::fixedUnburntEnthalpyFvPatchScalarField
27 Description
28     Fixed boundary condition for unburnt
30 SourceFiles
31     fixedUnburntEnthalpyFvPatchScalarField.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef fixedUnburntEnthalpyFvPatchScalarField_H
36 #define fixedUnburntEnthalpyFvPatchScalarField_H
38 #include "fixedValueFvPatchFields.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46           Class fixedUnburntEnthalpyFvPatchScalarField Declaration
47 \*---------------------------------------------------------------------------*/
49 class fixedUnburntEnthalpyFvPatchScalarField
51     public fixedValueFvPatchScalarField
54 public:
56     //- Runtime type information
57     TypeName("fixedUnburntEnthalpy");
60     // Constructors
62         //- Construct from patch and internal field
63         fixedUnburntEnthalpyFvPatchScalarField
64         (
65             const fvPatch&,
66             const DimensionedField<scalar, volMesh>&
67         );
69         //- Construct from patch, internal field and dictionary
70         fixedUnburntEnthalpyFvPatchScalarField
71         (
72             const fvPatch&,
73             const DimensionedField<scalar, volMesh>&,
74             const dictionary&
75         );
77         //- Construct by mapping given fixedUnburntEnthalpyFvPatchScalarField
78         // onto a new patch
79         fixedUnburntEnthalpyFvPatchScalarField
80         (
81             const fixedUnburntEnthalpyFvPatchScalarField&,
82             const fvPatch&,
83             const DimensionedField<scalar, volMesh>&,
84             const fvPatchFieldMapper&
85         );
87         //- Construct as copy
88         fixedUnburntEnthalpyFvPatchScalarField
89         (
90             const fixedUnburntEnthalpyFvPatchScalarField&
91         );
93         //- Construct and return a clone
94         virtual tmp<fvPatchScalarField> clone() const
95         {
96             return tmp<fvPatchScalarField>
97             (
98                 new fixedUnburntEnthalpyFvPatchScalarField(*this)
99             );
100         }
102         //- Construct as copy setting internal field reference
103         fixedUnburntEnthalpyFvPatchScalarField
104         (
105             const fixedUnburntEnthalpyFvPatchScalarField&,
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 fixedUnburntEnthalpyFvPatchScalarField(*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 // ************************************************************************* //