Initial release of the new fireFoam solver and ancillary libraries.
[OpenFOAM-1.6.x.git] / applications / solvers / combustion / fireFoam / combustionModels / infinitelyFastChemistry / infinitelyFastChemistry.H
blob4c62e5fa03d7f12d090a202a2fef4fbcbe81e45d
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.
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.
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, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::combustionModels::infinitelyFastChemistry
28 Description
29     Simple infinitely fast chemistry combustion model based on the principle
30     mixed is burnt. Additional parameter C is used to distribute the heat
31     release rate.in time
33 SourceFiles
34     infinitelyFastChemistry.C
36 \*---------------------------------------------------------------------------*/
38 #ifndef infinitelyFastChemistry_H
39 #define infinitelyFastChemistry_H
41 #include "fvc.H"
42 #include "combustionModel.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 namespace Foam
48 namespace combustionModels
51 /*---------------------------------------------------------------------------*\
52                 Class infinitelyFastChemistry Declaration
53 \*---------------------------------------------------------------------------*/
55 class infinitelyFastChemistry
57     public combustionModel
59     // Private data
61         //- Model constant
62         scalar C_;
64     // Private Member Functions
66         //- Disallow copy construct
67         infinitelyFastChemistry(const infinitelyFastChemistry&);
69         //- Disallow default bitwise assignment
70         void operator=(const infinitelyFastChemistry&);
73 public:
75     //- Runtime type information
76     TypeName("infinitelyFastChemistry");
79     // Constructors
81         //- Construct from components
82         infinitelyFastChemistry
83         (
84             const dictionary& combustionProperties,
85             const hsCombustionThermo& thermo,
86             const compressible::turbulenceModel& turbulence,
87             const surfaceScalarField& phi,
88             const volScalarField& rho
89         );
92     // Destructor
94         virtual ~infinitelyFastChemistry();
97     // Member Functions
99         //- Update properties from given dictionary
100         virtual bool read(const dictionary& combustionProperties);
102         //- Correct combustion rate
103         virtual void correct();
105         //- Return normalised consumption rate of (fu - fres)
106         virtual tmp<volScalarField> wFuelNorm() const;
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 } // End namespace combustionModels
113 } // End namespace Foam
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 #endif
119 // ************************************************************************* //