Merge branch 'master' of https://github.com/ClapeyronThermo/Clapeyron.jl into 500-eta-crit

Author: longemen3000

docs/src/api/parameters.md

@@ -97,7 +97,6 @@ Clapeyron.xlogx
 Clapeyron.export_model
 Clapeyron.FluidCorrelation
 Clapeyron.GammaPhi
-Clapeyron.ExtendedCorrespondingStates
 Clapeyron.ECS
 ```
 

docs/src/eos/correlations.md

@@ -51,7 +51,7 @@ Most Liquid volume correlations are only defined by a volume equation, but some
 RackettLiquid
 YamadaGunnLiquid
 COSTALD
-GrenkeElliotWater
+GrenkeElliottWater
 HoltenWater
 ```
 

docs/src/properties/multi.md

@@ -67,13 +67,11 @@ Clapeyron.FugBubblePressure
 Clapeyron.ActivityBubblePressure
 Clapeyron.ChemPotBubbleTemperature
 Clapeyron.FugBubbleTemperature
-Clapeyron.ActivityBubbleTemperature
 Clapeyron.ChemPotDewPressure
 Clapeyron.FugDewPressure
 Clapeyron.ActivityDewPressure
 Clapeyron.ChemPotDewTemperature
 Clapeyron.FugDewTemperature
-Clapeyron.ActivityDewTemperature
 ```
 
 ## Consistency and Stability

src/database/combiningrules/implace.jl

@@ -3,6 +3,12 @@ SingleOrPair_values(x) = x
 SingleOrPair_values(x::SingleOrPair) = x.values
 
 ### kij_mix
+
+"""
+    kij_mix!(f,out)
+
+Inplace version of [`kij_mix`](@ref)
+"""
 function kij_mix!(f::F,out) where F
     return kij_mix!(f,out,nothing)
 end
@@ -73,7 +79,11 @@ function kij_mix!(f::F,p::AbstractMatrix,K::AbstractMatrix,B::AbstractMatrix) wh
 end
 
 ## pair_mix!
+"""
+    pair_mix!(f,out,Q)
 
+Inplace version of [`pair_mix`](@ref)
+"""
 function pair_mix!(f::F,out,Q) where F
     _out = SingleOrPair_values(out)
     q = SingleOrPair_values(Q)

src/methods/pT.jl

@@ -847,6 +847,18 @@ function compressibility_factor(model::EoSModel, p, T, z=SA[1.]; phase=:unknown,
     return p*V/(sum(z)*Rgas(model)*T)
 end
 
+"""
+    inversion_temperature(model::EoSModel, p, z=SA[1.0]; phase=:unknown, threaded=true, vol0=nothing)
+
+Calculates the inversion temperature `T_inv`, defined as the temperature where the Joule-Thomson coefficient becomes zero, i.e.
+
+```julia
+μⱼₜ(T) = 0
+```
+The keywords `phase`, `threaded` and `vol0` are passed to the [`Clapeyron.volume`](@ref) solver.
+
+See also [`joule_thomson_coefficient`](@ref).
+"""
 function inversion_temperature(model::EoSModel, p, z=SA[1.0]; phase=:unknown, threaded=true, vol0=nothing)
     T0 = 6.75*T_scale(model,z)
     μⱼₜ(T) = joule_thomson_coefficient(model, p, T, z; phase, threaded, vol0)

src/methods/property_solvers/singlecomponent/crit_pure.jl

@@ -8,6 +8,7 @@ Returns a tuple, containing:
 - Critical pressure `[Pa]`
 - Critical molar volume `[m³·mol⁻¹]`
 """
+crit_pure
 
 function crit_pure(model::EoSModel)
     satmodel = saturation_model(model)

src/methods/property_solvers/stability/stability.jl

@@ -151,6 +151,11 @@ function VT_chemical_stability(model::EoSModel,V,T,z,check_vol = true)
     return chemical_stability(model,p,T,z)
 end
 
+"""
+    chemical_stability(model,V,T,z)::Bool
+
+Performs a chemical stability check using the tangent plane distance criterion, using the [tpd](@ref) function.
+"""
 function chemical_stability(model,p,T,z)
     length(model) == 1 && return true #there aren't other combinations of composition.
     comps,wi,_,_ = tpd(model,p,T,z,break_first = true)

src/models/ECS/ECS.jl

@@ -41,6 +41,8 @@ f,h = shape_factors(model::ECS,shape_ref::EoSModel,V,T,z)
 
 .1 Mollerup, J. (1998). Unification of the two-parameter equation of state and the principle of corresponding states. Fluid Phase Equilibria, 148(1–2), 1–19. [doi:10.1016/s0378-3812(98)00230-1](https://doi.org/10.1016/s0378-3812(98)00230-1)
 """
+ECS
+
 const ECS = ExtendedCorrespondingStates
 
 Base.length(model::ECS) = length(model.shape_model)
@@ -110,7 +112,8 @@ fh = a(T)/a₀(T₀)
 1. Mollerup, J. (1998). Unification of the two-parameter equation of state and the principle of corresponding states. Fluid Phase Equilibria, 148(1–2), 1–19. [doi:10.1016/s0378-3812(98)00230-1](https://doi.org/10.1016/s0378-3812(98)00230-1)
 
 """
-function shape_factors end
+shape_factors
+
 shape_factors(model::ECS,V,T,z=SA[1.0]) = shape_factors(model,model.shape_ref,V,T,z)
 
 function shape_factors(model::ECS,shape_ref::DeltaCubicModel,V,T,z=SA[1.0])