refactor: Factoring hysteresis model out of `TableRelativePermeabilityHysteresis` #2207

jafranc · 2022-12-09T20:34:57Z

Refactor TableRelativePermeabilityHysteresis in preparation for #2159.
A KilloughHysteresis class will be created taking responsabilities for:

compute portion of trapped phase
store and provide access to Killough model parameters (jerauld coeff, curvature coeff, reversal buffers)
define HystersisCurve type storing major point of Hysteresis curve in a fashion of {sat,value} pair for all three points.

The KilloughHysteresis could also be responsible for computing Land Coefficient and all imbibition values as it is specific to the model how to compute these intermediate scanning curves. It can also be specialized further down to have a KilloughHysteresisRelativePermeability and KilloughHysteresisCapillaryPressure.

Eventually if new model improving capillary pressure treatment ( e.g Kleppe model [2]), it can be turn into a more templatized design.

Additionally,

revise unitTest for TableRelativePermeabilityHysteresis

Rebaseline done in GEOS-DEV/integratedTests#24

…curves instead of tables

# Conflicts: # src/coreComponents/constitutive/CMakeLists.txt # src/coreComponents/constitutive/capillaryPressure/CapillaryPressureBase.cpp # src/coreComponents/constitutive/capillaryPressure/CapillaryPressureExtrinsicData.hpp # src/coreComponents/constitutive/relativePermeability/RelativePermeabilityExtrinsicData.hpp # src/coreComponents/constitutive/relativePermeability/TableRelativePermeabilityHysteresis.cpp # src/coreComponents/constitutive/thermalConductivity/MultiPhaseThermalConductivityFields.hpp # src/coreComponents/constitutive/thermalConductivity/SinglePhaseThermalConductivityFields.hpp # src/coreComponents/constitutive/thermalConductivity/ThermalConductivityFields.hpp # src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp

jafranc · 2023-10-12T20:34:02Z

We face some GPU issue IIRC, let us fix that soon

paveltomin · 2023-12-05T01:24:51Z

We face some GPU issue IIRC, let us fix that soon

any update?

rrsettgast · 2024-12-17T17:23:54Z

@jafranc Can you merge develop into this and one of us will tackle the GPU compilation issues?

…esis # Conflicts: # integratedTests # src/coreComponents/constitutive/CMakeLists.txt # src/coreComponents/constitutive/relativePermeability/TableRelativePermeabilityHysteresis.cpp # src/coreComponents/constitutive/relativePermeability/TableRelativePermeabilityHysteresis.hpp # src/coreComponents/constitutive/thermalConductivity/SinglePhaseThermalConductivityFields.hpp # src/coreComponents/constitutiveDrivers/relativePermeability/RelpermDriverRunTest.hpp # src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.hpp # src/coreComponents/physicsSolvers/fluidFlow/IsothermalCompositionalMultiphaseFVMKernelUtilities.hpp # src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.hpp # src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp # src/coreComponents/schema/docs/TableRelativePermeabilityHysteresis.rst # src/coreComponents/schema/docs/TableRelativePermeabilityHysteresis_other.rst # src/coreComponents/schema/schema.xsd.other # src/coreComponents/unitTests/constitutiveTests/CMakeLists.txt

paveltomin · 2025-01-08T19:39:53Z

@jafranc seems to build ok, is it good to merge?

paveltomin · 2025-01-08T19:41:50Z

src/coreComponents/constitutive/capillaryPressure/TableCapillaryPressureHelpers.cpp

+                                                               geos::real64 & phaseMax, geos::real64 & phaseMin )
+{
+
+  TableCapillaryPressureHelpers::validateCapillaryPressureTable( capPresTable, fullConstitutiveName, capPresMustBeIncreasing );


what is happening here?

IIRC it is just refactoring but could easily be reverted to develop

seems the function calls itself recursively?

Not the same signature so different function no ?

oh man, this is high class :)

paveltomin · 2025-01-08T19:44:36Z

src/coreComponents/constitutive/relativePermeability/KilloughHysteresis.hpp

+      return m_isWetting;
+    }
+
+//    /**


src/coreComponents/constitutive/relativePermeability/KilloughHysteresis.hpp

…ysteresis.hpp

codecov · 2025-01-09T20:12:52Z

Codecov Report

Attention: Patch coverage is 73.63014% with 77 lines in your changes missing coverage. Please review.

Project coverage is 56.74%. Comparing base (93f0252) to head (34efee4).
Report is 5 commits behind head on develop.

Files with missing lines	Patch %	Lines
...rmeability/TableRelativePermeabilityHysteresis.hpp	72.72%	15 Missing ⚠️
...apillaryPressure/TableCapillaryPressureHelpers.cpp	0.00%	11 Missing ⚠️
...vers/relativePermeability/RelpermDriverRunTest.hpp	0.00%	8 Missing ⚠️
...meability/BrooksCoreyBakerRelativePermeability.hpp	0.00%	6 Missing ⚠️
...vePermeability/BrooksCoreyRelativePermeability.hpp	0.00%	6 Missing ⚠️
...eability/BrooksCoreyStone2RelativePermeability.hpp	0.00%	6 Missing ⚠️
...relativePermeability/TableRelativePermeability.hpp	0.00%	6 Missing ⚠️
...eability/VanGenuchtenBakerRelativePermeability.hpp	0.00%	6 Missing ⚠️
...ability/VanGenuchtenStone2RelativePermeability.hpp	0.00%	6 Missing ⚠️
...tiveDrivers/relativePermeability/RelpermDriver.cpp	0.00%	4 Missing ⚠️
... and 2 more

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2207      +/-   ##
===========================================
- Coverage    56.82%   56.74%   -0.08%     
===========================================
  Files         1154     1156       +2     
  Lines        99984    99950      -34     
