modified a few comments in baseline correction source code

(refs idaholab#296)
crswong888 · Aug 12, 2021 · 1cb6c3d · 1cb6c3d
1 parent ea755a6
commit 1cb6c3d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/include/functions/BaselineCorrection.h b/include/functions/BaselineCorrection.h
@@ -52,10 +52,10 @@ class BaselineCorrection : public Function
   /// adjusted (corrected) acceleration ordinates
   std::vector<Real> _adj_accel;
 
-  /// object to output linearly interpolated corrected acceleration ordinates
+  /// linear interpolation object is applied over adjusted acceleration, i.e., AFTER correction
   std::unique_ptr<LinearInterpolation> _linear_interp;
 
-  /// function value scale factor
+  /// function value scale factor - final output is scale_factor * _linear_interp(_time, _adj_accel)
   const Real & _scale_factor;
 
 private:

diff --git a/include/utils/BaselineCorrectionUtils.h b/include/utils/BaselineCorrectionUtils.h
@@ -27,8 +27,8 @@
  **/
 namespace BaselineCorrectionUtils
 {
-/// Evaluates an integral over a single time step with Newmark-beta method
-/// Also is used as simple trapezoidal rule when gamma = 0.5.
+/// Evaluates an integral over a single time step with Newmark-beta method. This reduces to a simple
+/// trapezoidal integration rule when gamma = 0.5 and is used as such for displacement fits.
 Real newmarkGammaIntegrate(const Real & u_ddot_old,
                            const Real & u_ddot,
                            const Real & u_dot_old,