Some renaming of member variables

Author: Roberto Di Remigio

src/green/SphericalDiffuse.hpp

@@ -82,27 +82,27 @@ class SphericalDiffuse : public GreensFunction<Numerical, ProfilePolicy>
 {
 public:
     /*!
-     * \param[in] eL left-side dielectric constant
-     * \param[in] eR right-side dielectric constant
+     * \param[in] e1 left-side dielectric constant
+     * \param[in] e2 right-side dielectric constant
      * \param[in] w width of the interface layer
      * \param[in] c center of the diffuse layer
      */
-    SphericalDiffuse(double eL, double eR, double w, double c) : GreensFunction<Numerical, ProfilePolicy>(false)
+    SphericalDiffuse(double e1, double e2, double w, double c) : GreensFunction<Numerical, ProfilePolicy>(false)
     {
-        initProfilePolicy(eL, eR, w, c);
+        initProfilePolicy(e1, e2, w, c);
         initSphericalDiffuse();
     }
     /*!
-     * \param[in] eL left-side dielectric constant
-     * \param[in] eR right-side dielectric constant
+     * \param[in] e1 left-side dielectric constant
+     * \param[in] e2 right-side dielectric constant
      * \param[in] w width of the interface layer
      * \param[in] c center of the diffuse layer
      * \param[in] diag strategy to calculate the diagonal elements of the boundary integral operator
      */
-    SphericalDiffuse(double eL, double eR, double w, double c, DiagonalIntegrator * diag)
+    SphericalDiffuse(double e1, double e2, double w, double c, DiagonalIntegrator * diag)
         : GreensFunction<Numerical, ProfilePolicy>(false, diag)
     {
-        initProfilePolicy(eL, eR, w, c);
+        initProfilePolicy(e1, e2, w, c);
         initSphericalDiffuse();
     }
     virtual ~SphericalDiffuse() {}
@@ -243,13 +243,13 @@ class SphericalDiffuse : public GreensFunction<Numerical, ProfilePolicy>
         return os;
     }
     /*!
-     * \param[in] eL left-side dielectric constant
-     * \param[in] eR right-side dielectric constant
+     * \param[in] e1 left-side dielectric constant
+     * \param[in] e2 right-side dielectric constant
      * \param[in] w width of the interface layer
      * \param[in] c center of the diffuse layer
      */
-    void initProfilePolicy(double eL, double eR, double w, double c)
-    { this->profile_ = ProfilePolicy(eL, eR, w, c); }
+    void initProfilePolicy(double e1, double e2, double w, double c)
+    { this->profile_ = ProfilePolicy(e1, e2, w, c); }
     /*! This calculates all the components needed to evaluate the Green's function */
     void initSphericalDiffuse();
 

src/green/TanhSphericalDiffuse.hpp

