GEOS
SinglePhaseReactiveTransportFields.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_SINGLEPHASEREACTIVETRANSPORTFIELDS_HPP_
21 #define GEOS_PHYSICSSOLVERS_FLUIDFLOW_SINGLEPHASEREACTIVETRANSPORTFIELDS_HPP_
22 
23 #include "mesh/MeshFields.hpp"
24 
25 namespace geos
26 {
30 namespace fields
31 {
32 
33 namespace flow
34 {
35 using array2dLayoutComp = array2d< real64, compflow::LAYOUT_COMP >;
36 using array2dLayoutFluid_dC = array2d< real64, compflow::LAYOUT_FLUID_DC >;
37 
38 DECLARE_FIELD( logPrimarySpeciesConcentration,
39  "logPrimarySpeciesConcentration",
40  array2dLayoutComp,
41  0,
42  LEVEL_0,
43  WRITE_AND_READ,
44  "Natural log of primary species concentration (molarity)" );
45 
46 DECLARE_FIELD( logPrimarySpeciesConcentration_n,
47  "logPrimarySpeciesConcentration_n",
48  array2dLayoutComp,
49  0,
50  LEVEL_0,
51  WRITE_AND_READ,
52  "Natural log of primary species concentration (molarity) at the previous converged time step" );
53 
54 DECLARE_FIELD( bcLogPrimarySpeciesConcentration,
55  "bcLogPrimarySpeciesConcentration",
56  array2dLayoutComp,
57  0,
58  LEVEL_0,
59  WRITE_AND_READ,
60  "Boundary condition for natural log of primary species concentration (molarity)" );
61 
62 DECLARE_FIELD( primarySpeciesAggregateMole,
63  "primarySpeciesAggregateMole",
64  array2dLayoutComp,
65  0,
66  LEVEL_0,
67  WRITE_AND_READ,
68  "Aggregate amount of primary species in mole" );
69 
70 DECLARE_FIELD( primarySpeciesAggregateMole_n,
71  "primarySpeciesAggregateMole_n",
72  array2dLayoutComp,
73  0,
74  LEVEL_0,
75  WRITE_AND_READ,
76  "Aggregate amount of primary species in mole at the previous converged time step" );
77 
78 DECLARE_FIELD( kineticReactionMolarIncrements,
79  "kineticReactionMolarIncrements",
80  array2dLayoutComp,
81  0,
82  NOPLOT,
83  WRITE_AND_READ,
84  "Molar increment in the current timestep for kinetic reactions" );
85 
86 DECLARE_FIELD( dMobility_dLogPrimaryConc,
87  "dMobility_dLogPrimaryConc",
88  array2dLayoutFluid_dC,
89  0,
90  NOPLOT,
91  NO_WRITE,
92  "Derivative of fluid mobility with respect to log of primary species concentration" );
93 
94 DECLARE_FIELD( surfaceArea,
95  "surfaceArea",
96  array2dLayoutComp,
97  0,
98  NOPLOT,
99  WRITE_AND_READ,
100  "Surface area for surface reactions." );
101 
102 DECLARE_FIELD( initialSurfaceArea,
103  "initialSurfaceArea",
104  array2dLayoutComp,
105  0,
106  NOPLOT,
107  WRITE_AND_READ,
108  "Initial surface area for surface reactions." );
109 
110 }
111 
112 }
113 
114 }
115 
116 #endif // GEOS_PHYSICSSOLVERS_FLUIDFLOW_SINGLEPHASEREACTIVETRANSPORTFIELDS_HPP_
#define DECLARE_FIELD(NAME, KEY, TYPE, DEFAULT, PLOTLEVEL, RESTARTFLAG, DESCRIPTION)
Generates a traits struct.
Definition: MeshFields.hpp:39