Skip to content

Commit a74eae9

Browse files
committed
Fix docs of FromStrain & ToStrain
1 parent d3f9e1d commit a74eae9

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

src/FiniteStrains.jl

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ struct LagrangianStrain <: FiniteStrain end
88
struct NaturalStrain <: FiniteStrain end
99
struct InfinitesimalStrain <: FiniteStrain end
1010

11+
"""
12+
ToEulerianStrain(v0)(v)
13+
ToLagrangianStrain(v0)(v)
14+
ToNaturalStrain(v0)(v)
15+
ToInfinitesimalStrain(v0)(v)
16+
17+
Calculate the finite strain of `v` based on the reference volume `v0`.
18+
19+
!!! info
20+
See the formulae on the [`Gibbs2` paper](https://www.sciencedirect.com/science/article/pii/S0010465511001470) Table 3.
21+
"""
1122
struct ToStrain{S<:FiniteStrain,T}
1223
v0::T
1324
end
@@ -22,27 +33,15 @@ const ToInfinitesimalStrain = ToStrain{InfinitesimalStrain}
2233
(x::ToInfinitesimalStrain)(v) = 1 - (x.v0 / v)^_⅓
2334

2435
"""
25-
volume2strain(::EulerianStrain, v0)
26-
volume2strain(::LagrangianStrain, v0)
27-
volume2strain(::NaturalStrain, v0)
28-
volume2strain(::InfinitesimalStrain, v0)
36+
FromEulerianStrain(v0)(f)
37+
FromLagrangianStrain(v0)(f)
38+
FromNaturalStrain(v0)(f)
39+
FromInfinitesimalStrain(v0)(f)
2940
30-
Return a function of `v` that calculates the `FiniteStrain` from `v0`.
41+
Calculate the original volume `v` from the finite strain `f` based on the reference volume `v0`.
3142
3243
!!! info
33-
See the formulae on Ref. 1 Table 3.
34-
"""
35-
36-
"""
37-
strain2volume(::EulerianStrain, v0)
38-
strain2volume(::LagrangianStrain, v0)
39-
strain2volume(::NaturalStrain, v0)
40-
strain2volume(::InfinitesimalStrain, v0)
41-
42-
Return a function of `f` that calculates the corresponding volume from `v0`.
43-
44-
!!! info
45-
See the formulae on Ref. 1 Table 3.
44+
See the formulae on the [`Gibbs2` paper](https://www.sciencedirect.com/science/article/pii/S0010465511001470) Table 3.
4645
"""
4746
struct FromStrain{S<:FiniteStrain,T}
4847
v0::T

0 commit comments

Comments
 (0)