feat: Add immiscible multiphase flow package

.integrated_tests.yaml

@@ -1,6 +1,6 @@
 baselines:
   bucket: geosx
-  baseline: integratedTests/baseline_integratedTests-pr3450-9221-37d940c
+  baseline: integratedTests/baseline_integratedTests-pr3251-9308-16715ce
 allow_fail:
   all: ''
   streak: ''

BASELINE_NOTES.md

@@ -6,6 +6,10 @@ This file is designed to track changes to the integrated test baselines.
 Any developer who updates the baseline ID in the .integrated_tests.yaml file is expected to create an entry in this file with the pull request number, date, and their justification for rebaselining.
 These notes should be in reverse-chronological order, and use the following time format: (YYYY-MM-DD).
 
+PR #3251 (2024 12 12)
+=====================
+Added tests for the newly introduced immiscible fluild solver
+
 PR #3450 (2024-12-08)
 =====================
 Added test for explicit runge kutta sprinslider.

host-configs/Stanford/ubuntu22.cmake

@@ -0,0 +1,44 @@
+# file: your-platform.cmake
+
+# detect host and name the configuration file
+site_name(HOST_NAME)
+set(CONFIG_NAME "ubuntu22" CACHE PATH "")
+message("CONFIG_NAME = ${CONFIG_NAME}")
+
+# set paths to C, C++, and Fortran compilers. Note that while GEOS does not contain any Fortran code,
+# some of the third-party libraries do contain Fortran code. Thus a Fortran compiler must be specified.
+set(CMAKE_C_COMPILER "/usr/bin/gcc" CACHE PATH "")
+set(CMAKE_CXX_COMPILER "/usr/bin/g++" CACHE PATH "")
+set(CMAKE_Fortran_COMPILER "/usr/bin/gfortran" CACHE PATH "")
+set(ENABLE_FORTRAN OFF CACHE BOOL "" FORCE)
+
+# enable MPI and set paths to compilers and executable.
+# Note that the MPI compilers are wrappers around standard serial compilers.
+# Therefore, the MPI compilers must wrap the appropriate serial compilers specified
+# in CMAKE_C_COMPILER, CMAKE_CXX_COMPILER, and CMAKE_Fortran_COMPILER.
+set(ENABLE_MPI ON CACHE BOOL "")
+set(MPI_C_COMPILER "/usr/bin/mpicc" CACHE PATH "")
+set(MPI_CXX_COMPILER "/usr/bin/mpicxx" CACHE PATH "")
+set(MPI_Fortran_COMPILER "/usr/bin/mpifort" CACHE PATH "")
+set(MPIEXEC "/usr/bin/mpirun" CACHE PATH "")
+
+# define the path to blas and lapack
+#set( BLAS_LIBRARIES /home/rpiazza/lib/lapack-3.11.0-linux-x86_64/libblas.so CACHE PATH "" FORCE )
+#set( LAPACK_LIBRARIES /home/rpiazza/lib/lapack-3.11.0-linux-x86_64/liblapack.so  CACHE PATH "" FORCE )
+
+# disable CUDA and OpenMP
+set(ENABLE_CUDA OFF CACHE BOOL "" FORCE)
+set(ENABLE_OPENMP OFF CACHE BOOL "" FORCE)
+
+# enable PVTPackage
+set(ENABLE_PVTPackage ON CACHE BOOL "" FORCE)
+
+# enable tests
+set(ENABLE_GTEST_DEATH_TESTS ON CACHE BOOL "" FORCE )
+
+# define the path to your compiled installation directory
+set(GEOS_TPL_DIR "/home/rpiazza/two-phase/thirdPartyLibs/install-ubuntu22-debug" CACHE PATH "")
+#set(GEOSX_TPL_DIR "${GEOSX_TPL_DIR}" CACHE PATH "" FORCE)
+# let GEOS define some third party libraries information for you
+#include(${CMAKE_CURRENT_LIST_DIR}/tpls.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/../tpls.cmake)

inputFiles/immiscibleMultiphaseFlow/immiscibleTwoPhase_BuckleyLeverett/buckleyLeverett_base.xml

