Line | Branch | Exec | Source |
---|---|---|---|
1 | // -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- | ||
2 | // vi: set et ts=4 sw=4 sts=4: | ||
3 | // | ||
4 | // SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder | ||
5 | // SPDX-License-Identifier: GPL-3.0-or-later | ||
6 | // | ||
7 | /*! | ||
8 | * \file | ||
9 | * \ingroup InputOutput | ||
10 | * \brief A collection of input/output field names for common physical quantities | ||
11 | */ | ||
12 | #ifndef DUMUX_IO_NAME_HH | ||
13 | #define DUMUX_IO_NAME_HH | ||
14 | |||
15 | #include <string> | ||
16 | |||
17 | namespace Dumux { | ||
18 | namespace IOName { | ||
19 | |||
20 | //! I/O name of pressure for multiphase systems | ||
21 | template<class FluidSystem> | ||
22 |
2/2✓ Branch 0 taken 1 times.
✓ Branch 1 taken 1 times.
|
321 | std::string pressure(int phaseIdx) noexcept |
23 | 642 | { return (FluidSystem::numPhases == 1) ? "p" : "p_" + FluidSystem::phaseName(phaseIdx); } | |
24 | |||
25 | //! I/O name of pressure for singlephase systems | ||
26 | 538 | std::string pressure() noexcept | |
27 |
27/53✓ Branch 6 taken 99 times.
✗ Branch 7 not taken.
✓ Branch 12 taken 1 times.
✗ Branch 13 not taken.
✓ Branch 18 taken 1 times.
✗ Branch 19 not taken.
✓ Branch 24 taken 1 times.
✗ Branch 25 not taken.
✓ Branch 31 taken 1 times.
✗ Branch 32 not taken.
✓ Branch 35 taken 1 times.
✗ Branch 36 not taken.
✓ Branch 40 taken 1 times.
✗ Branch 41 not taken.
✓ Branch 44 taken 1 times.
✗ Branch 45 not taken.
✓ Branch 49 taken 1 times.
✗ Branch 50 not taken.
✓ Branch 53 taken 1 times.
✗ Branch 54 not taken.
✓ Branch 58 taken 1 times.
✗ Branch 59 not taken.
✓ Branch 62 taken 1 times.
✗ Branch 63 not taken.
✓ Branch 67 taken 1 times.
✗ Branch 68 not taken.
✓ Branch 74 taken 1 times.
✗ Branch 75 not taken.
✓ Branch 78 taken 1 times.
✗ Branch 79 not taken.
✓ Branch 82 taken 1 times.
✗ Branch 83 not taken.
✓ Branch 86 taken 1 times.
✗ Branch 87 not taken.
✓ Branch 90 taken 1 times.
✗ Branch 91 not taken.
✓ Branch 94 taken 1 times.
✗ Branch 95 not taken.
✓ Branch 99 taken 1 times.
✗ Branch 100 not taken.
✓ Branch 105 taken 1 times.
✗ Branch 106 not taken.
✓ Branch 109 taken 1 times.
✗ Branch 110 not taken.
✓ Branch 113 taken 1 times.
✗ Branch 114 not taken.
✓ Branch 118 taken 1 times.
✗ Branch 119 not taken.
✓ Branch 2 taken 346 times.
✓ Branch 3 taken 15 times.
✗ Branch 4 not taken.
✓ Branch 10 taken 3 times.
✗ Branch 11 not taken.
|
538 | { return "p"; } |
28 | |||
29 | //! I/O name of saturation for multiphase systems | ||
30 | template<class FluidSystem> | ||
31 |
2/2✓ Branch 0 taken 1 times.
✓ Branch 1 taken 1 times.
|
313 | std::string saturation(int phaseIdx) noexcept |
32 | 626 | { return (FluidSystem::numPhases == 1) ? "S" : "S_" + FluidSystem::phaseName(phaseIdx); } | |
33 | |||
34 | //! I/O name of saturation for singlephase systems | ||
35 | 6 | std::string saturation() noexcept | |
36 |
2/4✓ Branch 2 taken 3 times.
✗ Branch 3 not taken.
✓ Branch 6 taken 3 times.
✗ Branch 7 not taken.
|
6 | { return "S"; } |
37 | |||
38 | //! I/O name of temperature for equilibrium models | ||
39 | 155 | std::string temperature() noexcept | |
40 |
15/29✓ Branch 14 taken 1 times.
✗ Branch 15 not taken.
✓ Branch 18 taken 1 times.
✗ Branch 19 not taken.
✓ Branch 22 taken 1 times.
✗ Branch 23 not taken.
✓ Branch 26 taken 1 times.
✗ Branch 27 not taken.
✓ Branch 30 taken 1 times.
✗ Branch 31 not taken.
✓ Branch 34 taken 1 times.
✗ Branch 35 not taken.
✓ Branch 38 taken 1 times.
✗ Branch 39 not taken.
✓ Branch 42 taken 1 times.
✗ Branch 43 not taken.
✓ Branch 46 taken 1 times.
✗ Branch 47 not taken.
✓ Branch 50 taken 1 times.
✗ Branch 51 not taken.
✓ Branch 54 taken 1 times.
✗ Branch 55 not taken.
✓ Branch 58 taken 1 times.
✗ Branch 59 not taken.
✓ Branch 2 taken 89 times.
✓ Branch 3 taken 16 times.
✗ Branch 4 not taken.
✓ Branch 6 taken 10 times.
✗ Branch 7 not taken.
|
155 | { return "T"; } |
41 | |||
42 | //! I/O name of temperature for non-equilibrium models | ||
43 | template<class FluidSystem> | ||
44 | 4 | std::string fluidTemperature(int phaseIdx) noexcept | |
45 | 8 | { return "T_" + FluidSystem::phaseName(phaseIdx); } | |
46 | |||
47 | //! I/O name of solid temperature for non-equilibrium models | ||
48 | 3 | std::string solidTemperature() noexcept | |
49 |
1/2✓ Branch 2 taken 3 times.
✗ Branch 3 not taken.
|
3 | { return "T_s"; } |
50 | |||
51 | //! I/O name of density for multiphase systems | ||
52 | template<class FluidSystem> | ||
53 |
2/2✓ Branch 0 taken 1 times.
✓ Branch 1 taken 1 times.
|
268 | std::string density(int phaseIdx) noexcept |
54 | 536 | { return (FluidSystem::numPhases == 1) ? "rho" : "rho_" + FluidSystem::phaseName(phaseIdx); } | |
55 | |||
56 | //! I/O name of density for singlephase systems | ||
57 | 243 | std::string density() noexcept | |
58 |
24/48✓ Branch 2 taken 193 times.
✗ Branch 3 not taken.
✓ Branch 6 taken 28 times.
✗ Branch 7 not taken.
✓ Branch 10 taken 1 times.
✗ Branch 11 not taken.
✓ Branch 14 taken 1 times.
✗ Branch 15 not taken.
✓ Branch 18 taken 1 times.
✗ Branch 19 not taken.
✓ Branch 22 taken 1 times.
✗ Branch 23 not taken.
✓ Branch 26 taken 1 times.
✗ Branch 27 not taken.
✓ Branch 30 taken 1 times.
✗ Branch 31 not taken.
✓ Branch 34 taken 1 times.
✗ Branch 35 not taken.
✓ Branch 38 taken 1 times.
✗ Branch 39 not taken.
✓ Branch 42 taken 1 times.
✗ Branch 43 not taken.
✓ Branch 46 taken 1 times.
✗ Branch 47 not taken.
✓ Branch 50 taken 1 times.
✗ Branch 51 not taken.
✓ Branch 54 taken 1 times.
✗ Branch 55 not taken.
✓ Branch 58 taken 1 times.
✗ Branch 59 not taken.
✓ Branch 62 taken 1 times.
✗ Branch 63 not taken.
✓ Branch 66 taken 1 times.
✗ Branch 67 not taken.
✓ Branch 70 taken 1 times.
✗ Branch 71 not taken.
✓ Branch 74 taken 1 times.
✗ Branch 75 not taken.
✓ Branch 78 taken 1 times.
✗ Branch 79 not taken.
✓ Branch 82 taken 1 times.
✗ Branch 83 not taken.
✓ Branch 86 taken 1 times.
✗ Branch 87 not taken.
✓ Branch 90 taken 1 times.
✗ Branch 91 not taken.
✓ Branch 94 taken 1 times.
✗ Branch 95 not taken.
|
243 | { return "rho"; } |
59 | |||
60 | //! I/O name of viscosity for multiphase systems | ||
61 | template<class FluidSystem> | ||
62 | 3 | std::string viscosity(int phaseIdx) noexcept | |
63 | 6 | { return (FluidSystem::numPhases == 1) ? "mu" : "mu_" + FluidSystem::phaseName(phaseIdx); } | |
64 | |||
65 | //! I/O name of viscosity for singlephase systems | ||
66 | 67 | std::string viscosity() noexcept | |
67 |
2/4✓ Branch 2 taken 54 times.
✗ Branch 3 not taken.
✓ Branch 6 taken 13 times.
✗ Branch 7 not taken.
|
67 | { return "mu"; } |
68 | |||
69 | //! I/O name of molar density for multiphase systems | ||
70 | template<class FluidSystem> | ||
71 |
2/2✓ Branch 0 taken 1 times.
✓ Branch 1 taken 1 times.
|
92 | std::string molarDensity(int phaseIdx) noexcept |
72 | 184 | { return (FluidSystem::numPhases == 1) ? "rhoMolar" : "rhoMolar_" + FluidSystem::phaseName(phaseIdx); } | |
73 | |||
74 | //! I/O name of molar density for singlephase systems | ||
75 | 46 | std::string molarDensity() noexcept | |
76 |
12/24✓ Branch 2 taken 35 times.
✗ Branch 3 not taken.
✓ Branch 6 taken 1 times.
✗ Branch 7 not taken.
✓ Branch 10 taken 1 times.
✗ Branch 11 not taken.
✓ Branch 14 taken 1 times.
✗ Branch 15 not taken.
✓ Branch 18 taken 1 times.
✗ Branch 19 not taken.
✓ Branch 22 taken 1 times.
✗ Branch 23 not taken.
✓ Branch 26 taken 1 times.
✗ Branch 27 not taken.
✓ Branch 30 taken 1 times.
✗ Branch 31 not taken.
✓ Branch 34 taken 1 times.
✗ Branch 35 not taken.
✓ Branch 38 taken 1 times.
✗ Branch 39 not taken.
✓ Branch 42 taken 1 times.
✗ Branch 43 not taken.
✓ Branch 46 taken 1 times.
✗ Branch 47 not taken.
|
46 | { return "rhoMolar"; } |
77 | |||
78 | //! I/O name of relative permeability for multiphase systems | ||
79 | template<class FluidSystem> | ||
80 | 41 | std::string relativePermeability(int phaseIdx) noexcept | |
81 | 82 | { return (FluidSystem::numPhases == 1) ? "kr" : "kr_" + FluidSystem::phaseName(phaseIdx); } | |
82 | |||
83 | //! I/O name of relative permeability for singlephase systems | ||
84 | 3 | std::string relativePermeability() noexcept | |
85 |
1/2✓ Branch 2 taken 3 times.
✗ Branch 3 not taken.
|
3 | { return "kr"; } |
86 | |||
87 | //! I/O name of mobility for multiphase systems | ||
88 | template<class FluidSystem> | ||
89 |
2/2✓ Branch 0 taken 1 times.
✓ Branch 1 taken 1 times.
|
232 | std::string mobility(int phaseIdx) noexcept |
90 | 464 | { return (FluidSystem::numPhases == 1) ? "mob" : "mob_" + FluidSystem::phaseName(phaseIdx); } | |
91 | |||
92 | //! I/O name of mobility for singlephase systems | ||
93 | 3 | std::string mobility() noexcept | |
94 |
1/2✓ Branch 2 taken 3 times.
✗ Branch 3 not taken.
|
3 | { return "mob"; } |
95 | |||
96 | //! I/O name of mole fraction | ||
97 | template<class FluidSystem> | ||
98 |
2/2✓ Branch 0 taken 3 times.
✓ Branch 1 taken 3 times.
|
567 | std::string moleFraction(int phaseIdx, int compIdx) noexcept |
99 |
2/2✓ Branch 0 taken 38 times.
✓ Branch 1 taken 36 times.
|
1781 | { return "x^" + FluidSystem::componentName(compIdx) + "_" + FluidSystem::phaseName(phaseIdx); } |
100 | |||
101 | //! I/O name of mass fraction | ||
102 | template<class FluidSystem> | ||
103 | 427 | std::string massFraction(int phaseIdx, int compIdx) noexcept | |
104 |
2/2✓ Branch 0 taken 60 times.
✓ Branch 1 taken 36 times.
|
1383 | { return "X^" + FluidSystem::componentName(compIdx) + "_" + FluidSystem::phaseName(phaseIdx); } |
105 | |||
106 | //! I/O name of liquid phase | ||
107 | 2775 | std::string liquidPhase() noexcept | |
108 |
5/13✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 9 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
✓ Branch 8 taken 3 times.
✓ Branch 9 taken 2 times.
✓ Branch 13 taken 2 times.
✓ Branch 17 taken 2 times.
✗ Branch 18 not taken.
|
2775 | { return "liq"; } |
109 | |||
110 | //! I/O name of gaseous phase | ||
111 | 2716 | std::string gaseousPhase() noexcept | |
112 |
40/65✓ Branch 26 taken 3 times.
✗ Branch 27 not taken.
✓ Branch 30 taken 1 times.
✗ Branch 31 not taken.
✓ Branch 34 taken 1 times.
✗ Branch 35 not taken.
✓ Branch 38 taken 1 times.
✗ Branch 39 not taken.
✓ Branch 42 taken 1 times.
✗ Branch 43 not taken.
✓ Branch 46 taken 1 times.
✗ Branch 47 not taken.
✓ Branch 50 taken 1 times.
✗ Branch 51 not taken.
✓ Branch 54 taken 1 times.
✗ Branch 55 not taken.
✓ Branch 58 taken 1 times.
✗ Branch 59 not taken.
✓ Branch 62 taken 1 times.
✗ Branch 63 not taken.
✓ Branch 66 taken 1 times.
✗ Branch 67 not taken.
✓ Branch 69 taken 12 times.
✓ Branch 70 taken 12 times.
✓ Branch 72 taken 36 times.
✓ Branch 73 taken 12 times.
✓ Branch 76 taken 1 times.
✗ Branch 77 not taken.
✓ Branch 80 taken 1 times.
✗ Branch 81 not taken.
✓ Branch 84 taken 1 times.
✗ Branch 85 not taken.
✓ Branch 88 taken 1 times.
✗ Branch 89 not taken.
✓ Branch 92 taken 1 times.
✗ Branch 93 not taken.
✓ Branch 96 taken 1 times.
✗ Branch 97 not taken.
✓ Branch 100 taken 1 times.
✗ Branch 101 not taken.
✓ Branch 104 taken 1 times.
✗ Branch 105 not taken.
✓ Branch 108 taken 1 times.
✗ Branch 109 not taken.
✓ Branch 112 taken 1 times.
✗ Branch 113 not taken.
✓ Branch 116 taken 1 times.
✗ Branch 117 not taken.
✓ Branch 2 taken 18 times.
✓ Branch 3 taken 21 times.
✓ Branch 5 taken 16 times.
✓ Branch 6 taken 21 times.
✓ Branch 9 taken 15 times.
✓ Branch 10 taken 3 times.
✓ Branch 13 taken 15 times.
✗ Branch 14 not taken.
✓ Branch 4 taken 7 times.
✓ Branch 7 taken 6 times.
✗ Branch 11 not taken.
✗ Branch 15 not taken.
✓ Branch 19 taken 2 times.
✓ Branch 20 taken 2 times.
✓ Branch 22 taken 2 times.
✓ Branch 23 taken 2 times.
✓ Branch 1 taken 1 times.
|
2716 | { return "gas"; } |
113 | |||
114 | //! I/O name of aqueous phase | ||
115 | 127 | std::string aqueousPhase() noexcept | |
116 | 127 | { return "aq"; } | |
117 | |||
118 | //! I/O name of napl phase | ||
119 | 123 | std::string naplPhase() noexcept | |
120 | 123 | { return "napl"; } | |
121 | |||
122 | //! I/O name of capillary pressure | ||
123 | 131 | std::string capillaryPressure() noexcept | |
124 |
1/2✓ Branch 2 taken 131 times.
✗ Branch 3 not taken.
|
131 | { return "pc"; } |
125 | |||
126 | //! I/O name of porosity | ||
127 | 155 | std::string porosity() noexcept | |
128 |
2/4✓ Branch 2 taken 153 times.
✗ Branch 3 not taken.
✓ Branch 6 taken 2 times.
✗ Branch 7 not taken.
|
155 | { return "porosity"; } |
129 | |||
130 | //! I/O name of permeability | ||
131 | 13 | std::string permeability() noexcept | |
132 |
1/2✓ Branch 2 taken 13 times.
✗ Branch 3 not taken.
|
13 | { return "permeability"; } |
133 | |||
134 | //! I/O name of phase presence | ||
135 | 59 | std::string phasePresence() noexcept | |
136 |
1/2✓ Branch 2 taken 59 times.
✗ Branch 3 not taken.
|
59 | { return "phase presence"; } |
137 | |||
138 | //! I/O name of pressure head | ||
139 | 30 | std::string pressureHead() noexcept | |
140 |
1/2✓ Branch 2 taken 30 times.
✗ Branch 3 not taken.
|
30 | { return "pressure head"; } |
141 | |||
142 | //! I/O name of water content | ||
143 | 44 | std::string waterContent() noexcept | |
144 |
1/2✓ Branch 2 taken 44 times.
✗ Branch 3 not taken.
|
44 | { return "water content"; } |
145 | |||
146 | //! I/O name of solid volume fraction | ||
147 | template<class SolidSystem> | ||
148 | 15 | std::string solidVolumeFraction(int compIdx = 0) noexcept | |
149 | 28 | { return "precipitateVolumeFraction^" + SolidSystem::componentName(compIdx); } | |
150 | |||
151 | //! I/O name of displacement | ||
152 | 4 | std::string displacement() noexcept | |
153 |
1/2✓ Branch 2 taken 4 times.
✗ Branch 3 not taken.
|
4 | { return "u"; } |
154 | |||
155 | } // end namespace IOName | ||
156 | } // end namespace Dumux | ||
157 | |||
158 | #endif | ||
159 |