From 2060181432a600a42c5cb666333c9c2f2a25f2a6 Mon Sep 17 00:00:00 2001 From: michael-petersen Date: Sun, 9 Jun 2024 21:49:08 +0100 Subject: [PATCH] get agreement in documentation --- docs/src/bases.md | 14 ++++++++++++++ docs/src/common.md | 15 ++++++++++++++- 2 files changed, 28 insertions(+), 1 deletion(-) diff --git a/docs/src/bases.md b/docs/src/bases.md index 030d7cd..16bd4b6 100644 --- a/docs/src/bases.md +++ b/docs/src/bases.md @@ -1,6 +1,20 @@ # Bases +--- +## Basis functions + +`AstroBasis` currently offers four different types of bases. +### 3d (Spherical) +1. Clutton-Brock (1973), which is a match to the Plummer (1911) profile. +2. Hernquist & Ostriker (1992), which is a match to the Hernquist (1990) profile. + +### 2d (Razor-Thin Discs) +1. Clutton-Brock (1972), which is a 2d match to a Plummer profile. +2. Kalnajs (1976), which is a spiral basis. + +-- + ## Spherical bases ### Clutton-Brock (1973) diff --git a/docs/src/common.md b/docs/src/common.md index 5120074..5ea1c3e 100644 --- a/docs/src/common.md +++ b/docs/src/common.md @@ -1,6 +1,19 @@ # Functions common to all bases -To seamlessly allow for switching between different bases, the bases are all organised around common functions. +To seamlessly allow for switching between different bases, the bases are all organised around common functions. + +## Common functions + +The common functions are detailed in `src/Basisdoc.jl`. Any instantiated basis will result in a structure, with attributes `name`, `dimension`, `lmax`, `nmax`, `rb` (the basis scale), and `G` (the gravitational constant; unity by default). The following functions are also defined: + +`getUln(basis,l,n,r)` will calculate the basis potential at location r for harmonic order l and radial order n. + +`getDln(basis,l,n,r)` will calculate the basis density at location r for harmonic order l and radial order n. + +Overloaded function `tabUl!(basis,l)` will fill the structure attribute `tabUl` table with radial potential values from the basis up to `nmax`. + +Overloaded function `tabDl!(basis,l)` will fill the structure attribute `tabUl` table with radial density values from the basis up to `nmax`. + ## Accessing potential functions ```@docs