Improve docs, add parametric type to ZJ

Author: moyner

src/eos_types.jl

@@ -39,52 +39,65 @@ abstract type AbstractGeneralizedCubic end
 abstract type AbstractPengRobinson <: AbstractGeneralizedCubic end
 
 """
+    pr = PengRobinson()
+
 Specializes the GenericCubicEOS to the Peng-Robinson cubic equation of state.
 """
 struct PengRobinson <: AbstractPengRobinson end
 
 
 """
+    prc = PengRobinsonCorrected()
+
 Specializes the GenericCubicEOS to Peng-Robinson modified for large acentric factors
 """
 
 struct PengRobinsonCorrected <: AbstractPengRobinson end
 """
+    zj = ZudkevitchJoffe(; F_a = (T, c_i) -> 1.0, F_b = (T, c_i) -> 1.0)
+
 Specializes the GenericCubicEOS to the Zudkevitch-Joffe cubic equation of state.
 
 The Zudkevitch-Joffe equations of state allows for per-component functions of 
 temperature that modify the `weight_ai` and `weight_bi` functions. These additional
 fitting parameters allows for more flexibility when matching complex mixtures.
 """
-struct ZudkevitchJoffe <: AbstractGeneralizedCubic
-    F_a
-    F_b
+struct ZudkevitchJoffe{A, B} <: AbstractGeneralizedCubic
+    F_a::A
+    F_b::B
     function ZudkevitchJoffe(; F_a = (T, c_i) -> 1.0, F_b = (T, c_i) -> 1.0)
-        new(F_a, F_b)
+        new{typeof(F_a), typeof(F_b)}(F_a, F_b)
     end
 end
 
 """
+    srk = SoaveRedlichKwong()
+
 Specializes the GenericCubicEOS to the Soave-Redlich-Kwong cubic equation of state.
 """
 struct SoaveRedlichKwong <: AbstractGeneralizedCubic end
 """
+    rk = RedlichKwong()
+
 Specializes the GenericCubicEOS to the Redlich-Kwong cubic equation of state.
 """
 struct RedlichKwong <: AbstractGeneralizedCubic end
 
 """
-    GenericCubicEOS(mixture, [type = PengRobinson()])
+    GenericCubicEOS(mixture)
+    GenericCubicEOS(mixture, PengRobinson())
+
 
-Instantiate a generic cubic equation-of-state for a `MultiComponentMixture` and 
+Instantiate a generic cubic equation-of-state for a `MultiComponentMixture` and
 a specified EOS.
 
-Currently supported choices for type:
+Currently supported choices for second argument:
 
-    1. `PengRobinson` (default)
-    2. `ZudkevitchJoffe`
-    3. `RedlichKwong`
-    4. `SoaveRedlichKwong`
+    1. `PengRobinson()` (default)
+    2. `PengRobinsonCorrected()`
+    3. `ZudkevitchJoffe()`
+    4. `RedlichKwong()`
+    5. `SoaveRedlichKwong()`
 """
 function GenericCubicEOS(mixture, type = PengRobinson(); kwarg...)
     ω_a, ω_b, m_1, m_2 = static_coefficients(type)

src/flash_types.jl

@@ -4,20 +4,21 @@ abstract type AbstractFlash end
 abstract type AbstractNewtonFlash <: AbstractFlash end
 
 """
-Flash method that uses successive subtition.
+    ssi = SSIFlash()
 
-Unconditionally convergent, does not require derivatives, but is very slow around critical regions.
+Flash method that uses successive subtition. Unconditionally convergent, does
+not require derivatives, but is very slow around critical regions.
 
 See also: [`flash_2ph!`](@ref), [`NewtonFlash`](@ref) [`SSINewtonFlash`](@ref)
 """
 struct SSIFlash <: AbstractFlash end
 
 """
-    NewtonFlash([dMax = 0.2])
+    newton = NewtonFlash()
+    newton = NewtonFlash(dMax = 0.2)
 
-Flash using Newton's method for zero solve.
-
-Only conditionally convergent, but has better convergence rate than SSI.
+Flash using Newton's method for zero solve. Only conditionally convergent, but
+has better convergence rate than SSI.
 
 # Arguments
 - `dMax`: dampening factor for the newton iteration
@@ -29,7 +30,8 @@ See also: [`flash_2ph!`](@ref), [`SSIFlash`](@ref) [`SSINewtonFlash`](@ref)
 end
 
 """
-    SSINewtonFlash([swap_iter = 5,dMax = 0.2])
+    ssi_newton = SSINewtonFlash(
+    ssi_newton = SSINewtonFlash(swap_iter = 5, dMax = 0.2)
 
 Perform a number of SSI iterations, followed by Newton until convergence.