mirror of
https://github.com/Cantera/cantera.git
synced 2025-02-25 18:55:29 -06:00
Delete duplicated documentation
This commit is contained in:
parent
f902ad82f8
commit
ac6f49c5e8
@ -19,67 +19,6 @@ namespace Cantera
|
|||||||
class WaterPropsIAPWS;
|
class WaterPropsIAPWS;
|
||||||
class PDSS_Water;
|
class PDSS_Water;
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup relatedProps Electric Properties of Phases
|
|
||||||
*
|
|
||||||
* Computation of the electric properties of phases
|
|
||||||
*
|
|
||||||
* ### Treatment of the phase potential and the electrochemical potential of a species
|
|
||||||
*
|
|
||||||
* The electrochemical potential of species @f$ k @f$ in a phase @f$ p @f$, @f$ \zeta_k @f$,
|
|
||||||
* is related to the chemical potential via the following equation,
|
|
||||||
*
|
|
||||||
* @f[
|
|
||||||
* \zeta_{k}(T,P) = \mu_{k}(T,P) + z_k \phi_p
|
|
||||||
* @f]
|
|
||||||
*
|
|
||||||
* where @f$ \nu_k @f$ is the charge of species @f$ k @f$, and @f$ \phi_p @f$ is
|
|
||||||
* the electric potential of phase @f$ p @f$.
|
|
||||||
*
|
|
||||||
* The potential @f$ \phi_p @f$ is tracked and internally stored within the
|
|
||||||
* base ThermoPhase object. It constitutes a specification of the internal state
|
|
||||||
* of the phase; it's the third state variable, the first two being temperature
|
|
||||||
* and density (or, pressure, for incompressible equations of state). It may be
|
|
||||||
* set with the function, ThermoPhase::setElectricPotential(), and may be
|
|
||||||
* queried with the function ThermoPhase::electricPotential().
|
|
||||||
*
|
|
||||||
* Note, the overall electrochemical potential of a phase may not be changed
|
|
||||||
* by the potential because many phases enforce charge neutrality:
|
|
||||||
*
|
|
||||||
* @f[
|
|
||||||
* 0 = \sum_k z_k X_k
|
|
||||||
* @f]
|
|
||||||
*
|
|
||||||
* Whether charge neutrality is necessary for a phase is also specified within
|
|
||||||
* the ThermoPhase object, by the function call
|
|
||||||
* ThermoPhase::chargeNeutralityNecessary(). Note, that it is not necessary for
|
|
||||||
* the IdealGas phase, currently. However, it is necessary for liquid phases
|
|
||||||
* such as DebyeHuckel and HMWSoln for the proper specification of the chemical
|
|
||||||
* potentials.
|
|
||||||
*
|
|
||||||
* This equation, when applied to the @f$ \zeta_k @f$ equation described
|
|
||||||
* above, results in a zero net change in the effective Gibbs free energy of
|
|
||||||
* the phase. However, specific charged species in the phase may increase or
|
|
||||||
* decrease their electrochemical potentials, which will have an effect on
|
|
||||||
* interfacial reactions involving charged species, when there is a potential
|
|
||||||
* drop between phases. This effect is used within the InterfaceKinetics and
|
|
||||||
* EdgeKinetics kinetics objects classes.
|
|
||||||
*
|
|
||||||
* ### Electrothermochemical Properties of Phases of Matter
|
|
||||||
*
|
|
||||||
* The following classes are used to compute the electrical and
|
|
||||||
* electrothermochemical properties of phases of matter. The main property
|
|
||||||
* currently is the dielectric constant, which is an important parameter for
|
|
||||||
* electrolyte solutions. The class WaterProps calculate the dielectric
|
|
||||||
* constant of water as a function of temperature and pressure.
|
|
||||||
*
|
|
||||||
* WaterProps also calculate the constant A_debye used in the Debye Huckel and
|
|
||||||
* Pitzer activity coefficient calculations.
|
|
||||||
*
|
|
||||||
* @ingroup phases
|
|
||||||
*/
|
|
||||||
//@{
|
|
||||||
|
|
||||||
//! The WaterProps class is used to house several approximation routines for
|
//! The WaterProps class is used to house several approximation routines for
|
||||||
//! properties of water.
|
//! properties of water.
|
||||||
/*!
|
/*!
|
||||||
@ -91,10 +30,9 @@ class PDSS_Water;
|
|||||||
* The class is also a wrapper around the WaterPropsIAPWS class which provides
|
* The class is also a wrapper around the WaterPropsIAPWS class which provides
|
||||||
* the calculations for the equation of state properties for water.
|
* the calculations for the equation of state properties for water.
|
||||||
*
|
*
|
||||||
* In particular, this class house routine for the calculation of the dielectric
|
* In particular, this class houses methods for the calculation of the dielectric
|
||||||
* constant of water
|
* constant of water and the constant A_debye used in the Debye-Huckel and
|
||||||
*
|
* Pitzer activity coefficient calculations.
|
||||||
* Most if not all of the member functions are static.
|
|
||||||
*/
|
*/
|
||||||
class WaterProps
|
class WaterProps
|
||||||
{
|
{
|
||||||
@ -249,7 +187,6 @@ protected:
|
|||||||
bool m_own_sub = false;
|
bool m_own_sub = false;
|
||||||
};
|
};
|
||||||
|
|
||||||
//@}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
Loading…
Reference in New Issue
Block a user