research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Fix Doxygen subsection groupings

Browse source
This commit is contained in:
Ray Speth 2015-01-06 23:37:25 +00:00
parent d5907088a7
commit 79baacc605
11 changed files with 66 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
include/cantera/thermo/FixedChemPotSSTP.h
View file

@ -445,10 +445,6 @@ public:
*/
virtual void getIntEnergy_RT_ref(doublereal* urt) const;
//@}
/// @name Thermodynamic Values for the Species Reference State
///
/*!
* Returns the vector of nondimensional
* enthalpies of the reference state at the current temperature
@ -517,6 +513,8 @@ public:
*/
virtual void getCp_R_ref(doublereal* cprt) const;
//@}
virtual void initThermoXML(XML_Node& phaseNode, const std::string& id);
//! Set the equation of state parameters

2
include/cantera/thermo/IdealSolnGasVPSS.h
View file

@ -33,8 +33,6 @@ const int cIdealSolnGasPhase2 = 6012;
*
* An ideal solution or an ideal gas approximation of a phase. Uses variable
* pressure standard state methods for calculating thermodynamic properties.
*
* @nosubgrouping
*/
class IdealSolnGasVPSS : public VPStandardStateTP
{

1
include/cantera/thermo/MaskellSolidSolnPhase.h
View file

@ -270,6 +270,7 @@ public:
void set_h_mix(const doublereal hmix) { h_mixing = hmix; }
//@}
private:
/**

2
include/cantera/thermo/MixtureFugacityTP.h
View file

@ -65,8 +65,6 @@ namespace Cantera
* multiple phases of the fluid in equilibrium with each other. This has yet to be resolved.
*
* This class is usually used for non-ideal gases.
*
* @nosubgrouping
*/
class MixtureFugacityTP : public ThermoPhase
{

2
include/cantera/thermo/PDSS_SSVol.h
View file

@ -234,12 +234,12 @@ public:
virtual doublereal entropy_R_ref() const;
virtual doublereal cp_R_ref() const;
virtual doublereal molarVolume_ref() const;
//! @}
private:
//! Does the internal calculation of the volume
void calcMolarVolume() const;
//! @}
//! @name Mechanical Equation of State Properties
//! @{

2
include/cantera/thermo/RedlichKwongMFTP.h
View file

@ -25,8 +25,6 @@ namespace Cantera
*
* This class can handle either an ideal solution or an ideal gas approximation
* of a phase.
*
* @nosubgrouping
*/
class RedlichKwongMFTP : public MixtureFugacityTP
{

2
include/cantera/thermo/SingleSpeciesTP.h
View file

@ -63,8 +63,6 @@ namespace Cantera
* Its SingleSpeciesTP::initThermo()
* member does check that one and only one species has been defined
* to occupy the phase.
*
* \nosubgrouping
*/
class SingleSpeciesTP : public ThermoPhase
{

1
include/cantera/thermo/StoichSubstance.h
View file

@ -20,7 +20,6 @@ namespace Cantera
*
* Class StoichSubstance represents a stoichiometric (fixed composition)
* incompressible substance.
* \nosubgrouping
*/
class StoichSubstance : public ThermoPhase
{

29
include/cantera/thermo/ThermoPhase.h
View file

@ -1069,20 +1069,6 @@ public:
*/
virtual void setState_UV(doublereal u, doublereal v, doublereal tol = 1.e-4);
private:
//! Carry out work in HP and UV calculations.
/*!
* @param h Specific enthalpy or internal energy (J/kg)
* @param p Pressure (Pa) or specific volume (m^3/kg)
* @param tol Optional parameter setting the tolerance of the calculation.
* Defaults to 1.0E-4. Important for some applications where
* numerical Jacobians are being calculated.
* @param doUV True if solving for UV, false for HP.
*/
void setState_HPorUV(doublereal h, doublereal p,
doublereal tol = 1.e-4, bool doUV = false);
public:
//! Set the specific entropy (J/kg/K) and pressure (Pa).
/*!
* This function fixes the internal state of the phase so that
@ -1109,7 +1095,20 @@ public:
*/
virtual void setState_SV(doublereal s, doublereal v, doublereal tol = 1.e-4);
//@}
private:
//! Carry out work in HP and UV calculations.
/*!
* @param h Specific enthalpy or internal energy (J/kg)
* @param p Pressure (Pa) or specific volume (m^3/kg)
* @param tol Optional parameter setting the tolerance of the calculation.
* Defaults to 1.0E-4. Important for some applications where
* numerical Jacobians are being calculated.
* @param doUV True if solving for UV, false for HP.
*/
void setState_HPorUV(doublereal h, doublereal p,
doublereal tol = 1.e-4, bool doUV = false);
//! Carry out work in SP and SV calculations.
/*!
@ -1129,8 +1128,6 @@ private:
public:
//@}
/**
* @name Chemical Equilibrium
* Chemical equilibrium.

2
include/cantera/thermo/VPSSMgr.h
View file

@ -704,6 +704,8 @@ public:
*/
virtual void initAllPtrs(VPStandardStateTP* vp_ptr, SpeciesThermo* sp_ptr);
//!@}
protected:
//! Number of species in the phase
size_t m_kk;

98
include/cantera/thermo/VPStandardStateTP.h
View file

@ -49,8 +49,6 @@ namespace Cantera
* Put some teeth into this level by overloading the setDensity() function. It should
* now throw an exception. Instead, setPressure routines should calculate the
* solution density and then call State:setDensity() directly.
*
* @nosubgrouping
*/
class VPStandardStateTP : public ThermoPhase
{
@ -263,6 +261,53 @@ public:
*/
virtual void setPressure(doublereal p);
//! Set the temperature and pressure at the same time
/*!
* Note this function triggers a reevaluation of the standard
* state quantities.
*
* @param T temperature (kelvin)
* @param pres pressure (pascal)
*/
virtual void setState_TP(doublereal T, doublereal pres);
//! Returns the current pressure of the phase
/*!
* The pressure is an independent variable in this phase. Its current value
* is stored in the object VPStandardStateTP.
*
* @return return the pressure in pascals.
*/
doublereal pressure() const {
return m_Pcurrent;
}
//! Updates the standard state thermodynamic functions at the current T and P of the solution.
/*!
*
* If m_useTmpStandardStateStorage is true,
* this function must be called for every call to functions in this
* class. It checks to see whether the temperature or pressure has changed and
* thus the ss thermodynamics functions for all of the species
* must be recalculated.
*
* This function is responsible for updating the following internal members,
* when m_useTmpStandardStateStorage is true.
*
* - m_hss_RT;
* - m_cpss_R;
* - m_gss_RT;
* - m_sss_R;
* - m_Vss
*
* If m_useTmpStandardStateStorage is not true, this function may be
* required to be called by child classes to update internal member data.
*
*/
virtual void updateStandardStateThermo() const;
//@}
protected:
/**
* Calculate the density of the mixture using the partial
@ -289,30 +334,6 @@ protected:
*/
virtual void calcDensity();
public:
//! Set the temperature and pressure at the same time
/*!
* Note this function triggers a reevaluation of the standard
* state quantities.
*
* @param T temperature (kelvin)
* @param pres pressure (pascal)
*/
virtual void setState_TP(doublereal T, doublereal pres);
//! Returns the current pressure of the phase
/*!
* The pressure is an independent variable in this phase. Its current value
* is stored in the object VPStandardStateTP.
*
* @return return the pressure in pascals.
*/
doublereal pressure() const {
return m_Pcurrent;
}
protected:
//! Updates the standard state thermodynamic functions at the current T and P of the solution.
/*!
* @internal
@ -339,31 +360,6 @@ protected:
public:
//! Updates the standard state thermodynamic functions at the current T and P of the solution.
/*!
*
* If m_useTmpStandardStateStorage is true,
* this function must be called for every call to functions in this
* class. It checks to see whether the temperature or pressure has changed and
* thus the ss thermodynamics functions for all of the species
* must be recalculated.
*
* This function is responsible for updating the following internal members,
* when m_useTmpStandardStateStorage is true.
*
* - m_hss_RT;
* - m_cpss_R;
* - m_gss_RT;
* - m_sss_R;
* - m_Vss
*
* If m_useTmpStandardStateStorage is not true, this function may be
* required to be called by child classes to update internal member data.
*
*/
virtual void updateStandardStateThermo() const;
//@}
/// @name Thermodynamic Values for the Species Reference States (VPStandardStateTP)
/*!
* There are also temporary