refactor: Factoring hysteresis model out of TableRelativePermeabilityHysteresis

src/coreComponents/constitutive/CMakeLists.txt

@@ -15,8 +15,8 @@ set( constitutive_headers
      capillaryPressure/TableCapillaryPressure.hpp
      capillaryPressure/TableCapillaryPressureHelpers.hpp
      capillaryPressure/VanGenuchtenCapillaryPressure.hpp
-     capillaryPressure/capillaryPressureSelector.hpp
-     capillaryPressure/layouts.hpp
+     capillaryPressure/CapillaryPressureSelector.hpp
+     capillaryPressure/Layouts.hpp
      contact/ContactBase.hpp
      contact/CoulombContact.hpp
      contact/ContactSelector.hpp
@@ -82,18 +82,19 @@ set( constitutive_headers
      permeability/ProppantPermeability.hpp
      permeability/SlipDependentPermeability.hpp
      permeability/WillisRichardsPermeability.hpp
-     relativePermeability/RelpermDriver.hpp
-     relativePermeability/RelpermDriverRunTest.hpp
      relativePermeability/BrooksCoreyBakerRelativePermeability.hpp
      relativePermeability/BrooksCoreyRelativePermeability.hpp
+     relativePermeability/KilloughHysteresis.hpp     
      relativePermeability/RelativePermeabilityBase.hpp
      relativePermeability/RelativePermeabilityFields.hpp
      relativePermeability/RelativePermeabilityInterpolators.hpp
+     relativePermeability/RelpermDriver.hpp
+     relativePermeability/RelpermDriverRunTest.hpp
      relativePermeability/TableRelativePermeability.hpp
      relativePermeability/TableRelativePermeabilityHelpers.hpp
      relativePermeability/TableRelativePermeabilityHysteresis.hpp
      relativePermeability/VanGenuchtenBakerRelativePermeability.hpp
-     relativePermeability/layouts.hpp
+     relativePermeability/Layouts.hpp
      relativePermeability/RelativePermeabilitySelector.hpp
      solid/CompressibleSolid.hpp
      solid/ProppantSolid.hpp
@@ -206,17 +207,18 @@ set( constitutive_sources
      permeability/WillisRichardsPermeability.cpp
      relativePermeability/BrooksCoreyBakerRelativePermeability.cpp
      relativePermeability/BrooksCoreyRelativePermeability.cpp
+     relativePermeability/KilloughHysteresis.cpp     
      relativePermeability/RelativePermeabilityBase.cpp
-     relativePermeability/TableRelativePermeability.cpp
-     relativePermeability/TableRelativePermeabilityHelpers.cpp
-     relativePermeability/TableRelativePermeabilityHysteresis.cpp
-     relativePermeability/VanGenuchtenBakerRelativePermeability.cpp
      relativePermeability/RelpermDriver.cpp
      relativePermeability/RelpermDriverBrooksCoreyBakerRunTest.cpp
      relativePermeability/RelpermDriverBrooksCoreyRunTest.cpp
      relativePermeability/RelpermDriverVanGenuchtenBakerRunTest.cpp
      relativePermeability/RelpermDriverTableRelativeRunTest.cpp
      relativePermeability/RelpermDriverTableRelativeHysteresisRunTest.cpp
+     relativePermeability/TableRelativePermeability.cpp
+     relativePermeability/TableRelativePermeabilityHelpers.cpp
+     relativePermeability/TableRelativePermeabilityHysteresis.cpp
+     relativePermeability/VanGenuchtenBakerRelativePermeability.cpp
      solid/CompressibleSolid.cpp
      solid/CoupledSolidBase.cpp
      solid/ProppantSolid.cpp

src/coreComponents/constitutive/capillaryPressure/CapillaryPressureBase.hpp

@@ -21,7 +21,7 @@
 
 #include "common/DataLayouts.hpp"
 #include "constitutive/ConstitutiveBase.hpp"
-#include "constitutive/capillaryPressure/layouts.hpp"
+#include "constitutive/capillaryPressure/Layouts.hpp"
 #include "common/GEOS_RAJA_Interface.hpp"
 
 namespace geos

src/coreComponents/constitutive/capillaryPressure/CapillaryPressureFields.hpp

@@ -19,7 +19,7 @@
 #ifndef GEOS_CONSTITUTIVE_CAPILLARYPRESSURE_CAPILLARYPRESSUREFIELDS_HPP_
 #define GEOS_CONSTITUTIVE_CAPILLARYPRESSURE_CAPILLARYPRESSUREFIELDS_HPP_
 
-#include "constitutive/capillaryPressure/layouts.hpp"
+#include "constitutive/capillaryPressure/Layouts.hpp"
 #include "mesh/MeshFields.hpp"
 
 namespace geos

src/coreComponents/constitutive/capillaryPressure/TableCapillaryPressureHelpers.cpp

@@ -72,6 +72,29 @@ TableCapillaryPressureHelpers::validateCapillaryPressureTable( TableFunction con
 }
 
 
+void
+TableCapillaryPressureHelpers::validateCapillaryPressureTable( geos::TableFunction const & capPresTable,
+                                                               geos::string const & fullConstitutiveName,
+                                                               bool const capPresMustBeIncreasing,
+                                                               geos::real64 & phaseMax, geos::real64 & phaseMin )
+{
+
+  TableCapillaryPressureHelpers::validateCapillaryPressureTable( capPresTable, fullConstitutiveName, capPresMustBeIncreasing );
+  ArrayOfArraysView< real64 const > coords = capPresTable.getCoordinates();
+  arraySlice1d< real64 const > phaseVolFrac = coords[0];
+  phaseMin = phaseVolFrac[0];
+  phaseMax = phaseVolFrac[phaseVolFrac.size()-1];
+  arrayView1d< real64 const > const capPres = capPresTable.getValues();
+  for( localIndex i = 1; i < coords.sizeOfArray( 0 ); ++i )
+  {
+    if( isZero( capPres[i-1] ) && !isZero( capPres[i] ) )
+    {
+      phaseMin = phaseVolFrac[i-1];
+    }
+  }
+}
+
+
 } // namespace constitutive
 
 } // namespace geos

src/coreComponents/constitutive/capillaryPressure/TableCapillaryPressureHelpers.hpp

@@ -41,6 +41,14 @@ struct TableCapillaryPressureHelpers
                                        string const & fullConstitutiveName,
                                        bool const capPresMustBeIncreasing );
 
