Skip to content

Commit

Permalink
Merge pull request #36 from dkarrasch/patch-1
Browse files Browse the repository at this point in the history
update TwoDTurb docs
  • Loading branch information
navidcy committed Jan 3, 2020
2 parents b15419e + a4d42fe commit 204e04f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/src/modules/twodturb.md
Expand Up @@ -42,10 +42,10 @@ $$\mathcal{N}(\widehat{\zeta}) = - \mathrm{i}k_x \mathrm{FFT}(u \zeta)-
**Params**

For the unforced case ($f=0$) parameters AbstractType is build with `Params` and it includes:
- `nu`: Float; viscosity or hyperviscosity coefficient.
- `nnu`: Integer$>0$; the order of viscosity $n_\nu$. Case $n_\nu=1$ give normal viscosity.
- `mu`: Float; bottom drag or hypoviscosity coefficient.
- `nmu`: Integer$\ge 0$; the order of hypodrag $n_\mu$. Case $n_\mu=0$ give plain linear drag $\mu$.
- `ν`: Float; viscosity or hyperviscosity coefficient.
- ``: Integer$>0$; the order of viscosity $n_\nu$. Case $n_\nu=1$ give normal viscosity.
- `μ`: Float; bottom drag or hypoviscosity coefficient.
- ``: Integer$\ge 0$; the order of hypodrag $n_\mu$. Case $n_\mu=0$ give plain linear drag $\mu$.

For the forced case ($f\ne 0$) parameters AbstractType is build with `ForcedParams`. It includes all parameters in `Params` and additionally:
- `calcF!`: Function that calculates the forcing $\widehat{f}$
Expand Down

0 comments on commit 204e04f

Please sign in to comment.