Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
singularitti committed Nov 12, 2023
1 parent 9264fe4 commit 7b9eefc
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/src/lib/internals/finitestrains.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Finite strains

```@autodocs
Modules = [EquationsOfStateOfSolids.FiniteStrains]
```
45 changes: 45 additions & 0 deletions docs/src/lib/public/collections.md
Original file line number Diff line number Diff line change
@@ -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
```
21 changes: 21 additions & 0 deletions docs/src/lib/public/fitting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Fitting

## Contents

```@contents
Pages = ["fitting.md"]
```

## Index

```@index
Pages = ["fitting.md"]
```

## Public interface

```@docs
fit
linfit
nonlinfit
```

0 comments on commit 7b9eefc

Please sign in to comment.