Renamed RefDifference to RefVar (#612)

* Added sqrt for calcRefDiff. * Renamed RefDiff to RefStd * Updated tests for the refStd. * Renamed RefStd to RefVar.
mdolab · Mar 26, 2024 · fed0263 · fed0263
1 parent 7570ed7
commit fed0263
Show file tree

Hide file tree

Showing 19 changed files with 41 additions and 42 deletions.
diff --git a/src/adjoint/DAObjFunc/DAObjFunc.C b/src/adjoint/DAObjFunc/DAObjFunc.C
@@ -56,8 +56,8 @@ DAObjFunc::DAObjFunc(
         objFuncCellValues_[idxI] = 0.0;
     }
 
-    calcRefDiffSquare_ = objFuncDict_.lookupOrDefault<label>("calcRefDiffSquare", 0);
-    if (calcRefDiffSquare_)
+    calcRefVar_ = objFuncDict_.lookupOrDefault<label>("calcRefVar", 0);
+    if (calcRefVar_)
     {
         objFuncDict_.readEntry<scalarList>("ref", ref_);
     }
@@ -318,15 +318,15 @@ scalar DAObjFunc::getObjFuncValue()
     return objFuncValue_;
 }
 
-void DAObjFunc::calcRefDiffSquare(scalar& objFuncValue)
+void DAObjFunc::calcRefVar(scalar& objFuncValue)
 {
     /*
     Description:
         Call the variable difference with respect to a given reference and take a square of it.
-        This can be used in FIML. This function is for calcRefDiffSquare_ == 1
+        This can be used in FIML. This function is for calcRefVar == 1
     */
 
-    if (calcRefDiffSquare_)
+    if (calcRefVar_)
     {
         if (ref_.size() == 1)
         {
@@ -338,7 +338,6 @@ void DAObjFunc::calcRefDiffSquare(scalar& objFuncValue)
             objFuncValue = (objFuncValue - ref_[idxI]) * (objFuncValue - ref_[idxI]);
         }
     }
-
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

diff --git a/src/adjoint/DAObjFunc/DAObjFunc.H b/src/adjoint/DAObjFunc/DAObjFunc.H
@@ -93,9 +93,9 @@ protected:
     List<List<word>> objFuncConInfo_;
 
     /// whether to calculate (obj-ref)^2
-    label calcRefDiffSquare_;
+    label calcRefVar_;
 
-    /// if calcRefDiffSquare_ is True, set the reference value list
+    /// if calcRefVar_ is True, set the reference value list
     scalarList ref_;
 
 public:
@@ -243,8 +243,8 @@ public:
     /// whether to compute reference coefficients for special objFunc treatment such as totalPressureRatio
     label calcRefCoeffs = 1;
 
-    /// calculate the varDiffSquare
-    void calcRefDiffSquare(scalar& objFuncValue);
+    /// calculate (var-ref)^2
+    void calcRefVar(scalar& objFuncValue);
 };
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

