Skip to content

Commit

Permalink
get agreement in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-petersen committed Jun 9, 2024
1 parent 2476225 commit 2060181
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
14 changes: 14 additions & 0 deletions docs/src/bases.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
15 changes: 14 additions & 1 deletion docs/src/common.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 2060181

Please sign in to comment.