Skip to content

Commit

Permalink
docs: capitalize names
Browse files Browse the repository at this point in the history
  • Loading branch information
Mo-Gul committed Oct 20, 2024
1 parent 0b55b04 commit 43050e8
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/src/eos/correlations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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}``,

Expand Down
2 changes: 1 addition & 1 deletion docs/src/properties/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/src/user_guide/custom_methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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-α₀
Expand Down
4 changes: 2 additions & 2 deletions docs/src/user_guide/custom_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 43050e8

Please sign in to comment.