laminar.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2013-2016 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::combustionModels::laminar
26 
27 Description
28  Laminar combustion model.
29 
30 SourceFiles
31  laminar.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef laminar_H
36 #define laminar_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 namespace combustionModels
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class laminar Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class Type>
50 class laminar
51 :
52  public Type
53 {
54  // Private data
55 
56  //- Integrate reaction rate over the time-step
57  // using the selected ODE solver
58  bool integrateReactionRate_;
59 
60 protected:
61 
62  // Protected Member Functions
63 
64  //- Return the chemical time scale
65  tmp<volScalarField> tc() const;
66 
67 private:
68 
69  // Private Member Functions
70 
71  //- Disallow copy construct
72  laminar(const laminar&);
73 
74  //- Disallow default bitwise assignment
75  void operator=(const laminar&);
76 
77 
78 public:
79 
80  //- Runtime type information
81  TypeName("laminar");
82 
83 
84  // Constructors
85 
86  //- Construct from components
87  laminar
88  (
89  const word& modelType,
90  const fvMesh& mesh,
91  const word& phaseName
92  );
93 
94 
95  //- Destructor
96  virtual ~laminar();
97 
98 
99  // Member Functions
100 
101  // Evolution
102 
103  //- Correct combustion rate
104  virtual void correct();
105 
106  //- Fuel consumption rate matrix.
107  virtual tmp<fvScalarMatrix> R(volScalarField& Y) const;
108 
109  //- Heat release rate calculated from fuel consumption rate matrix
110  virtual tmp<volScalarField> dQ() const;
111 
112  //- Return source for enthalpy equation [kg/m/s3]
113  virtual tmp<volScalarField> Sh() const;
114 
115 
116  // IO
117 
118  //- Update properties from given dictionary
119  virtual bool read();
120 };
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 } // End namespace combustionModels
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #ifdef NoRepository
131  #include "laminar.C"
132 #endif
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************************************************************* //
virtual void correct()
Correct combustion rate.
Definition: laminar.C:75
virtual tmp< volScalarField > dQ() const
Heat release rate calculated from fuel consumption rate matrix.
Definition: laminar.C:138
virtual tmp< volScalarField > Sh() const
Return source for enthalpy equation [kg/m/s3].
Definition: laminar.C:169
virtual tmp< fvScalarMatrix > R(volScalarField &Y) const
Fuel consumption rate matrix.
Definition: laminar.C:118
Laminar combustion model.
Definition: laminar.H:49
dynamicFvMesh & mesh
tmp< volScalarField > tc() const
Return the chemical time scale.
Definition: laminar.C:68
A class for handling words, derived from string.
Definition: word.H:59
virtual ~laminar()
Destructor.
Definition: laminar.C:60
PtrList< volScalarField > & Y
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
A class for managing temporary objects.
Definition: PtrList.H:54
TypeName("laminar")
Runtime type information.
Namespace for OpenFOAM.
virtual bool read()
Update properties from given dictionary.
Definition: laminar.C:199