@@ -0,0 +1,181 @@
+<?xml version="1.0" ?>
+
+<Problem>
+  <!-- SPHINX_SOLVER -->
+  <Solvers>
+    <ImmiscibleMultiphaseFlow
+      name="FlowSolver"
+      logLevel="4"
+      discretization="TPFA"
+      temperature="300"
+      initialDt="0.001"
+      targetRegions="{ region }">
+      <NonlinearSolverParameters
+        newtonTol="1.0e-6"
+        newtonMaxIter="50"
+        maxTimeStepCuts="2"/>
+      <LinearSolverParameters
+        solverType="direct"
+        directParallel="0"  
+        logLevel="0"/>
+    </ImmiscibleMultiphaseFlow>
+  </Solvers>
+  <!-- SPHINX_SOLVER_END -->
+
+  <!-- SPHINX_NUMERICAL -->
+  <NumericalMethods>
+    <FiniteVolume>
+      <TwoPointFluxApproximation
+        name="TPFA"/>
+    </FiniteVolume>
+  </NumericalMethods>
+  <!-- SPHINX_NUMERICAL_END -->
+
+  <!-- SPHINX_ELEMENTREGIONS -->
+  <ElementRegions>
+    <CellElementRegion
+      name="region"
+      cellBlocks="{ cellBlock }"
+      materialList="{ fluid, rock, relperm }"/>
+  </ElementRegions>
+  <!-- SPHINX_ELEMENTREGIONS_END -->
+
+  <!-- SPHINX_MATERIAL -->
+  <Functions>
+    <TableFunction
+      name="densityTablePhase1"
+      coordinates="{ 0.0}"
+      values="{ 280 }" />
+    <TableFunction
+      name="densityTablePhase2"
+      coordinates="{ 0.0 }"
+      values="{ 992 }" />
+    <TableFunction
+      name="viscosityTablePhase1"
+      coordinates="{ 0.0}"
+      values="{ 0.000023 }" />                  
+    <TableFunction
+      name="viscosityTablePhase2"
+      coordinates="{ 0.0 }"
+      values="{ 0.00055 }" />
+ </Functions>
+
+  <Constitutive>
+    <CompressibleSolidConstantPermeability
+      name="rock"
+      solidModelName="nullSolid"
+      porosityModelName="rockPorosity"
+      permeabilityModelName="rockPerm"/>
+
+    <NullModel
+      name="nullSolid"/>
+
+    <PressurePorosity
+      name="rockPorosity"
+      defaultReferencePorosity="0.2"
+      referencePressure="1e7"
+      compressibility="1.0e-15"/>
+
+    <ConstantPermeability
+      name="rockPerm"
+      permeabilityComponents="{ 9.0e-13, 9.0e-13, 9.0e-13}"/>   
+
+    <BrooksCoreyRelativePermeability
+      name="relperm"
+      phaseNames="{ gas, water }"
+      phaseMinVolumeFraction="{ 0.0, 0.0 }"
+      phaseRelPermExponent="{ 3.5, 3.5 }"
+      phaseRelPermMaxValue="{ 1.0, 1.0 }"/>
+
+      <TwoPhaseFluid
+      name="fluid"
+      phaseNames="{gas, water}"
+      densityTableNames="{densityTablePhase1, densityTablePhase2}"    
+      viscosityTableNames="{viscosityTablePhase1, viscosityTablePhase2}" />
+  </Constitutive>
+  <!-- SPHINX_MATERIAL_END -->
+
+  <!-- SPHINX_BC --> 
+  <FieldSpecifications>
+    <FieldSpecification
+      name="initialPressure"
+      initialCondition="1"
+      setNames="{ all }"
+      objectPath="ElementRegions"
+      fieldName="pressure"
+      scale="1e7"/>
+
+    <FieldSpecification
+      name="initialSaturation_gas"
+      initialCondition="1"
+      setNames="{ all }"
+      objectPath="ElementRegions"
+      fieldName="phaseVolumeFraction"
+      component="0"
+      scale="0.0"/>
+
+    <FieldSpecification
+      name="initialSaturation_water"
+      initialCondition="1"
+      setNames="{ all }"
+      objectPath="ElementRegions"
+      fieldName="phaseVolumeFraction"
+      component="1"
+      scale="1.0"/>
+
+    <SourceFlux
+      name="sourceTerm"
+      objectPath="ElementRegions"
+      scale="-0.00007"
+      component="0"
+      setNames="{ source }"/>
+
+    <FieldSpecification
+      name="sinkTermPressure"
+      objectPath="ElementRegions"
+      fieldName="pressure"
+      scale="1e7"
+      setNames="{ sink }"/>
+
+    <FieldSpecification
+      name="sinkTermSaturation_gas"
+      setNames="{ sink }"
+      objectPath="ElementRegions"
+      fieldName="phaseVolumeFraction"
+      component="0"
+      scale="0.0"/>
+
+    <FieldSpecification
+      name="sinkTermComposition_water"
+      setNames="{ sink }"
+      objectPath="ElementRegions"
+      fieldName="phaseVolumeFraction"
+      component="1"
+      scale="1.0"/>    
+  </FieldSpecifications>
+  <!-- SPHINX_BC_END -->
+
+  <!-- SPHINX_OUTPUT -->  
+  <Outputs>
+    <VTK
+      name="vtkOutput"/>
+
+    <TimeHistory
+      name="timeHistoryOutput"
+      sources="{/Tasks/phaseVolumeFractionCollection}"
+      filename="saturationHistory" />
+
+    <Restart
+      name="restartOutput"/> 
+  </Outputs>
+  <!-- SPHINX_OUTPUT_END -->
+
+  <!-- SPHINX_TASKS --> 
+  <Tasks>
+    <PackCollection
+      name="phaseVolumeFractionCollection"
+      objectPath="ElementRegions/region/cellBlock"
+      fieldName="phaseVolumeFraction"/>
+  </Tasks>
+  <!-- SPHINX_TASKS_END -->   
+</Problem>