@@ -352,11 +352,13 @@ namespace
 {
     IGreensFunction * createTanhSphericalDiffuse(const greenData & _data)
     {
-        double eL, eR, w, c; // To be read from _data
-        eL = _data.epsilon2, eR = _data.epsilon1, w = _data.width, c = _data.center;
+        double e1 = _data.epsilon1;
+        double e2 = _data.epsilon2;
+        double w = _data.width;
+        double c = _data.center;
         DiagonalIntegrator * integrator =
 		DiagonalIntegratorFactory::TheDiagonalIntegratorFactory().createDiagonalIntegrator(_data.integratorType);
-        return new TanhSphericalDiffuse(eL, eR, w, c, integrator);
+        return new TanhSphericalDiffuse(e1, e2, w, c, integrator);
     }
     const std::string TANHSPHERICALDIFFUSE("TANHSPHERICALDIFFUSE");
     const bool registeredTanhSphericalDiffuse =

src/green/dielectric_profile/TanhDiffuse.hpp

@@ -40,32 +40,33 @@
 class TanhDiffuse
 {
 private:
-    double epsilonLeft_;
-    double epsilonRight_;
+    double epsilon1_;
+    double epsilon2_;
     double width_;
     double center_;
     double value(double point) const {
+        double epsPlus = (epsilon1_ + epsilon2_) / 2.0;
+        double epsMinus = (epsilon2_ - epsilon1_) / 2.0;
         double tanh_r = std::tanh((point - center_) / width_);
-        return (0.5 * (epsilonLeft_ + epsilonRight_)
-                + 0.5 * (epsilonRight_ - epsilonLeft_) * tanh_r);     //epsilon(r)
+        return (epsPlus + epsMinus * tanh_r); //epsilon(r)
     }
     double derivative(double point) const {
+        double factor = (epsilon1_ - epsilon2_) / (2.0 * width_);
         double tanh_r = std::tanh((point - center_) / width_);
-        return (0.5 * (epsilonLeft_ - epsilonRight_)
-                * ( 1 - tanh_r * tanh_r) / width_); //first derivative of epsilon(r)
+        return (factor * (1 - std::pow(tanh_r, 2))); //first derivative of epsilon(r)
     }
     std::ostream & printObject(std::ostream & os)
     {
-        os << "Permittivity inside  = " << epsilonLeft_  << std::endl;
-        os << "Permittivity outside = " << epsilonRight_ << std::endl;
-        os << "Profile center       = " << center_       << std::endl;
-        os << "Profile width        = " << width_;
+        os << "Permittivity inside  = " << epsilon1_ << std::endl;
+        os << "Permittivity outside = " << epsilon2_ << std::endl;
+        os << "Profile width        = " << width_    << std::endl;
+        os << "Profile center       = " << center_;
         return os;
     }
 public:
     TanhDiffuse() {}
-    TanhDiffuse(double eL, double eR, double w, double c) :
-        epsilonLeft_(eL), epsilonRight_(eR), width_(w), center_(c) {}
+    TanhDiffuse(double e1, double e2, double w, double c) :
+        epsilon1_(e1), epsilon2_(e2), width_(w), center_(c) {}
     /*! The permittivity profile of the transition layer
      *  \param[out]  e the value of the dielectric constant at point r
      *  \param[out] de the value of the derivative of the dielectric constant
@@ -77,8 +78,8 @@ class TanhDiffuse
         e = value(r);
         de = derivative(r);
     }
-    double epsilonLeft() const { return epsilonLeft_; }
-    double epsilonRight() const { return epsilonRight_; }
+    double epsilon1() const { return epsilon1_; }
+    double epsilon2() const { return epsilon2_; }
     double width() const { return width_; }
     double center() const { return center_; }
     friend std::ostream & operator<<(std::ostream & os, TanhDiffuse & th) {

tests/green/green_tanh_spherical_diffuse.cpp

@@ -16,16 +16,18 @@
 #include "TanhSphericalDiffuse.hpp"
 
 struct TanhSphericalDiffuseTest {
-    double epsInside, epsOutside, sphereRadius, width;
+    double eps1, eps2, sphereRadius, width;
     double inside_reference, outside_reference;
     double deriv_inside_reference, deriv_outside_reference;
     Eigen::Vector3d sphereCenter;
     Eigen::Vector3d source1, probe1, sourceNormal1, probeNormal1;
     Eigen::Vector3d source2, probe2, sourceNormal2, probeNormal2;
     TanhSphericalDiffuseTest() { SetUp(); }
     void SetUp() {
-        epsInside = 80.0;
-        epsOutside = 2.0;
+        // High dielectric constant inside
+        eps1 = 80.0;
+        // Low dielectric constant outside
+        eps2 = 2.0;
 	    sphereCenter << 0.0, 0.0, 0.0;
         sphereRadius = 100.0;
 	    width = 5.0;
@@ -61,7 +63,7 @@ BOOST_FIXTURE_TEST_SUITE(TanhSphericalDiffuse1, TanhSphericalDiffuseTest)
  */
 BOOST_FIXTURE_TEST_CASE(inside, TanhSphericalDiffuseTest)
 {
-    TanhSphericalDiffuse gf(epsInside, epsOutside, width, sphereRadius);
+    TanhSphericalDiffuse gf(eps1, eps2, width, sphereRadius);
     double value = inside_reference;
     double gf_value = gf.function(source1, probe1);
     BOOST_TEST_MESSAGE("value    = " << std::setprecision(std::numeric_limits<long double>::digits10) << value);
@@ -87,7 +89,7 @@ BOOST_FIXTURE_TEST_CASE(inside, TanhSphericalDiffuseTest)
  */
 BOOST_FIXTURE_TEST_CASE(outside, TanhSphericalDiffuseTest)
 {
-    TanhSphericalDiffuse gf(epsInside, epsOutside, width, sphereRadius);
+    TanhSphericalDiffuse gf(eps1, eps2, width, sphereRadius);
     double value = outside_reference;
     double gf_value = gf.function(source2, probe2);
     BOOST_TEST_MESSAGE("value    = " << std::setprecision(std::numeric_limits<long double>::digits10) << value);