Merge pull request #78 from MineralsCloud/apply

Use function-like object to apply EOS, deprecate `apply` methods
MineralsCloud · Apr 12, 2020 · e91d7ca · e91d7ca
2 parents 56fac57 + 4c5b2f0
commit e91d7ca
Show file tree

Hide file tree

Showing 13 changed files with 107 additions and 113 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "EquationsOfState"
 uuid = "0438fec6-b81c-52d9-9651-d286848f50a8"
 authors = ["Qi Zhang <[email protected]>"]
-version = "2.0.0"
+version = "3.0.0"
 
 [deps]
 ConstructionBase = "187b0558-2788-49d3-abe0-74a17ed4e7c9"

diff --git a/docs/src/Collections.md b/docs/src/Collections.md
@@ -275,8 +275,8 @@ Vinet
 ## Public interfaces
 
 ```@docs
-apply(::EnergyForm, eos::EquationOfState)
-apply(::EnergyForm, eos::Murnaghan, v)
-apply(::PressureForm, eos::Murnaghan, v)
-apply(::BulkModulusForm, eos::BirchMurnaghan2nd, v)
+(eos::EquationOfState)(eq::EquationForm)
+(f::EquationOfStateOnVolume{<:Murnaghan,EnergyForm})(v)
+(f::EquationOfStateOnVolume{<:Murnaghan,PressureForm})(v)
+(f::EquationOfStateOnVolume{<:BirchMurnaghan2nd,BulkModulusForm})(v)
 ```
diff --git a/docs/src/Find.md b/docs/src/Find.md
@@ -14,7 +14,7 @@ experience, `P(V)` relation is usually a monotonic function. So we suggest using
 ## Usage
 
 ```julia
-julia> using EquationsOfState, EquationsOfState.Collections, EquationsOfState.Find, Unitful, UnitfulAtomic
+julia> using EquationsOfState.Collections, EquationsOfState.Find, Unitful, UnitfulAtomic
 
 julia> pressures = collect(0:20:200) .* u"GPa";
 

diff --git a/docs/src/Installation.md b/docs/src/Installation.md
@@ -56,7 +56,7 @@ platform to explain the following steps:
 3. Run
 
    ```julia
-   julia> using EquationsOfState, EquationsOfState.Collections, EquationsOfState.Find, EquationsOfState.NonlinearFitting, Unitful, UnitfulAtomic
+   julia> using EquationsOfState.Collections, EquationsOfState.Find, EquationsOfState.NonlinearFitting, Unitful, UnitfulAtomic
    ```
 
    and have fun!

diff --git a/docs/src/NonlinearFitting.md b/docs/src/NonlinearFitting.md
@@ -30,7 +30,6 @@ for more information.
 We provide API `lsqfit` currently.
 
 ```julia
-using EquationsOfState
 using EquationsOfState.Collections
 using EquationsOfState.NonlinearFitting
 

diff --git a/scripts/findvolume.jl b/scripts/findvolume.jl
@@ -1,6 +1,6 @@
 # This file plots the `findvolume.png` in docs
 using Unitful, UnitfulAtomic, Plots
-using EquationsOfState, EquationsOfState.Collections, EquationsOfState.Find
+using EquationsOfState.Collections, EquationsOfState.Find
 
 plotlyjs()
 
@@ -13,7 +13,7 @@ volumes = map(
 plot(ustrip.(volumes), ustrip.(pressures), label = "pressures")
 scatter!(
     ustrip.(volumes),
-    ustrip.(u"GPa", apply(PressureForm(), eos).(volumes)),
+    ustrip.(u"GPa", eos(PressureForm()).(volumes)),
     label = "P(V)",
     dpi = 400,
 )