inputFiles/immiscibleMultiphaseFlow/immiscibleTwoPhase_BuckleyLeverett/buckleyLeverett_benchmark.xml

@@ -0,0 +1,61 @@
+<?xml version="1.0" ?>
+
+<Problem>
+  <Included>
+    <File name="./buckleyLeverett_base.xml"/>
+  </Included>
+
+  <!-- SPHINX_MESH -->
+  <Mesh>
+    <InternalMesh
+      name="mesh"
+      elementTypes="{ C3D8 }"
+      xCoords="{ 0, 0.1 }"
+      yCoords="{ 0, 0.00202683 }"
+      zCoords="{ 0, 1 }"
+      nx="{ 1000 }"
+      ny="{ 1 }"
+      nz="{ 1 }"
+      cellBlockNames="{ cellBlock }"/>
+  </Mesh>
+  <!-- SPHINX_MESH_END -->
+
+  <Geometry>
+    <Box
+      name="source"
+      xMin="{-0.00001, -0.00001, -0.00001}"
+      xMax="{ 0.00011, 1.00001, 1.00001}"/>
+
+    <Box
+      name="sink"
+      xMin="{ .09989, -0.00001, -0.00001}"
+      xMax="{ 0.10001, 1.00001, 1.00001}"/>
+  </Geometry>
+
+  <Events
+    maxTime="70.1">
+
+    <PeriodicEvent
+      name="outputs"
+      timeFrequency="1"
+      targetExactTimestep="1"
+      target="/Outputs/vtkOutput"/>
+
+    <PeriodicEvent
+      name="timeHistoryOutput"
+      timeFrequency="10"
+      targetExactTimestep="1"
+      target="/Outputs/timeHistoryOutput" />
+
+    <PeriodicEvent
+      name="timeHistoryCollection"
+      timeFrequency="10"
+      targetExactTimestep="1"
+      target="/Tasks/phaseVolumeFractionCollection" />
+
+    <PeriodicEvent
+      name="solverApplications"
+      maxEventDt="0.01"
+      target="/Solvers/FlowSolver"/>    
+  </Events>
+</Problem>

inputFiles/immiscibleMultiphaseFlow/immiscibleTwoPhase_CapillaryPressure/immiscibleTwoPhase_CapillaryPressure.ats

@@ -0,0 +1,18 @@
+from geos.ats.test_builder import TestDeck, RestartcheckParameters, generate_geos_tests
+
+restartcheck_params = {}
+restartcheck_params['atol'] = 1.0E-8
+restartcheck_params['rtol'] = 1.0E-8
+
+decks = [
+    TestDeck(
+        name="immiscibleTwoPhase_CapillaryPressure",
+        description=
+        'Test 2 fluids can mix based on capillary pressure.',
+        partitions=((1, 1, 1), ),
+        restart_step=0,
+        check_step=68,
+        restartcheck_params=RestartcheckParameters(**restartcheck_params))
+]
+
+generate_geos_tests(decks)