===========================================
- Hits         56816    56720      -96     
- Misses       43168    43230      +62

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jafranc and others added 20 commits November 10, 2022 16:40

save commit before refactoring

87d210e

factor out Killough Parameters to be used by TableHysteresis

4e937e1

Adding TableCapillaryPressureHysteresis class

81a85cc

adding phaseVolTrapped to CapillaryBase + inheritance

162b899

adding Hysteresis capillary table

b4456bf

few correction/missing parts

fa48972

uncrustify + some corrections

35988c4

addding save converged state for capillary model

4e4956c

adding headers and minor fixes

67a3cf7

adding a test for capillary hysteresis

505d475

adapt test for hyst relperm

3da2cd5

uncrustify

a016798

uncrustified + bounded F ratio

c4c592e

added a Logic error

6701749

add flags logic and correct 2phase

21f6a3b

flags as cell-wise fields

3da4473

adding a test case

f766c68

clean capillaryPCHyst + fix few filename convention

63a086b

init KilloughHysteresis obj through relpermClass + usage of 3-points …

cc01813

…curves instead of tables

start revising unitest

c5ae8cd

jafranc mentioned this pull request Dec 9, 2022

Implement Killough Model for capillary hysteresis #2159

Draft

4 tasks

jafranc requested a review from francoishamon December 9, 2022 20:35

jafranc and others added 4 commits December 10, 2022 04:26

cleaning up interfaces

53e89f5

clean up post-merge

7ce9a1b

fix trapped fraction

1b60f12

jafranc changed the title ~~Jafranc/refactor/relperm hysteresis~~ Factoring hysteris model out of TableRelativePermeabilityHysteresis Dec 13, 2022

jacques added 3 commits December 13, 2022 18:25

make KilloughHysteresis a simple helpers class

1540d0d

reorderd messed ratio

fcf366b

some more comments and uncrustify

5067990

paveltomin added ci: run CUDA builds Allows to triggers (costly) CUDA jobs ci: run integrated tests Allows to run the integrated tests in GEOS CI and removed flag: ready for review labels Dec 14, 2023

paveltomin force-pushed the jafranc/refactor/relpermHysteresis branch from b9e1ae5 to fdbfbd1 Compare December 14, 2023 15:47

rrsettgast requested review from rrsettgast, CusiniM, corbett5, wrtobin, castelletto1, jhuang2601, paveltomin, ryar9534 and dkachuma as code owners December 3, 2024 20:15

jacquesn7 added 2 commits December 18, 2024 10:34

first post-merge fix

836422e

jafranc changed the title ~~Factoring hysteresis model out of TableRelativePermeabilityHysteresis~~ refactor: Factoring hysteresis model out of TableRelativePermeabilityHysteresis Dec 18, 2024

jacquesn7 added 2 commits December 19, 2024 12:09

forgot to register m_phaseHasHystersis flag array

26a514e

refactoring duplicate + enable STONEII use in Hysteresis

61fa74f

jafranc added flag: ready for review ci: run code coverage enables running of the code coverage CI jobs labels Dec 20, 2024

paveltomin reviewed Jan 8, 2025

View reviewed changes

paveltomin approved these changes Jan 8, 2025

View reviewed changes

jafranc commented Jan 9, 2025

View reviewed changes

src/coreComponents/constitutive/relativePermeability/KilloughHysteresis.hpp Outdated Show resolved Hide resolved

Update src/coreComponents/constitutive/relativePermeability/KilloughH…

34efee4

…ysteresis.hpp

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Factoring hysteresis model out of `TableRelativePermeabilityHysteresis` #2207

refactor: Factoring hysteresis model out of `TableRelativePermeabilityHysteresis` #2207

jafranc commented Dec 9, 2022 •

edited by francoishamon

Loading

jafranc commented Oct 12, 2023

paveltomin commented Dec 5, 2023

rrsettgast commented Dec 17, 2024

paveltomin commented Jan 8, 2025

paveltomin Jan 8, 2025

jafranc Jan 9, 2025

paveltomin Jan 9, 2025

jafranc Jan 9, 2025

paveltomin Jan 9, 2025

paveltomin Jan 8, 2025

jafranc Jan 9, 2025

codecov bot commented Jan 9, 2025

refactor: Factoring hysteresis model out of TableRelativePermeabilityHysteresis #2207

Are you sure you want to change the base?

refactor: Factoring hysteresis model out of TableRelativePermeabilityHysteresis #2207

Conversation

jafranc commented Dec 9, 2022 • edited by francoishamon Loading

jafranc commented Oct 12, 2023

paveltomin commented Dec 5, 2023

rrsettgast commented Dec 17, 2024

paveltomin commented Jan 8, 2025

paveltomin Jan 8, 2025

Choose a reason for hiding this comment

jafranc Jan 9, 2025

Choose a reason for hiding this comment

paveltomin Jan 9, 2025

Choose a reason for hiding this comment

jafranc Jan 9, 2025

Choose a reason for hiding this comment

paveltomin Jan 9, 2025

Choose a reason for hiding this comment

paveltomin Jan 8, 2025

Choose a reason for hiding this comment

jafranc Jan 9, 2025

Choose a reason for hiding this comment

codecov bot commented Jan 9, 2025

Codecov Report

refactor: Factoring hysteresis model out of `TableRelativePermeabilityHysteresis` #2207

refactor: Factoring hysteresis model out of `TableRelativePermeabilityHysteresis` #2207

jafranc commented Dec 9, 2022 •

edited by francoishamon

Loading