GEOS
HydrostaticPressureKernel.hpp
Go to the documentation of this file.
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2024 TotalEnergies
7  * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
8  * Copyright (c) 2023-2024 Chevron
9  * Copyright (c) 2019- GEOS/GEOSX Contributors
10  * All rights reserved
11  *
12  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
13  * ------------------------------------------------------------------------------------------------------------
14  */
15 
20 #ifndef GEOS_PHYSICSSOLVERS_FLUIDFLOW_COMPOSITIONAL_HYDROSTATICPRESSUREKERNEL_HPP
21 #define GEOS_PHYSICSSOLVERS_FLUIDFLOW_COMPOSITIONAL_HYDROSTATICPRESSUREKERNEL_HPP
22 
23 #include "common/DataTypes.hpp"
24 #include "constitutive/fluid/multifluid/Layouts.hpp"
25 #include "functions/TableFunction.hpp"
26 
27 namespace geos
28 {
29 
30 namespace isothermalCompositionalMultiphaseBaseKernels
31 {
32 
33 /******************************** HydrostaticPressureKernel ********************************/
34 
35 template< typename FLUID_WRAPPER >
36 struct HydrostaticPressureKernel
37 {
38  enum class ReturnType : integer
39  {
40  FAILED_TO_CONVERGE = 0,
41  DETECTED_MULTIPHASE_FLOW = 1,
42  SUCCESS = 2,
43  DETECTED_SINGLEPHASE_FLOW = 3,
44  PHASE_CORRECTION_NOT_NEEDED = 4
45  };
46 
47  static ReturnType
48  computeHydrostaticPressure( integer const & numComps,
49  integer const & numPhases,
50  integer const & ipGas,
51  integer const & ipOil,
52  integer const & ipWater,
53  integer const & ipInit,
54  arrayView1d< real64 const > const & phaseContacts,
55  arrayView1d< real64 const > const & phaseMinVolumeFraction,
56  integer const maxNumEquilIterations,
57  real64 const & equilTolerance,
58  real64 const (&gravVector)[ 3 ],
59  FLUID_WRAPPER fluidWrapper,
60  arrayView1d< TableFunction::KernelWrapper const > compFracTableWrappers,
61  TableFunction::KernelWrapper tempTableWrapper,
62  real64 const & refElevation,
63  arraySlice1d< real64 const, constitutive::multifluid::USD_PHASE - 2 > const & refPres,
64  arraySlice1d< real64 const > const & refPhaseMassDens,
65  real64 const & newElevation,
66  arraySlice1d< real64, constitutive::multifluid::USD_PHASE - 2 > const & newPres,
67  arraySlice1d< real64 > const & newPhaseMassDens,
68  arraySlice1d< real64, constitutive::multifluid::USD_PHASE - 2 > const & newPhaseDens,
69  arraySlice2d< real64, constitutive::multifluid::USD_PHASE_COMP - 2 > const & newPhaseCompFrac );
70 
71  static ReturnType
72  computeHydrostaticPressureAtMultipleElevations( localIndex const & startElevationIndex,
73  localIndex const & endElevationIndex,
74  integer const & numComps,
75  integer const & numPhases,
76  integer const & ipGas,
77  integer const & ipOil,
78  integer const & ipWater,
79  integer const & ipInit,
80  arrayView1d< real64 const > const & phaseContacts,
81  arrayView1d< real64 const > const & phaseMinVolumeFraction,
82  integer const & maxNumEquilIterations,
83  real64 const & equilTolerance,
84  real64 const (&gravVector)[ 3 ],
85  FLUID_WRAPPER fluidWrapper,
86  arrayView1d< TableFunction::KernelWrapper const > compFracTableWrappers,
87  TableFunction::KernelWrapper tempTableWrapper,
88  arrayView1d< arrayView1d< real64 > const > elevationValues,
89  arrayView3d< real64, constitutive::multifluid::USD_PHASE > const & pressureValues,
90  arrayView2d< real64 > const & phaseMassDens,
91  arrayView3d< real64, constitutive::multifluid::USD_PHASE > const & phaseDens,
92  arrayView4d< real64, constitutive::multifluid::USD_PHASE_COMP > const & phaseCompFrac );
93 
94  static ReturnType
95  marchBetweenTwoElevations( real64 const & startElevation,
96  real64 const & endElevation,
97  integer const & numComps,
98  integer const & numPhases,
99  integer const & ipGas,
100  integer const & ipOil,
101  integer const & ipWater,
102  integer const & ipInit,
103  arrayView1d< real64 const > const & phaseContacts,
104  arrayView1d< real64 const > const & phaseMinVolumeFraction,
105  integer const maxNumEquilIterations,
106  real64 const & equilTolerance,
107  real64 const (&gravVector)[ 3 ],
108  FLUID_WRAPPER fluidWrapper,
109  arrayView1d< TableFunction::KernelWrapper const > compFracTableWrappers,
110  TableFunction::KernelWrapper tempTableWrapper,
111  arrayView1d< arrayView1d< real64 > const > elevationValues,
112  arrayView3d< real64, constitutive::multifluid::USD_PHASE > const & pressureValues,
113  arrayView2d< real64 > const & phaseMassDens,
114  arrayView3d< real64, constitutive::multifluid::USD_PHASE > const & phaseDens,
115  arrayView4d< real64, constitutive::multifluid::USD_PHASE_COMP > const & phaseCompFrac );
116 
117  static ReturnType
118  launch( localIndex const & size,
119  integer const & numComps,
120  integer const & numPhases,
121  integer const & ipGas,
122  integer const & ipOil,
123  integer const & ipWater,
124  integer const & ipInit,
125  integer const & maxNumEquilIterations,
126  arrayView1d< real64 const > const & phaseContacts,
127  arrayView1d< real64 const > const & phaseMinVolumeFraction,
128  real64 const equilTolerance,
129  real64 const (&gravVector)[ 3 ],
130  real64 const & datumElevation,
131  real64 const & datumPres,
132  FLUID_WRAPPER fluidWrapper,
133  arrayView1d< TableFunction::KernelWrapper const > compFracTableWrappers,
134  TableFunction::KernelWrapper tempTableWrapper,
135  arrayView1d< arrayView1d< real64 > const > elevationValues,
136  arrayView3d< real64, constitutive::multifluid::USD_PHASE > const & pressureValues,
137  arrayView3d< real64, constitutive::multifluid::USD_PHASE > const & phaseDens,
138  arrayView4d< real64, constitutive::multifluid::USD_PHASE_COMP > const & phaseCompFrac );
139 
140  static ReturnType
141  phaseCorrection( integer const & numComps,
142  integer const & numPhases,
143  integer const & ipGas,
144  integer const & ipWater,
145  arrayView1d< real64 const > const & phaseMinVolumeFraction,
146  real64 const & pres,
147  real64 const & temp,
148  arraySlice1d< real64 const, compflow::USD_COMP - 1 > const & inputComposition,
149  arraySlice1d< real64 const, constitutive::multifluid::USD_PHASE - 2 > const & phaseFrac,
150  arraySlice1d< real64, compflow::USD_COMP - 1 > const & compFrac,
151  FLUID_WRAPPER fluidWrapper );
152 
153  static ReturnType
154  applyPhaseCorrection( integer const & numComps,
155  integer const & numPhases,
156  integer const & ip_phase,
157  integer const & ip_otherPhase,
158  real64 const & pres,
159  real64 const & temp,
160  arraySlice1d< real64 const, compflow::USD_COMP - 1 > const & inputComposition,
161  arraySlice1d< real64 const, compflow::USD_COMP - 1 > const & addedCompFrac,
162  arraySlice1d< real64, compflow::USD_COMP - 1 > const & compFrac,
163  FLUID_WRAPPER fluidWrapper );
164 
165  static void mixingStep( integer const & numComps,
166  real64 const & a,
167  arraySlice1d< real64 const, compflow::USD_COMP - 1 > const & inputComposition,
168  arraySlice1d< real64 const, compflow::USD_COMP - 1 > const & addedCompFrac,
169  arraySlice1d< real64, compflow::USD_COMP - 1 > const & compFrac );
170 
171  static integer evaluateFlashPhaseIndex( integer const & numPhases,
172  integer const & ipGas,
173  integer const & ipOil,
174  integer const & ipWater,
175  integer const & ipInit,
176  real64 const & elevation,
177  arrayView1d< real64 const > const & phaseContacts );
178 
179  static void evaluatePrimaryAndContactPhaseIndices( integer const & numPhases,
180  integer const & ipGas,
181  integer const & ipOil,
182  integer const & ipWater,
183  real64 const & startElevation,
184  real64 const & endElevation,
185  arrayView1d< real64 const > const & phaseContacts,
186  integer & ipPP,
187  integer & ipCP );
188 
189  static void
190  computeDatumPhaseMassDens( integer const & numComps,
191  integer const & numPhases,
192  integer const & ipGas,
193  integer const & ipWater,
194  arrayView1d< real64 const > const & phaseMinVolumeFraction,
195  real64 const & datumElevation,
196  real64 const & datumPres,
197  real64 const & datumTemp,
198  arrayView3d< real64, constitutive::multifluid::USD_PHASE > const & datumPhaseMassDens,
199  arrayView1d< TableFunction::KernelWrapper const > compFracTableWrappers,
200  bool singlePhase,
201  FLUID_WRAPPER fluidWrapper );
202 };
203 
204 } // namespace isothermalCompositionalMultiphaseBaseKernels
205 } // namespace geos
206 
207 #endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_COMPOSITIONAL_HYDROSTATICPRESSUREKERNEL_HPP
geos::arrayView1d
ArrayView< T, 1 > arrayView1d
Alias for 1D array view.
Definition: DataTypes.hpp:179
geos::arraySlice2d
ArraySlice< T, 2, USD > arraySlice2d
Alias for 2D array slice.
Definition: DataTypes.hpp:199
geos::real64
double real64
64-bit floating point type.
Definition: DataTypes.hpp:98
geos::localIndex
GEOS_LOCALINDEX_TYPE localIndex
Local index type (for indexing objects within an MPI partition).
Definition: DataTypes.hpp:84
geos::arraySlice1d
ArraySlice< T, 1, USD > arraySlice1d
Alias for 1D array slice.
Definition: DataTypes.hpp:183
geos::arrayView4d
ArrayView< T, 4, USD > arrayView4d
Alias for 4D array view.
Definition: DataTypes.hpp:227
geos::arrayView2d
ArrayView< T, 2, USD > arrayView2d
Alias for 2D array view.
Definition: DataTypes.hpp:195
geos::integer
int integer
Signed integer type.
Definition: DataTypes.hpp:81
geos::arrayView3d
ArrayView< T, 3, USD > arrayView3d
Alias for 3D array view.
Definition: DataTypes.hpp:211
Generated by doxygen 1.9.1