thirdBodyEfficiencies.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2021 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::thirdBodyEfficiencies
26 
27 Description
28  Third body efficiencies
29 
30 SourceFiles
31  thirdBodyEfficienciesI.H
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef thirdBodyEfficiencies_H
36 #define thirdBodyEfficiencies_H
37 
38 #include "scalarField.H"
39 #include "speciesTable.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // Forward declaration of friend functions and operators
47 
48 class thirdBodyEfficiencies;
49 Ostream& operator<<(Ostream&, const thirdBodyEfficiencies&);
50 
51 
52 /*---------------------------------------------------------------------------*\
53  Class thirdBodyEfficiencies Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public scalarField
59 {
60  // Private Data
61 
62  const speciesTable& species_;
63 
64 
65 public:
66 
67  // Constructors
68 
69  //- Construct from components
71  (
72  const speciesTable& species,
73  const scalarList& efficiencies
74  );
75 
76  //- Construct from dictionary
78  (
79  const speciesTable& species,
80  const dictionary& dict
81  );
82 
83 
84  // Member Functions
85 
86  //- Calculate and return M, the concentration of the third-bodies
87  inline scalar M(const scalarField& c) const;
88 
89  //- Calculate and return the derivative of M, w.r.t. the species
90  // concentrations
91  inline tmp<scalarField> dMdc(const scalarField& c) const;
92 
93  //- Write to stream
94  inline void write(Ostream& os) const;
95 
96 
97 
98  // Ostream Operator
99 
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #include "thirdBodyEfficienciesI.H"
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #endif
115 
116 // ************************************************************************* //
dictionary dict
scalar M(const scalarField &c) const
Calculate and return M, the concentration of the third-bodies.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
tmp< scalarField > dMdc(const scalarField &c) const
Calculate and return the derivative of M, w.r.t. the species.
const dimensionedScalar c
Speed of light in a vacuum.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
thirdBodyEfficiencies(const speciesTable &species, const scalarList &efficiencies)
Construct from components.
friend Ostream & operator<<(Ostream &, const thirdBodyEfficiencies &)
A wordList with hashed indices for faster lookup by name.
Ostream & operator<<(Ostream &, const ensightPart &)
void write(Ostream &os) const
Write to stream.
A class for managing temporary objects.
Definition: PtrList.H:53
Third body efficiencies.
Namespace for OpenFOAM.