GEOS
FlowSolverBaseFields.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_FLOWSOLVERBASEFIELDS_HPP_
21 #define GEOS_PHYSICSSOLVERS_FLUIDFLOW_FLOWSOLVERBASEFIELDS_HPP_
22 
23 #include "mesh/MeshFields.hpp"
24 
25 namespace geos
26 {
30 namespace fields
31 {
32 
33 namespace flow
34 {
35 
36 DECLARE_FIELD( pressure,
37  "pressure",
38  array1d< real64 >,
39  0,
40  LEVEL_0,
41  WRITE_AND_READ,
42  "Pressure" );
43 
44 DECLARE_FIELD( pressure_n,
45  "pressure_n",
46  array1d< real64 >,
47  0,
48  NOPLOT,
49  WRITE_AND_READ,
50  "Pressure at the previous converged time step" );
51 
52 DECLARE_FIELD( pressure_k,
53  "pressure_k",
54  array1d< real64 >,
55  0,
56  NOPLOT,
57  NO_WRITE,
58  "Pressure at the previous sequential iteration" );
59 
60 DECLARE_FIELD( initialPressure,
61  "initialPressure",
62  array1d< real64 >,
63  0,
64  NOPLOT,
65  WRITE_AND_READ,
66  "Initial pressure" );
67 
68 DECLARE_FIELD( deltaPressure,
69  "deltaPressure",
70  array1d< real64 >,
71  0,
72  LEVEL_0,
73  WRITE_AND_READ,
74  "Delta pressure: current pressure - initial pressure" );
75 
76 DECLARE_FIELD( facePressure,
77  "facePressure",
78  array1d< real64 >,
79  0,
80  LEVEL_0,
81  WRITE_AND_READ,
82  "Face pressure" );
83 
84 DECLARE_FIELD( facePressure_n,
85  "facePressure_n",
86  array1d< real64 >,
87  0,
88  NOPLOT,
89  NO_WRITE,
90  "Face pressure at the previous converged time step" );
91 
92 DECLARE_FIELD( pressureGradient,
93  "pressureGradient",
94  array2d< real64 >,
95  0,
96  LEVEL_0,
97  WRITE_AND_READ,
98  "Pressure gradient" );
99 
100 DECLARE_FIELD( temperature,
101  "temperature",
102  array1d< real64 >,
103  0,
104  LEVEL_0,
105  WRITE_AND_READ,
106  "Temperature" );
107 
108 DECLARE_FIELD( temperature_n,
109  "temperature_n",
110  array1d< real64 >,
111  0,
112  NOPLOT,
113  WRITE_AND_READ,
114  "Temperature at the previous converged time step" );
115 
116 DECLARE_FIELD( temperature_k,
117  "temperature_k",
118  array1d< real64 >,
119  0,
120  NOPLOT,
121  NO_WRITE,
122  "Temperature at the previous sequential iteration" );
123 
124 DECLARE_FIELD( initialTemperature,
125  "initialTemperature",
126  array1d< real64 >,
127  0,
128  NOPLOT,
129  WRITE_AND_READ,
130  "Initial temperature" );
131 
132 DECLARE_FIELD( faceTemperature,
133  "faceTemperature",
134  array1d< real64 >,
135  0,
136  LEVEL_0,
137  WRITE_AND_READ,
138  "Face temperature" );
139 
140 DECLARE_FIELD( netToGross,
141  "netToGross",
142  array1d< real64 >,
143  1,
144  NOPLOT,
145  NO_WRITE,
146  "Net to gross" );
147 
148 DECLARE_FIELD( deltaVolume,
149  "deltaVolume",
150  array1d< real64 >,
151  0,
152  NOPLOT,
153  NO_WRITE,
154  "Accumulated volume updates" );
155 
156 DECLARE_FIELD( aperture0,
157  "aperture_n",
158  array1d< real64 >,
159  0,
160  NOPLOT,
161  WRITE_AND_READ,
162  "Initial aperture" );
163 
164 DECLARE_FIELD( hydraulicAperture,
165  "hydraulicAperture",
166  array1d< real64 >,
167  0,
168  LEVEL_0,
169  WRITE_AND_READ,
170  "Hydraulic aperture" );
171 
172 DECLARE_FIELD( gravityCoefficient,
173  "gravityCoefficient",
174  array1d< real64 >,
175  0,
176  NOPLOT,
177  WRITE_AND_READ,
178  "Gravity coefficient (dot product of gravity acceleration by gravity vector)" );
179 
180 DECLARE_FIELD( mimGravityCoefficient,
181  "mimGravityCoefficient",
182  array1d< real64 >,
183  0,
184  NOPLOT,
185  WRITE_AND_READ,
186  "Mimetic gravity coefficient" );
187 
188 DECLARE_FIELD( macroElementIndex,
189  "macroElementIndex",
190  array1d< integer >,
191  -1,
192  LEVEL_1,
193  WRITE_AND_READ,
194  "Index of the macroelement for a given element" );
195 
196 DECLARE_FIELD( bcPressure,
197  "bcPressure",
198  array1d< real64 >,
199  0,
200  NOPLOT,
201  WRITE_AND_READ,
202  "Boundary condition pressure" );
203 
204 DECLARE_FIELD( bcTemperature,
205  "bcTemperature",
206  array1d< real64 >,
207  0,
208  NOPLOT,
209  WRITE_AND_READ,
210  "Boundary condition temperature" );
211 
212 DECLARE_FIELD( elementStabConstant,
213  "elementStabConstant",
214  array1d< real64 >,
215  0,
216  LEVEL_1,
217  WRITE_AND_READ,
218  "Stabilization constant for pressure jump stabilization" );
219 
220 DECLARE_FIELD( transMultiplier,
221  "permeabilityTransMultiplier",
222  array1d< real64 >,
223  1,
224  LEVEL_0,
225  WRITE_AND_READ,
226  "Permeability transmissibility multipliers" );
227 
228 DECLARE_FIELD( pressureScalingFactor,
229  "pressureScalingFactor",
230  array1d< real64 >,
231  1,
232  NOPLOT,
233  NO_WRITE,
234  "Scaling factors for pressure" );
235 
236 DECLARE_FIELD( temperatureScalingFactor,
237  "temperatureScalingFactor",
238  array1d< real64 >,
239  1,
240  NOPLOT,
241  NO_WRITE,
242  "Scaling factors for temperature" );
243 
244 DECLARE_FIELD( mass,
245  "mass",
246  array1d< real64 >,
247  0,
248  LEVEL_0,
249  WRITE_AND_READ,
250  "Mass" );
251 
252 DECLARE_FIELD( mass_n,
253  "mass_n",
254  array1d< real64 >,
255  0,
256  NOPLOT,
257  WRITE_AND_READ,
258  "Mass at the previous converged time step" );
259 
260 DECLARE_FIELD( energy,
261  "energy",
262  array1d< real64 >,
263  0,
264  LEVEL_0,
265  WRITE_AND_READ,
266  "Energy" );
267 
268 DECLARE_FIELD( energy_n,
269  "energy_n",
270  array1d< real64 >,
271  0,
272  NOPLOT,
273  WRITE_AND_READ,
274  "Energy at the previous converged time step" );
275 
276 DECLARE_FIELD( massCreated,
277  "massCreated",
278  array1d< real64 >,
279  0,
280  LEVEL_1,
281  WRITE_AND_READ,
282  "The amount of remaining mass that was introduced when the SurfaceElement was created." );
283 
284 }
285 
286 }
287 
288 }
289 
290 #endif // GEOS_PHYSICSSOLVERS_FLUIDFLOW_FLOWSOLVERBASEFIELDS_HPP_
#define DECLARE_FIELD(NAME, KEY, TYPE, DEFAULT, PLOTLEVEL, RESTARTFLAG, DESCRIPTION)
Generates a traits struct.
Definition: MeshFields.hpp:39