add docs for compute viscosity functions (#120)

* add docs for compute viscosity functions * fix typos and add viscosity.md * merci spellchecker! * add to make.jl
JuliaGeodynamics · Oct 19, 2023 · ca4b5af · ca4b5af
1 parent b0c434d
commit ca4b5af
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 2 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -16,6 +16,7 @@ makedocs(;
             "Density" => "man/density.md",
             "Creep laws" => "man/creeplaws.md",
             "Custom rheology" => "man/customrheology.md",
+            "Viscosity" => "man/viscosity.md",
             "Elasticity" => "man/elasticity.md",
             "Plasticity" => "man/plasticity.md",
             "Heat Capacity" => "man/heatcapacity.md",

diff --git a/docs/src/man/plasticity.md b/docs/src/man/plasticity.md
@@ -1,7 +1,7 @@
 # Plasticity 
 
-Plasticity is a non;linear rheology bthat is actrivated once stresses exceed a certain yield criteria.
-# Implemented  laws
+Plasticity is a non-linear rheology that is activated once stresses exceed a certain yield criteria.
+# Implemented laws
 The following plastic law are implemented:
 ```@docs
 GeoParams.MaterialParameters.Plasticity.DruckerPrager

diff --git a/docs/src/man/viscosity.md b/docs/src/man/viscosity.md
@@ -0,0 +1,6 @@
+# Effective viscosity computations
+
+```@docs
+GeoParams.compute_viscosity_εII
+GeoParams.compute_viscosity_τII
+```
diff --git a/src/Viscosity/Viscosity.jl b/src/Viscosity/Viscosity.jl
@@ -10,6 +10,11 @@ export compute_viscosity_εII,
 @inline _viscosity(τII, εII) = τII / (2  * εII)
 
 # compute effective "creep" viscosity from strain rate tensor
+"""
+    compute_viscosity_εII(s::AbstractConstitutiveLaw, εII, kwargs...)
+
+Compute effective viscosity given a 2nd invariant of the deviatoric strain rate tensor, extra parameters are passed as a named tuple, e.g., (;T=T) 
+"""
 @inline function compute_viscosity_εII(v::AbstractConstitutiveLaw, εII, args)
 
     τII = compute_τII(v, εII, args)
@@ -18,6 +23,11 @@ export compute_viscosity_εII,
 end
 
 # compute effective "creep" viscosity from deviatoric stress tensor
+"""
+    compute_viscosity_τII(s::AbstractConstitutiveLaw, τII, kwargs...)
+
+Compute effective viscosity given a 2nd invariant of the deviatoric stress tensor and, extra parameters are passed as a named tuple, e.g., (;T=T) 
+"""
 @inline function compute_viscosity_τII(v::AbstractConstitutiveLaw, τII, args)
 
     εII = compute_εII(v, τII, args)