ode.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::ode
28 
29 Description
30  An ODE solver for chemistry
31 
32 SourceFiles
33  ode.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef ode_H
38 #define ode_H
39 
40 #include "chemistrySolver.H"
41 #include "ODESolver.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class ode Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class ChemistryModel>
53 class ode
54 :
55  public chemistrySolver<ChemistryModel>
56 {
57  // Private data
58 
59  dictionary coeffsDict_;
60 
61  mutable autoPtr<ODESolver> odeSolver_;
62 
63  // Solver data
64  mutable scalarField cTp_;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("ode");
71 
72 
73  // Constructors
74 
75  //- Construct from thermo
76  ode(typename ChemistryModel::reactionThermo& thermo);
77 
78 
79  //- Destructor
80  virtual ~ode();
81 
82 
83  // Member Functions
84 
85  //- Update the concentrations and return the chemical time
86  virtual void solve
87  (
88  scalarField& c,
89  scalar& T,
90  scalar& p,
91  scalar& deltaT,
92  scalar& subDeltaT
93  ) const;
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #ifdef NoRepository
104  #include "ode.C"
105 #endif
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::chemistrySolver
An abstract base class for solving chemistry.
Definition: chemistrySolver.H:52
thermo
Basic thermodynamics type based on the use of fitting functions for cp, h, s obtained from the templa...
Foam::ode::~ode
virtual ~ode()
Destructor.
Definition: ode.C:45
ode.C
Foam::Field< scalar >
Foam::T
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
Definition: FieldFieldFunctions.C:58
Foam::ode
An ODE solver for chemistry.
Definition: ode.H:52
chemistrySolver.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
ODESolver.H
Foam::ode::TypeName
TypeName("ode")
Runtime type information.
Foam::ode::ode
ode(typename ChemistryModel::reactionThermo &thermo)
Construct from thermo.
Definition: ode.C:33
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::ode::solve
virtual void solve(scalarField &c, scalar &T, scalar &p, scalar &deltaT, scalar &subDeltaT) const
Update the concentrations and return the chemical time.
Definition: ode.C:53
Foam::constant::universal::c
const dimensionedScalar c
Speed of light in a vacuum.