Merge pull request #715 from dogukanteber/clean-up

Simplify `ParentLayer.cpp` and `SnowLayer.cpp`
We noticed some repetition in function used for calculating heat capacity and thermal conductivity in `ParentLayer.cpp` and `SnowLayer.cpp` which was unclear at initial inspection. We realized this is due to the way these functions are called indiscriminately of layer type (soil, snow, rock/parent) within `TemperatureUpdator.cpp` and any changes to this structure would require serious refactoring of the code. As this approach does not require significantly more computation, we have left this as it is, and instead cleaned up some of the code and added comments to make this clearer to future users.

result.pdf showed no change between current version of master as expected.

Author: Benjamin-Maglio

src/ParentLayer.cpp

@@ -27,32 +27,35 @@ void ParentLayer::updateProperty() {
   vhcsolid = 2700000;
 };
 
-// get frozen layer specific heat capcity
+// Note: Though the following functions return the same value,
+// they require different names to work inside TemperatureUpdator.cpp
+// where these will be called by name and not by layer type. 
+// Hence they must match with the functions used in Layer.cpp
+// and SoilLayer.cpp.
+
+// get frozen layer volumetric heat capacity
 double ParentLayer::getFrzVolHeatCapa() {
-  double vhc = vhcsolid ;
-  return vhc;
+  return vhcsolid;
 };
 
+// get unfrozen layer volumetric heat capacity
 double ParentLayer::getUnfVolHeatCapa() {
-  double vhc= vhcsolid ;
-  return vhc;
+  return vhcsolid;
 };
 
+// get mixed (partially frozen) layer volumetric heat capacity
 double ParentLayer::getMixVolHeatCapa() {
-  double vhc= vhcsolid ;
-  return vhc;
+  return vhcsolid;
 };
 
 // get frozen layer thermal conductivity
 double ParentLayer::getFrzThermCond() {
-  double tc=tcsolid;
-  return tc;
+  return tcsolid;
 };
 
 // get unfrozen layer thermal conductivity
 double ParentLayer::getUnfThermCond() {
-  double tc=tcsolid;
-  return tc;
+  return tcsolid;
 };
 
 // get albedo of visible radiation

src/SnowLayer.cpp

@@ -102,34 +102,21 @@ double SnowLayer::getThermCond() {
   return tc;
 }
 
-// FIX THIS: THESE 3 functions see to be identical???
+// Note: Though the following functions return the same value,
+// they require different names to work inside TemperatureUpdator.cpp
+// where these will be called by name and not by layer type. 
+// Hence they must match with the functions used in Layer.cpp
+// and SoilLayer.cpp.
+
 double SnowLayer::getFrzVolHeatCapa() {
-  if (dz != 0) {
-    // FIX THIS: divide by zero error when there is no thickness!
-    double vhc = SHCICE * ice/dz;
-    return vhc;
-  } else {
-    return 0;
-  }
+  return (dz != 0) ? (SHCICE * ice/dz) : 0;
 };
 
 double SnowLayer::getUnfVolHeatCapa() {
-  if (dz != 0) {
-    // FIX THIS: divide by zero error when there is no thickness!
-    double vhc = SHCICE * ice/dz;
-    return vhc;
-  } else {
-    return 0;
-  }
+  return (dz != 0) ? (SHCICE * ice/dz) : 0;
 };
 
 double SnowLayer::getMixVolHeatCapa() {
-  if (dz != 0) {
-    // FIX THIS: divide by zero error when there is no thickness!
-    double vhc = SHCICE * ice/dz;
-    return vhc;
-  } else {
-    return 0;
-  }
+  return (dz != 0) ? (SHCICE * ice/dz) : 0;
 };