From 43050e8013ab123e4407005efe576f2c4945814e Mon Sep 17 00:00:00 2001 From: Stefan Pinnow Date: Sun, 20 Oct 2024 07:59:17 +0200 Subject: [PATCH] docs: capitalize names --- docs/src/eos/correlations.md | 4 ++-- docs/src/properties/basic.md | 2 +- docs/src/user_guide/custom_methods.md | 4 ++-- docs/src/user_guide/custom_model.md | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/src/eos/correlations.md b/docs/src/eos/correlations.md index 8f85a6fd9..63c291a14 100644 --- a/docs/src/eos/correlations.md +++ b/docs/src/eos/correlations.md @@ -36,7 +36,7 @@ Clapeyron.DIPPR101Sat ``` # Liquid Volume Correlations -Liquid Volume Correlations are any `EoSModel` that are subtypes of `LiquidVolumeModel`. +Liquid Volume Correlations are any `EoSModel` that are subtypes of `LiquidVolumeModel`. They return `volume(model,p,T,z, phase = :liquid)`. ```@docs @@ -47,7 +47,7 @@ COSTALD # Virial Models -Virial models are defined in terms of the second virial coefficient, `B(T,z)`. the reduced residual helmholtz energy is defined as: +Virial models are defined in terms of the second virial coefficient, `B(T,z)`. the reduced residual Helmholtz energy is defined as: ``\frac{A_\mathrm{res}}{Nk_\mathrm{B}T} = \frac{B}{V}``, diff --git a/docs/src/properties/basic.md b/docs/src/properties/basic.md index b2cf24967..87ce194a6 100644 --- a/docs/src/properties/basic.md +++ b/docs/src/properties/basic.md @@ -16,7 +16,7 @@ Pages = ["basic.md"] ## Primitive functions -Almost all models in Clapeyron based on helmholtz free energy have at least one of the following functions defined: +Almost all models in Clapeyron based on Helmholtz free energy have at least one of the following functions defined: ```@docs Clapeyron.eos diff --git a/docs/src/user_guide/custom_methods.md b/docs/src/user_guide/custom_methods.md index d01a901e0..4c325cc7b 100755 --- a/docs/src/user_guide/custom_methods.md +++ b/docs/src/user_guide/custom_methods.md @@ -44,7 +44,7 @@ Clapeyron will automatically call your implementation when your model is evaluat ## Custom saturation solver -For saturation solvers ([`saturation_pressure`](@ref),[`saturation_temperature`](@ref)), You can dispatch on a different saturation method. let's create one, that just evaluates antoine coefficients: +For saturation solvers ([`saturation_pressure`](@ref),[`saturation_temperature`](@ref)), You can dispatch on a different saturation method. let's create one, that just evaluates Antoine coefficients: ```julia struct DirectAntoine{C} <: Clapeyron.SaturationMethod @@ -89,7 +89,7 @@ function Clapeyron.index_reduction(method::MyRachfordRice,non_zero_indices) end function Clapeyron.tp_flash_impl(model::EoSModel,p,T,z,method::MyRachfordRice) - #perform rachford rice,returns x, y, α₀ + #perform Rachford Rice,returns x, y, α₀ #... X = vcat(x',y') n = X.*[1-α₀ diff --git a/docs/src/user_guide/custom_model.md b/docs/src/user_guide/custom_model.md index d131ac17d..084060743 100755 --- a/docs/src/user_guide/custom_model.md +++ b/docs/src/user_guide/custom_model.md @@ -134,7 +134,7 @@ struct PCSAFT{T<:IdealModel} <: PCSAFTModel sites::SiteParam # Parameter struct containing the sites and their amounts params::PCSAFTParam # Struct specified in the macro idealmodel::T # Model for the ideal part - assoc_options::Clapeyron.AssocOptions # Options for the calculation of the association helmholtz contribution + assoc_options::Clapeyron.AssocOptions # Options for the calculation of the association Helmholtz contribution references::Array{String,1} # DOI references end @@ -185,7 +185,7 @@ You can, of course, not use the macro, if your model depends itself on other mod If we obey that convention, we may use the `@f` macro, which automatically substitutes the first four parameters for compactness. For example, `@f(func,i,j)` is equivalent to calling `func(model,V,T,z,i,j)`. - Clapeyron obtains all the properties of a model by differentiating the total helmoltz energy ([`eos`](@ref)) or the residual helmoltz energy ([`eos_res`](@ref)). `eos` and `eos_res` themselves are defined in terms of the reduced ideal helmholtz energy ([`a_res`](@ref)). In this case, we are going to define `a_res` for our own model: + Clapeyron obtains all the properties of a model by differentiating the total Helmholtz energy ([`eos`](@ref)) or the residual Helmholtz energy ([`eos_res`](@ref)). `eos` and `eos_res` themselves are defined in terms of the reduced ideal Helmholtz energy ([`a_res`](@ref)). In this case, we are going to define `a_res` for our own model: ```julia function Clapeyron.a_res(model::PCSAFTModel, V, T, z)