+
+  static
+  void validateCapillaryPressureTable( TableFunction const & capPresTable,
+                                       string const & fullConstitutiveName,
+                                       bool const capPresMustBeIncreasing,
+                                       real64 & phaseMax,
+                                       real64 & phaseMin );
+
 };
 
 } // namespace constitutive

src/coreComponents/constitutive/relativePermeability/BrooksCoreyBakerRelativePermeability.hpp

@@ -137,8 +137,20 @@ class BrooksCoreyBakerRelativePermeability : public RelativePermeabilityBase
     static constexpr char const * volFracScaleString() { return "volFracScale"; }
   };
 
+  real64 getWettingPhaseMinVolumeFraction() const override
+  {
+    integer ipWetting;
+    std::tie( ipWetting, std::ignore ) = phaseIndex( getPhaseOrder());
+    return m_phaseMinVolumeFraction[ipWetting];
+  }
+
+  real64 getNonWettingMinVolumeFraction() const override
+  {
+    integer ipNonWetting;
+    std::tie( std::ignore, ipNonWetting ) = phaseIndex( getPhaseOrder());
+    return m_phaseMinVolumeFraction[ipNonWetting];
+  };
 
-  arrayView1d< real64 const > getPhaseMinVolumeFraction() const override { return m_phaseMinVolumeFraction; };
 
 protected:
 

src/coreComponents/constitutive/relativePermeability/BrooksCoreyRelativePermeability.hpp

@@ -105,7 +105,19 @@ class BrooksCoreyRelativePermeability : public RelativePermeabilityBase
   } vieKeysBrooksCoreyRelativePermeability;
 //END_SPHINX_INCLUDE_01
 
-  arrayView1d< real64 const > getPhaseMinVolumeFraction() const override { return m_phaseMinVolumeFraction; };
+  real64 getWettingPhaseMinVolumeFraction() const override
+  {
+    integer ipWetting;
+    std::tie( ipWetting, std::ignore ) = phaseIndex( getPhaseOrder());
+    return m_phaseMinVolumeFraction[ipWetting];
+  }
+
+  real64 getNonWettingMinVolumeFraction() const override
+  {
+    integer ipNonWetting;
+    std::tie( std::ignore, ipNonWetting ) = phaseIndex( getPhaseOrder());
+    return m_phaseMinVolumeFraction[ipNonWetting];
+  };
 
 protected:
 

src/coreComponents/constitutive/relativePermeability/KilloughHysteresis.cpp

@@ -0,0 +1,59 @@
+/*
+ * ------------------------------------------------------------------------------------------------------------
+ * SPDX-License-Identifier: LGPL-2.1-only
+ *
+ * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
+ * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
+ * Copyright (c) 2018-2020 TotalEnergies
+ * Copyright (c) 2019-     GEOSX Contributors
+ * All rights reserved
+ *
+ * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
+ * ------------------------------------------------------------------------------------------------------------
+ */
+
+/***
+ *  @file KilloughHysteresis.hpp
+ */
+
+#include "KilloughHysteresis.hpp"
+
+
+namespace geos
+{
+
+using namespace dataRepository;
+
+namespace constitutive
+{
+
+
+void KilloughHysteresis::postProcessInput( real64 const & jerauldParam_a,
+                                           real64 const & jerauldParam_b,
+                                           real64 const & killoughCurvatureParamRelPerm )
+{
+  GEOS_THROW_IF( jerauldParam_a < 0,
+                 GEOS_FMT( "{}: the parameter {} must be positive",
+                           catalogName(),
+                           viewKeyStruct::jerauldParameterAString() ),
+                 InputError );
+
+  GEOS_THROW_IF( jerauldParam_b < 0,
+                 GEOS_FMT( "{}: the paramater {} must be postitive",
+                           catalogName(),
+                           viewKeyStruct::jerauldParameterBString() ),
+                 InputError );
+
+  GEOS_THROW_IF( killoughCurvatureParamRelPerm < 0,
+                 GEOS_FMT( "{}: the paramater {} must be postitive",
+                           catalogName(),
+                           viewKeyStruct::killoughCurvatureParameterString() ),
+                 InputError );
+
+}
+
+
+
+} //end namespace
+
+} //end namespace