diff --git a/src/adjoint/DAObjFunc/DAObjFuncCenterOfPressure.C b/src/adjoint/DAObjFunc/DAObjFuncCenterOfPressure.C
@@ -128,8 +128,8 @@ void DAObjFuncCenterOfPressure::calcObjFunc(
 
     objFuncValue = scale_ * (weightedPressure / totalPressure + (center_ & axis_));
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncForce.C b/src/adjoint/DAObjFunc/DAObjFuncForce.C
@@ -191,8 +191,8 @@ void DAObjFuncForce::calcObjFunc(
     // need to reduce the sum of force across all processors
     reduce(objFuncValue, sumOp<scalar>());
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncLocation.C b/src/adjoint/DAObjFunc/DAObjFuncLocation.C
@@ -219,8 +219,8 @@ void DAObjFuncLocation::calcObjFunc(
                                           << abort(FatalError);
     }
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncMass.C b/src/adjoint/DAObjFunc/DAObjFuncMass.C
@@ -96,8 +96,8 @@ void DAObjFuncMass::calcObjFunc(
     // need to reduce the sum of force across all processors
     reduce(objFuncValue, sumOp<scalar>());
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncMassFlowRate.C b/src/adjoint/DAObjFunc/DAObjFuncMassFlowRate.C
@@ -119,8 +119,8 @@ void DAObjFuncMassFlowRate::calcObjFunc(
     // need to reduce the sum of force across all processors
     reduce(objFuncValue, sumOp<scalar>());
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncMeshQualityKS.C b/src/adjoint/DAObjFunc/DAObjFuncMeshQualityKS.C
@@ -219,8 +219,8 @@ void DAObjFuncMeshQualityKS::calcObjFunc(
 
     objFuncValue = log(objFuncValue) / coeffKS_;
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncMoment.C b/src/adjoint/DAObjFunc/DAObjFuncMoment.C
@@ -165,8 +165,8 @@ void DAObjFuncMoment::calcObjFunc(
     // need to reduce the sum of force across all processors
     reduce(objFuncValue, sumOp<scalar>());
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncPatchMean.C b/src/adjoint/DAObjFunc/DAObjFuncPatchMean.C
@@ -132,8 +132,8 @@ void DAObjFuncPatchMean::calcObjFunc(
     // need to reduce the sum of force across all processors
     reduce(objFuncValue, sumOp<scalar>());
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncPower.C b/src/adjoint/DAObjFunc/DAObjFuncPower.C
@@ -168,8 +168,8 @@ void DAObjFuncPower::calcObjFunc(
     // need to reduce the sum of force across all processors
     reduce(objFuncValue, sumOp<scalar>());
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncTotalPressure.C b/src/adjoint/DAObjFunc/DAObjFuncTotalPressure.C
@@ -132,8 +132,8 @@ void DAObjFuncTotalPressure::calcObjFunc(
     // need to reduce the sum of force across all processors
     reduce(objFuncValue, sumOp<scalar>());
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncTotalPressureRatio.C b/src/adjoint/DAObjFunc/DAObjFuncTotalPressureRatio.C
@@ -217,8 +217,8 @@ void DAObjFuncTotalPressureRatio::calcObjFunc(
         }
     }
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncTotalTemperatureRatio.C b/src/adjoint/DAObjFunc/DAObjFuncTotalTemperatureRatio.C
@@ -207,8 +207,8 @@ void DAObjFuncTotalTemperatureRatio::calcObjFunc(
         }
     }
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncVariableVolSum.C b/src/adjoint/DAObjFunc/DAObjFuncVariableVolSum.C
@@ -167,8 +167,8 @@ void DAObjFuncVariableVolSum::calcObjFunc(
 
     objFuncValue /= totalVol;
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncVonMisesStressKS.C b/src/adjoint/DAObjFunc/DAObjFuncVonMisesStressKS.C
@@ -121,8 +121,8 @@ void DAObjFuncVonMisesStressKS::calcObjFunc(
 
     objFuncValue = log(objValTmp) / coeffKS_;
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/src/adjoint/DAObjFunc/DAObjFuncWallHeatFlux.C b/src/adjoint/DAObjFunc/DAObjFuncWallHeatFlux.C
@@ -246,8 +246,8 @@ void DAObjFuncWallHeatFlux::calcObjFunc(
     // need to reduce the sum of force across all processors
     reduce(objFuncValue, sumOp<scalar>());
 
-    // check if we need to calculate refDiffSquare.
-    this->calcRefDiffSquare(objFuncValue);
+    // check if we need to calculate refDiff.
+    this->calcRefVar(objFuncValue);
 
     return;
 }

diff --git a/tests/runTests_DAPimpleFoam.py b/tests/runTests_DAPimpleFoam.py
@@ -104,7 +104,7 @@
                 "center": [0.25, 0.0, 0.05],
                 "scale": 1.0,
                 "addToAdjoint": True,
-                "calcRefDiffSquare": True,
+                "calcRefVar": True,
                 "ref": [0.1, 0.05, 0.04, 0.02, 0.02, 0.01, 0.0, -0.01, -0.01, -0.02]
             }
         }

diff --git a/tests/runTests_DASimpleFoamAD.py b/tests/runTests_DASimpleFoamAD.py
@@ -130,7 +130,7 @@
                 "center": [0.25, 0.0, 0.05],
                 "scale": 1.0 / (0.5 * U0 * U0 * A0 * 1.0),
                 "addToAdjoint": True,
-                "calcRefDiffSquare": True,
+                "calcRefVar": True,
                 "ref": [0.1]
             }
         },