refactor: Add instance generators for constitutive drivers by dkachuma · Pull Request #3687 · GEOS-DEV/GEOS

dkachuma · 2025-06-02T20:14:49Z

This PR replaces hardcoded constitutive driver test instances with an auto-generated CMake/JSON workflow. This significantly reduces boilerplate and makes adding new fluid or relative permeability models as simple as adding a single line to a JSON file.

Converted hardcoded driver test files into generic CMake templates (PVTDriverRunTestFluid.cpp.template, RelpermDriverRunTestRelPerm.cpp.template, and DriverDispatchTypeList.hpp.template).
Added kernelSpecs.json to centrally define and manage all fluid and relative permeability model combinations.
Modified the generateKernels function in GeosxMacros.cmake to accept a LIST_TEMPLATE argument for custom dispatch type lists.
Deleted redundant .cpp files in the constitutiveDrivers module, as these are now dynamically generated during the build step.

codecov · 2025-06-02T21:23:43Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.56%. Comparing base (c2768e6) to head (9aa9dbd).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3687   +/-   ##
========================================
  Coverage    57.56%   57.56%           
========================================
  Files         1235     1235           
  Lines       106973   106973           
========================================
  Hits         61578    61578           
  Misses       45395    45395

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…r-kernels

Copilot

Pull request overview

This PR refactors constitutive driver “runTest” explicit-instantiation boilerplate by switching from many hand-written .cpp instantiation translation units to CMake-driven generation from .cpp.template files plus a JSON spec. This is intended to make adding new constitutive models simpler and more uniform.

Changes:

Replace per-model explicit instantiation .cpp files (PVT + relperm) with generated sources driven by kernelSpecs.json.
Add driver-specific dispatch typelist template generation (DriverDispatchTypeList.hpp.template) and wire it into constitutiveDrivers/CMakeLists.txt.
Extend generateKernels() to accept an optional LIST_TEMPLATE for dispatch type list generation.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/coreComponents/constitutiveDrivers/relativePermeability/RelpermDriverVanGenuchtenStone2RunTest.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/relativePermeability/RelpermDriverVanGenuchtenBakerRunTest.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/relativePermeability/RelpermDriverTableRelativeRunTest.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/relativePermeability/RelpermDriverTableRelativeHysteresisRunTest.cpp	Removed explicit instantiation TU (previously also carried hysteresis trait specialization).
src/coreComponents/constitutiveDrivers/relativePermeability/RelpermDriverRunTestRelPerm.cpp.template	New template for generated relperm runTest explicit instantiation.
src/coreComponents/constitutiveDrivers/relativePermeability/RelpermDriverBrooksCoreyStone2RunTest.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/relativePermeability/RelpermDriverBrooksCoreyRunTest.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/kernelSpecs.json	Adds JSON spec listing relperm + fluid model instantiation combinations.
src/coreComponents/constitutiveDrivers/fluid/multiFluid/PVTDriverRunTestFluid.cpp.template	New template for generated PVT runTest explicit instantiation.
src/coreComponents/constitutiveDrivers/fluid/multiFluid/constant/PVTDriverRunTestInvariantImmiscibleFluid.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/fluid/multiFluid/compositional/PVTDriverRunTestCompositionalTwoPhasePhillipsBrine.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/fluid/multiFluid/compositional/PVTDriverRunTestCompositionalTwoPhaseLohrenzBrayClarkViscosity.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/fluid/multiFluid/compositional/PVTDriverRunTestCompositionalTwoPhaseConstantViscosity.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/fluid/multiFluid/compositional/PVTDriverRunTestCompositionalThreePhaseLohrenzBrayClarkViscosity.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/fluid/multiFluid/compositional/PVTDriverRunTestCompositionalKValuePhillipsBrine.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/fluid/multiFluid/compositional/PVTDriverRunTestCompositionalKValueLohrenzBrayClarkViscosity.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/fluid/multiFluid/CO2Brine/PVTDriverRunTestCO2BrinePhillipsThermalFluid.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/fluid/multiFluid/CO2Brine/PVTDriverRunTestCO2BrinePhillipsFluid.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/fluid/multiFluid/CO2Brine/PVTDriverRunTestCO2BrineEzrokhiThermalFluid.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/fluid/multiFluid/blackOil/PVTDriverRunTestDeadOilFluid.cpp	Removed explicit instantiation TU (now intended to be generated).
src/coreComponents/constitutiveDrivers/DriverDispatchTypeList.hpp.template	Adds constitutiveDrivers-specific dispatch typelist template for generated headers.
src/coreComponents/constitutiveDrivers/CMakeLists.txt	Wires kernel generation into constitutiveDrivers build and removes per-model instantiation sources.
src/cmake/GeosxMacros.cmake	Extends `generateKernels()` with `LIST_TEMPLATE` selection for dispatch type list generation.

