[skip ci] Updated CHANGELOG for CommonMath.hpp.

nkoukpaizan · nkoukpaizan · commit 3ab969c4ed14 · 2025-12-12T12:10:25.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -37,6 +37,7 @@
 - Added support for DependencyTracking::Variable in PowerElectronics models.
 - Updated Jacobian value storage from `ScalarT` to `RealT`.
 - Added a header file defining constants to be used throughout the code.
+- Added a header file defining common math functions (e.g., sigmoid) to be used throughout the code.
 
 ## v0.1
 
diff --git a/GridKit/CommonMath.hpp b/GridKit/CommonMath.hpp
@@ -14,8 +14,9 @@ namespace GridKit
      *
      * @note The sigmoid constant (mu) value of the constant to balance accuracy
      * and finite derivatives. Large values more closely approximate a step
-     * function, but lead to inf or NaN derivatives. The value of 240 corresponds
-     * to a time step of 1/4 of a 60Hz cycle.
+     * function, but lead to inf or NaN derivatives. 
+     * The value of 240 corresponds to a time step of 1/4 of a 60Hz cycle.
+     * From experiments, numerical derivatives break down for mu above 700.
      *
      * @tparam ScalarT - scalar data type
      *

Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,9 @@ namespace GridKit`
`14`	`14`	`*`
`15`	`15`	`* @note The sigmoid constant (mu) value of the constant to balance accuracy`
`16`	`16`	`* and finite derivatives. Large values more closely approximate a step`
`17`		`- * function, but lead to inf or NaN derivatives. The value of 240 corresponds`
`18`		`- * to a time step of 1/4 of a 60Hz cycle.`
	`17`	`+ * function, but lead to inf or NaN derivatives.`
	`18`	`+ * The value of 240 corresponds to a time step of 1/4 of a 60Hz cycle.`
	`19`	`+ * From experiments, numerical derivatives break down for mu above 700.`
`19`	`20`	`*`
`20`	`21`	`* @tparam ScalarT - scalar data type`
`21`	`22`	`*`