Improve FreeFreeGauntFactor.__call__() docstring and update CHANGELOG.

cherab · Jan 27, 2022 · 0246b9d · 0246b9d
1 parent 95c89bc
commit 0246b9d
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,18 @@
 Project Changelog
 =================
 
-Release 1.3.0 (8 Dec 2021)
+Release 1.4.0 (TBD)
 -------------------
 
+Bug fixes:
+* Fix wavelength indexing in Bremsstrahlung emission model. (#352)
+
+New:
+* Add new classes for free-free Gaunt factors and improve accuracy of the Gaunt factor used in Bremsstrahlung emission model. (#352)
+
+Release 1.3.0 (8 Dec 2021)
+--------------------------
+
 API changes:
 * Use of Cherab's interpolators is now deprecated in favour of those upstream in Raysect.
 

diff --git a/cherab/core/atomic/gaunt.pyx b/cherab/core/atomic/gaunt.pyx
@@ -51,7 +51,13 @@ cdef class FreeFreeGauntFactor():
 
  def __call__(self, double zeff, double temperature, double wavelength):
  """
- Returns self.evaluate(zeff, temperature, wavelength).
+ Returns the temperature-averaged free-free Gaunt factor for the supplied parameters.
+
+ :param double zeff: Effective Z of the plasma.
+ :param double temperature: Electron temperature in eV.
+ :param double wavelength: Spectral wavelength.
+
+ :return: free-free Gaunt factor
  """
 
  return self.evaluate(zeff, temperature, wavelength)