Merge branch 'fix/review-part2' into 'develop'

whaeck · whaeck · commit be4cc56a2388 · 2026-02-02T19:15:23.000Z
Fix/review part2

See merge request njoy/dryad!130
diff --git a/docs/src/dryad/thermal.rst b/docs/src/dryad/thermal.rst
@@ -9,3 +9,4 @@ thermal
 
    thermal/TabulatedDebyeWallerIntegral
    thermal/IncoherentElasticScattering
+   thermal/TabulatedEffectiveTemperature
diff --git a/docs/src/dryad/thermal/TabulatedEffectiveTemperature.rst b/docs/src/dryad/thermal/TabulatedEffectiveTemperature.rst
@@ -0,0 +1,37 @@
+.. currentmodule:: njoy.dryad.thermal
+
+TabulatedEffectiveTemperature
+=============================
+
+General information about this concept
+
+Constructor
+~~~~~~~~~~~
+.. autosummary::
+    :toctree:  generated/
+
+    TabulatedEffectiveTemperature
+
+Read-only Attributes
+~~~~~~~~~~~~~~~~~~~~
+.. autosummary::
+    :toctree: generated/
+
+    ~TabulatedEffectiveTemperature.moderator_temperatures
+    ~TabulatedEffectiveTemperature.values
+    ~TabulatedEffectiveTemperature.interpolants
+    ~TabulatedEffectiveTemperature.boundaries
+    ~TabulatedEffectiveTemperature.number_points
+    ~TabulatedEffectiveTemperature.number_regions
+    ~TabulatedEffectiveTemperature.lower_moderator_temperature_limit
+    ~TabulatedEffectiveTemperature.upper_moderator_temperature_limit
+    ~TabulatedEffectiveTemperature.is_linearised
+
+Methods
+~~~~~~~
+
+.. autosummary::
+    :toctree: generated/
+
+    ~TabulatedEffectiveTemperature.__call__
+    ~TabulatedEffectiveTemperature.linearise
diff --git a/src/njoy/dryad/thermal/TabulatedEffectiveTemperature/src/ctor.hpp b/src/njoy/dryad/thermal/TabulatedEffectiveTemperature/src/ctor.hpp
@@ -37,10 +37,10 @@ TabulatedEffectiveTemperature( std::vector< double > moderatorTemperatures,
                       std::move( boundaries ), std::move( interpolants ) ) {}
 
 /**
- *  @brief Constructor for a Debye-Waller integral table using a single interpolation zone
+ *  @brief Constructor for an effective temperature table using a single interpolation zone
  *
- *  @param moderatorTemperatures   the temperature values
- *  @param values                  the integral values
+ *  @param moderatorTemperatures   the moderator temperatures values
+ *  @param values                  the effective temperature values
  *  @param interpolant             the interpolation type of the data (default lin-lin)
  */
 TabulatedEffectiveTemperature( std::vector< double > moderatorTemperatures,

Original file line number	Diff line number	Diff line change
`@@ -9,3 +9,4 @@ thermal`
`9`	`9`
`10`	`10`	`thermal/TabulatedDebyeWallerIntegral`
`11`	`11`	`thermal/IncoherentElasticScattering`
	`12`	`+ thermal/TabulatedEffectiveTemperature`