From 7b9eefc17bcd1a9f1d640909ef7713af14b465c3 Mon Sep 17 00:00:00 2001 From: singularitti Date: Sun, 12 Nov 2023 01:59:21 -0500 Subject: [PATCH] Update docs --- docs/src/lib/internals/finitestrains.md | 5 +++ docs/src/lib/public/collections.md | 45 +++++++++++++++++++++++++ docs/src/lib/public/fitting.md | 21 ++++++++++++ 3 files changed, 71 insertions(+) create mode 100644 docs/src/lib/internals/finitestrains.md create mode 100644 docs/src/lib/public/collections.md create mode 100644 docs/src/lib/public/fitting.md diff --git a/docs/src/lib/internals/finitestrains.md b/docs/src/lib/internals/finitestrains.md new file mode 100644 index 0000000..904b15e --- /dev/null +++ b/docs/src/lib/internals/finitestrains.md @@ -0,0 +1,5 @@ +# Finite strains + +```@autodocs +Modules = [EquationsOfStateOfSolids.FiniteStrains] +``` diff --git a/docs/src/lib/public/collections.md b/docs/src/lib/public/collections.md new file mode 100644 index 0000000..89a268f --- /dev/null +++ b/docs/src/lib/public/collections.md @@ -0,0 +1,45 @@ +# Collections + +## Contents + +```@contents +Pages = ["collections.md"] +Depth = 2:2 +``` + +The current `EquationOfStateOfSolidsParameters` are + +```@repl +using TypeTree +tt(EquationsOfStateOfSolids.EquationOfStateOfSolidsParameters) +``` + +Here the leaves of the type tree are concrete types and can be constructed. + +## Index + +```@index +Pages = ["collections.md"] +``` + +## Public interface + +```@docs +Murnaghan1st +BirchMurnaghan +BirchMurnaghan2nd +BirchMurnaghan3rd +BirchMurnaghan4th +PoirierTarantola +PoirierTarantola2nd +PoirierTarantola3rd +Vinet +EnergyEquation +PressureEquation +BulkModulusEquation +orderof +real +isreal +float +ustrip +``` diff --git a/docs/src/lib/public/fitting.md b/docs/src/lib/public/fitting.md new file mode 100644 index 0000000..578ed05 --- /dev/null +++ b/docs/src/lib/public/fitting.md @@ -0,0 +1,21 @@ +# Fitting + +## Contents + +```@contents +Pages = ["fitting.md"] +``` + +## Index + +```@index +Pages = ["fitting.md"] +``` + +## Public interface + +```@docs +fit +linfit +nonlinfit +```