diffusion.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) 2012-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::diffusion
26 
27 Description
28  Simple diffusion-based combustion model based on the principle mixed is
29  burnt. Additional parameter C is used to distribute the heat release rate
30  in time.
31 
32 SourceFiles
33  diffusion.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef diffusion_H
38 #define diffusion_H
39 
40 #include "singleStepCombustion.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace combustionModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class diffusion Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 template<class CombThermoType, class ThermoType>
54 class diffusion
55 :
56  public singleStepCombustion<CombThermoType, ThermoType>
57 {
58  // Private data
59 
60  //- Model constant
61  scalar C_;
62 
63  //- Name of oxidant - default is "O2"
64  word oxidantName_;
65 
66 
67  // Private Member Functions
68 
69  //- Disallow copy construct
70  diffusion(const diffusion&);
71 
72  //- Disallow default bitwise assignment
73  void operator=(const diffusion&);
74 
75 
76 public:
77 
78  //- Runtime type information
79  TypeName("diffusion");
80 
81 
82  // Constructors
83 
84  //- Construct from components
85  diffusion
86  (
87  const word& modelType,
88  const fvMesh& mesh,
89  const word& phaseName
90  );
91 
92 
93  //- Destructor
94  virtual ~diffusion();
95 
96 
97  // Member Functions
98 
99  // Evolution
100 
101  //- Correct combustion rate
102  virtual void correct();
103 
104 
105  // IO
106 
107  //- Update properties
108  virtual bool read();
109 };
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 } // End namespace combustionModels
115 } // End namespace Foam
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #ifdef NoRepository
121  #include "diffusion.C"
122 #endif
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************************************************************* //
virtual void correct()
Correct combustion rate.
Definition: diffusion.C:65
virtual bool read()
Update properties.
Definition: diffusion.C:94
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
TypeName("diffusion")
Runtime type information.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual ~diffusion()
Destructor.
Definition: diffusion.C:58
Base class for combustion models using singleStepReactingMixture.
Simple diffusion-based combustion model based on the principle mixed is burnt. Additional parameter C...
Definition: diffusion.H:53
Namespace for OpenFOAM.