mirror of
https://github.com/OpenFOAM/OpenFOAM-6.git
synced 2025-12-08 06:57:46 +00:00
Reactions: Improved documentation for member functions
This commit is contained in:
@ -216,6 +216,15 @@ public:
|
||||
const speciesTable& species
|
||||
) const = 0;
|
||||
|
||||
//- Construct the left- and right-hand-side reaction coefficients
|
||||
void setLRhs
|
||||
(
|
||||
Istream&,
|
||||
const speciesTable&,
|
||||
List<specieCoeffs>& lhs,
|
||||
List<specieCoeffs>& rhs
|
||||
);
|
||||
|
||||
|
||||
// Selectors
|
||||
|
||||
@ -237,30 +246,24 @@ public:
|
||||
|
||||
// Access
|
||||
|
||||
inline word& name();
|
||||
//- Return the name of the reaction
|
||||
inline const word& name() const;
|
||||
|
||||
//- Return the lower temperature limit for the reaction
|
||||
inline scalar Tlow() const;
|
||||
|
||||
//- Return the upper temperature limit for the reaction
|
||||
inline scalar Thigh() const;
|
||||
|
||||
//- Access to the components of the left hand side
|
||||
//- Return the components of the left hand side
|
||||
inline const List<specieCoeffs>& lhs() const;
|
||||
|
||||
//- Access to the components of the right hand side
|
||||
//- Return the components of the right hand side
|
||||
inline const List<specieCoeffs>& rhs() const;
|
||||
|
||||
//- Access to specie list
|
||||
//- Return the specie list
|
||||
const speciesTable& species() const;
|
||||
|
||||
//- Construct the left- and right-hand-side reaction coefficients
|
||||
void setLRhs
|
||||
(
|
||||
Istream&,
|
||||
const speciesTable&,
|
||||
List<specieCoeffs>& lhs,
|
||||
List<specieCoeffs>& rhs
|
||||
);
|
||||
|
||||
|
||||
// Reaction rate coefficients
|
||||
|
||||
|
||||
@ -32,13 +32,6 @@ namespace Foam
|
||||
|
||||
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
||||
|
||||
template<class ReactionThermo>
|
||||
inline word& Reaction<ReactionThermo>::name()
|
||||
{
|
||||
return name_;
|
||||
}
|
||||
|
||||
|
||||
template<class ReactionThermo>
|
||||
inline const word& Reaction<ReactionThermo>::name() const
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user