search

BlackHolePerturbationToolkit / Teukolsky

A Mathematica package for computing solutions to the Teukolsky equation.
http://bhptoolkit.org/Teukolsky/
MIT License
21 stars 3 forks source link

Make n and k optional for special (circular, spherical, eccentric) orbits #23

Closed barrywardell closed 2 years ago

barrywardell commented 2 years ago

For certain cases there is no need to specify all three mode numbers (m, n, k). For circular orbits, n and k are not required. For spherical orbits n is not required. For eccentric k is not required. This pull request makes it possible to not specify the mode numbers that are not required in those cases. This make is more convenient, but potentially causes confusion as something like TeukolskyPointParticleMode[s, l, m, n, orbit] and TeukolskyPointParticleMode[s, l, m, k, orbit] will do different things depending on whether the orbit is spherical or eccentric.

nielsw2 commented 2 years ago

The s=+2 sources is a great addition. @Kevin-Cunningham has been looking at this too and I think almost has it working so I had added him as a reviewer. I think we should move the s=+2 work to it's own branch to keep it separate from the discussion about whether n and k should be optional.

znasipak commented 2 years ago

Missing + k q[Theta] form [Theta]phase in the spherical and generic cases. I know this has been added to the sp2 branch. Is this version made redundant now?

Yeah this branch and pull request should just focus on whether n and k can be included as optional arguments. I'll generate a pull request for sp2.

barrywardell commented 2 years ago

Does anyone have any thoughts about the original change in this pull request? It would be good to decide on it before creating the next release of the package.

nielsw2 commented 2 years ago

This looks good to me. Backwards compatibility is maintained so TeukolskyPointParticleMode[s,l,m,orbit] and TeukolskyPointParticleMode[s,l,m,0,0,orbit] both work.