Comments suppressed due to low confidence (1)

src/coreComponents/constitutiveDrivers/relativePermeability/RelpermDriverRunTestRelPerm.cpp.template:27

RelpermDriver::runTest relies on the HasHysteresis<RELPERM_TYPE> trait to decide whether to populate historical saturation fields. The previous dedicated instantiation TU for TableRelativePermeabilityHysteresis provided a specialization setting this trait to true, but the new generated instantiation file template does not, so hysteresis run-tests will silently run with the non-hysteresis path.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Initial plan * Fix typos in kernelSpecs embedded docs --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 24 out of 24 changed files in this pull request and generated 2 comments.

+     relativePermeability/RelpermDriverRunTestRelPerm.cpp.template)
+
+foreach( kernelTemplateFile ${kernelTemplateFileList} )
+  get_filename_component( jsonKey ${kernelTemplateFile} NAME_WE )


 // Hysteresis traits
-template< typename RELPERM_TYPE >
+template< typename RELPERM_TYPE, typename = void >
 struct HasHysteresis : std::false_type {};

+template< typename RELPERM_TYPE >
+struct HasHysteresis< RELPERM_TYPE, std::void_t< decltype(RELPERM_TYPE::viewKeyStruct::phaseHasHysteresisString()) > > : std::true_type {};


…r-kernels

joshua-white

Nice

dkachuma added 2 commits June 2, 2025 12:31

Add kernelSpec.json

52297bc

Add relative permeability template

9aa9dbd

dkachuma self-assigned this Jun 2, 2025

dkachuma added ci: run CUDA builds Allows to triggers (costly) CUDA jobs ci: run integrated tests Allows to run the integrated tests in GEOS CI flag: no rebaseline Does not require rebaseline ci: run code coverage enables running of the code coverage CI jobs labels Jun 2, 2025

dkachuma marked this pull request as ready for review June 2, 2025 20:16

dkachuma requested review from CusiniM, jhuang2601 and rrsettgast as code owners June 2, 2025 20:16

paveltomin approved these changes Sep 17, 2025

View reviewed changes

Merge branch 'develop' into dkachuma/refactor/auto-generate-pvt-drive…

481b3f6

…r-kernels

dkachuma requested review from OmarDuran, bd713, jafranc and joshua-white as code owners June 17, 2026 00:32

dkachuma marked this pull request as draft June 17, 2026 00:32

Merge develop

99d85bf

dkachuma added type: cleanup / refactor Non-functional change (NFC) flag: ready for review labels Jun 17, 2026

dkachuma marked this pull request as ready for review June 17, 2026 00:56

dkachuma added 2 commits June 16, 2026 19:56

Empty change

19576d0

Empty change

86ee137

dkachuma requested a review from Copilot June 17, 2026 00:57

Copilot started reviewing on behalf of dkachuma June 17, 2026 00:57 View session

Copilot AI reviewed Jun 17, 2026

View reviewed changes

Comment thread src/coreComponents/constitutiveDrivers/kernelSpecs.json

Comment thread src/coreComponents/constitutiveDrivers/DriverDispatchTypeList.hpp.template

dkachuma and others added 2 commits June 16, 2026 20:16

Add hysteresis check

8e77168

Potential fix for pull request finding

b4b3f39

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI mentioned this pull request Jun 17, 2026

Correct embedded documentation typos in kernelSpecs.json #4086

Merged

Correct embedded documentation typos in kernelSpecs.json (#4086)

62cb10e

* Initial plan * Fix typos in kernelSpecs embedded docs --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

dkachuma requested a review from Copilot June 17, 2026 01:21

Copilot started reviewing on behalf of dkachuma June 17, 2026 01:22 View session

Copilot AI reviewed Jun 17, 2026

View reviewed changes

Merge branch 'develop' into dkachuma/refactor/auto-generate-pvt-drive…

b359b85

…r-kernels

joshua-white approved these changes Jun 17, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Add instance generators for constitutive drivers#3687

refactor: Add instance generators for constitutive drivers#3687
dkachuma wants to merge 10 commits into
developfrom
dkachuma/refactor/auto-generate-pvt-driver-kernels

dkachuma commented Jun 2, 2025 •

edited

Loading

Uh oh!

codecov Bot commented Jun 2, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

joshua-white left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

dkachuma commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Jun 2, 2025

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

joshua-white left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dkachuma commented Jun 2, 2025 •

edited

Loading