Skip to content

Commit

Permalink
fix doc rheology
Browse files Browse the repository at this point in the history
  • Loading branch information
tduretz committed Aug 28, 2023
1 parent 2ef78f8 commit 618d4cc
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
14 changes: 13 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,25 @@
Ricker
```
## Function Documentation: Rheology
For deviatoric rheology, updates take the form of:
```math
\tau = \theta_\mathrm{s} \dot\varepsilon + \chi_\mathrm{s} \tau^\mathrm{old}
```
For volumetric rheology, updates take the form of:
```math
P = P^\mathrm{old} + \theta_\mathrm{b} \nabla V + \chi_\mathrm{b} \nabla V^\mathrm{old}
```
```@docs
f_bulk
θs
χs
θb
χb
```
## Function Documentation: Treatment
```@docs
Spec
ComputeQgraph
Getfreq
GenAttenuatedRicker
PlotReceiverGather
```
6 changes: 3 additions & 3 deletions src/Rheology.jl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#---------------------------------------------------#

@doc """
θs(G)
θs(G,Δt)
Deviatoric part of the elastic constitutive update:
provides the shear modulus G for use in
Expand All @@ -16,7 +16,7 @@ function θs(G,Δt)
end

@doc """
θs(G,η,Δt)
θs(G,η,Δt)
Deviatoric part of the Maxwell visco-elastic constitutive update:
used to compute
Expand Down Expand Up @@ -53,7 +53,7 @@ end
Relaxation part of the deviatoric Maxwell visco-elastic constitutive update:
for use in the calculation of
```math
Δτ = (DeN / (1+DeN)) τ_{OLD} + Δτ_{CONSTITUTIVE}
Δτ = (DeN / (1+DeN)) τ_\mathrm{OLD} + Δτ_\mathrm{CONSTITUTIVE}
```
with DeN a numerical Deborah number, equal to
```math
Expand Down

0 comments on commit 618d4cc

Please sign in to comment.