From 3171c07c3e66a9b0cafea16c250037c888c3c2e0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marek=20Ne=C4=8Dada?= <marek.necada@aalto.fi>
Date: Tue, 26 Jul 2016 06:35:27 +0300
Subject: [PATCH] Very incomplete documentation for the translation
 coefficients.

Former-commit-id: 7c707f71ac39364be7cb628c074cfb777ea61a92
---
 qpms/qpms_p.py | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/qpms/qpms_p.py b/qpms/qpms_p.py
index 67b1304..4747be3 100644
--- a/qpms/qpms_p.py
+++ b/qpms/qpms_p.py
@@ -453,6 +453,27 @@ def a_q(m,n,μ,ν,q = None):
 # ZDE VYCHÁZEJÍ DIVNÁ ZNAMÉNKA
 #@jit
 def Ã(m,n,μ,ν,kdlj,θlj,φlj,r_ge_d,J):
+    """
+    The à translation coefficient for spherical vector waves.
+    
+    Parameters
+    ----------
+    m, n: int
+        The indices (degree and order) of the destination basis.
+    μ, ν: int
+        The indices of the source basis wave.
+    kdlj, θlj, φlj: float
+        The spherical coordinates of the relative position of
+        the new center vs. the old one (R_new - R_old);
+        the distance has to be already multiplied by the wavenumber!
+    r_ge_d: TODO
+    J: 1, 2, 3 or 4
+        Type of the wave in the old center.
+
+    Returns:
+    --------
+    TODO
+    """
     exponent=(math.lgamma(2*n+1)-math.lgamma(n+2)+math.lgamma(2*ν+3)-math.lgamma(ν+2) 
                 +math.lgamma(n+ν+m-μ+1)-math.lgamma(n-m+1)-math.lgamma(ν+μ+1)
                 +math.lgamma(n+ν+1) - math.lgamma(2*(n+ν)+1))
@@ -485,6 +506,27 @@ def Ã(m,n,μ,ν,kdlj,θlj,φlj,r_ge_d,J):
 # ZDE OPĚT JINAK ZNAMÉNKA než v Xu (J. comp. phys 127, 285)
 #@jit
 def B̃(m,n,μ,ν,kdlj,θlj,φlj,r_ge_d,J):
+    """
+    The B̃ translation coefficient for spherical vector waves.
+    
+    Parameters
+    ----------
+    m, n: int
+        The indices (degree and order) of the destination basis.
+    μ, ν: int
+        The indices of the source basis wave.
+    kdlj, θlj, φlj: float
+        The spherical coordinates of the relative position of
+        the new center vs. the old one (R_new - R_old);
+        the distance has to be already multiplied by the wavenumber!
+    r_ge_d: TODO
+    J: 1, 2, 3 or 4
+        Type of the wave in the old center.
+
+    Returns:
+    --------
+    TODO
+    """
     exponent=(math.lgamma(2*n+3)-math.lgamma(n+2)+math.lgamma(2*ν+3)-math.lgamma(ν+2) 
                 +math.lgamma(n+ν+m-μ+2)-math.lgamma(n-m+1)-math.lgamma(ν+μ+1)
                 +math.lgamma(n+ν+2) - math.lgamma(2*(n+ν)+3))