[Doc] Fix some Doxygen warnings
This commit is contained in:
parent
7438e791b5
commit
e09db92756
8 changed files with 10 additions and 18 deletions
|
|
@ -33,6 +33,8 @@ public:
|
||||||
//! @param start If true, the initial composition will be determined by a
|
//! @param start If true, the initial composition will be determined by a
|
||||||
//! linear Gibbs minimization, otherwise the initial mixture
|
//! linear Gibbs minimization, otherwise the initial mixture
|
||||||
//! composition will be used.
|
//! composition will be used.
|
||||||
|
//! @param loglevel Desired level of debug printing. loglevel = 0 suppresses
|
||||||
|
//! printing. Higher values request more verbose logging output.
|
||||||
MultiPhaseEquil(MultiPhase* mix, bool start=true, int loglevel = 0);
|
MultiPhaseEquil(MultiPhase* mix, bool start=true, int loglevel = 0);
|
||||||
|
|
||||||
virtual ~MultiPhaseEquil() {}
|
virtual ~MultiPhaseEquil() {}
|
||||||
|
|
|
||||||
|
|
@ -48,7 +48,7 @@ public:
|
||||||
/**
|
/**
|
||||||
* Install a rate coefficient calculator.
|
* Install a rate coefficient calculator.
|
||||||
* @param rxnNumber the reaction number
|
* @param rxnNumber the reaction number
|
||||||
* @param rdata rate coefficient specification for the reaction
|
* @param rate rate coefficient specification for the reaction
|
||||||
*/
|
*/
|
||||||
void install(size_t rxnNumber, const R& rate) {
|
void install(size_t rxnNumber, const R& rate) {
|
||||||
m_rxn.push_back(rxnNumber);
|
m_rxn.push_back(rxnNumber);
|
||||||
|
|
|
||||||
|
|
@ -87,7 +87,7 @@ public:
|
||||||
Composition efficiencies;
|
Composition efficiencies;
|
||||||
|
|
||||||
//! The default third body efficiency for species not listed in
|
//! The default third body efficiency for species not listed in
|
||||||
//! #third_body_efficiencies.
|
//! #efficiencies.
|
||||||
double default_efficiency;
|
double default_efficiency;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -750,11 +750,8 @@ public:
|
||||||
public:
|
public:
|
||||||
//! Calculate the saturation pressure at the current mixture content for the given temperature
|
//! Calculate the saturation pressure at the current mixture content for the given temperature
|
||||||
/*!
|
/*!
|
||||||
* @param TKelvin (input) Temperature (Kelvin)
|
* @param TKelvin Temperature (Kelvin)
|
||||||
* @param molarVolGas (return) Molar volume of the gas
|
* @return The saturation pressure at the given temperature
|
||||||
* @param molarVolLiquid (return) Molar volume of the liquid
|
|
||||||
*
|
|
||||||
* @return Returns the saturation pressure at the given temperature
|
|
||||||
*/
|
*/
|
||||||
virtual doublereal satPressure(doublereal TKelvin);
|
virtual doublereal satPressure(doublereal TKelvin);
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -213,9 +213,7 @@ private:
|
||||||
* getting the information from an XML database.
|
* getting the information from an XML database.
|
||||||
*
|
*
|
||||||
* @param speciesName Name of the species
|
* @param speciesName Name of the species
|
||||||
* @param sp Owning SpeciesThermo object
|
* @param Mu0Node Pointer to the XML element containing the
|
||||||
* @param k Species index
|
|
||||||
* @param Mu0Node_ptr Pointer to the XML element containing the
|
|
||||||
* Mu0 information.
|
* Mu0 information.
|
||||||
*
|
*
|
||||||
* @ingroup spthermo
|
* @ingroup spthermo
|
||||||
|
|
|
||||||
|
|
@ -179,11 +179,6 @@ public:
|
||||||
*/
|
*/
|
||||||
void initThermoXML(XML_Node& phaseNode, const std::string& id);
|
void initThermoXML(XML_Node& phaseNode, const std::string& id);
|
||||||
|
|
||||||
//! returns a summary of the state of the phase as a string
|
|
||||||
/*!
|
|
||||||
* @param show_thermo If true, extra information is printed out
|
|
||||||
* about the thermodynamic state of the system.
|
|
||||||
*/
|
|
||||||
virtual std::string report(bool show_thermo=true,
|
virtual std::string report(bool show_thermo=true,
|
||||||
doublereal threshold=1e-14) const;
|
doublereal threshold=1e-14) const;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
/**
|
/**
|
||||||
* @file TortuosityBruggeman.h
|
* @file Tortuosity.h
|
||||||
* Class to compute the increase in diffusive path length in porous media
|
* Class to compute the increase in diffusive path length in porous media
|
||||||
* assuming the Bruggeman exponent relation
|
* assuming the Bruggeman exponent relation
|
||||||
*/
|
*/
|
||||||
|
|
@ -182,7 +182,7 @@ public:
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
//! Relative conductivities of the dispersed and continuous phases,
|
//! Relative conductivities of the dispersed and continuous phases,
|
||||||
//! \code{relativeConductivites_}\f$ = \kappa_d / \kappa_0 \f$.
|
//! `relativeConductivites_` \f$ = \kappa_d / \kappa_0 \f$.
|
||||||
double relativeConductivites_;
|
double relativeConductivites_;
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
|
||||||
|
|
@ -322,7 +322,7 @@ static SpeciesThermoInterpType* newNasaThermoFromXML(
|
||||||
/*!
|
/*!
|
||||||
* This is called if a 'MinEQ3' node is found in the XML input.
|
* This is called if a 'MinEQ3' node is found in the XML input.
|
||||||
*
|
*
|
||||||
* @param speciesName name of the species
|
* @param name name of the species
|
||||||
* @param MinEQ3node The XML_Node containing the MinEQ3 parameterization
|
* @param MinEQ3node The XML_Node containing the MinEQ3 parameterization
|
||||||
*/
|
*/
|
||||||
SpeciesThermoInterpType* newShomateForMineralEQ3(const std::string& name,
|
SpeciesThermoInterpType* newShomateForMineralEQ3(const std::string& name,
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue