File size: 14,247 Bytes
f421c2e
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293

import numpy as np
from numpy.testing import assert_allclose

import openpnm as op
import openpnm.models.physics as pm


class GenericSourceTermTest:
    def setup_class(self):
        self.net = op.network.Cubic(shape=[5, 5, 5])
        self.phase = op.phase.Phase(network=self.net)
        self.phase['throat.diffusive_conductance'] = 5e-8
        self.phase['pore.mole_fraction'] = 0.0
        self.BC_pores = np.arange(20, 30)
        self.source_pores = np.arange(55, 85)

    def test_default_values_should_give_zero_rate(self):
        sources = ["linear", "power_law", "exponential", "natural_exponential",
                   "logarithm", "natural_logarithm"]
        self.alg = op.algorithms.ReactiveTransport(network=self.net,
                                                   phase=self.phase)
        self.alg.settings._update({'conductance': 'throat.diffusive_conductance',
                                   'quantity': 'pore.mole_fraction'})
        self.alg.set_value_BC(values=0.4, pores=self.BC_pores)
        self.alg.set_source(propname='pore.source_term',
                            pores=self.source_pores)
        # To avoid nans in logarithm-based source term models
        self.phase['pore.mole_fraction'] = 0.1
        for source in sources:
            self.phase.add_model(propname="pore.source_term",
                                 model=getattr(pm.source_terms, source),
                                 X="pore.mole_fraction")
            assert self.phase["pore.source_term.rate"].mean() == 0
            assert self.phase["pore.source_term.S1"].mean() == 0
            assert self.phase["pore.source_term.S2"].mean() == 0

    def test_linear(self):
        self.phase['pore.item1'] = 0.5e-11
        self.phase['pore.item2'] = 1.5e-12
        self.phase.add_model(propname='pore.source1',
                             model=pm.source_terms.linear,
                             A1='pore.item1',
                             A2='pore.item2',
                             X='pore.mole_fraction',
                             regen_mode='normal')
        self.alg = op.algorithms.ReactiveTransport(network=self.net,
                                                   phase=self.phase)
        self.alg.settings._update({'conductance': 'throat.diffusive_conductance',
                                   'quantity': 'pore.mole_fraction'})
        self.alg.set_value_BC(values=0.4, pores=self.BC_pores)
        self.alg.set_source(propname='pore.source1',
                            pores=self.source_pores)
        self.alg.run()
        self.phase.update(self.alg.soln)
        self.phase.regenerate_models(propnames='pore.source1')
        X = self.phase['pore.mole_fraction']
        r1 = np.round(np.sum(0.5e-11 * X[self.source_pores] + 1.5e-12), 20)
        r2 = np.round(np.sum(self.phase['pore.source1.rate'][self.source_pores]), 20)
        assert r1 == r2

    def test_power_law(self):
        self.phase['pore.item1'] = 0.5e-12
        self.phase['pore.item2'] = 2.5
        self.phase['pore.item3'] = -1.4e-11
        self.phase.add_model(propname='pore.source1',
                             model=pm.source_terms.power_law,
                             A1='pore.item1',
                             A2='pore.item2',
                             A3='pore.item3',
                             X='pore.mole_fraction',
                             regen_mode='normal')
        self.alg = op.algorithms.ReactiveTransport(network=self.net,
                                                   phase=self.phase)
        self.alg.set_value_BC(values=0.4, pores=self.BC_pores)
        self.alg.set_source(propname='pore.source1',
                            pores=self.source_pores)
        self.alg.settings._update({'conductance': 'throat.diffusive_conductance',
                                   'quantity': 'pore.mole_fraction'})
        self.alg.run()
        self.phase.update(self.alg.soln)
        self.phase.regenerate_models(propnames='pore.source1')
        X = self.phase['pore.mole_fraction']
        r1 = np.sum(0.5e-12 * X[self.source_pores]**2.5 - 1.4e-11)
        r2 = np.sum(self.phase['pore.source1.rate'][self.source_pores])
        assert r1 == r2

    def test_exponential(self):
        self.phase['pore.item1'] = 0.8e-11
        self.phase['pore.item2'] = 3
        self.phase['pore.item3'] = 0.5
        self.phase['pore.item4'] = 2
        self.phase['pore.item5'] = -0.34
        self.phase['pore.item6'] = 2e-14
        self.phase.add_model(propname='pore.source1',
                             model=pm.source_terms.exponential,
                             A1='pore.item1',
                             A2='pore.item2',
                             A3='pore.item3',
                             A4='pore.item4',
                             A5='pore.item5',
                             A6='pore.item6',
                             X='pore.mole_fraction',
                             regen_mode='normal')
        self.alg = op.algorithms.ReactiveTransport(network=self.net,
                                                   phase=self.phase)
        self.alg.set_value_BC(values=0.4, pores=self.BC_pores)
        self.alg.set_source(propname='pore.source1',
                            pores=self.source_pores)
        self.alg.settings._update({'conductance': 'throat.diffusive_conductance',
                                   'quantity': 'pore.mole_fraction'})
        self.alg.run()
        self.phase.update(self.alg.soln)
        self.phase.regenerate_models(propnames='pore.source1')
        X = self.phase['pore.mole_fraction']
        r1 = np.sum(0.8e-11 * 3 ** (0.5 * X[self.source_pores]**2 - 0.34) + 2e-14)
        r2 = np.sum(self.phase['pore.source1.rate'][self.source_pores])
        assert_allclose(actual=r2, desired=r1, rtol=1e-7)

    def test_natural_exponential(self):
        self.phase['pore.item1'] = 0.8e-11
        self.phase['pore.item2'] = 0.5
        self.phase['pore.item3'] = 2
        self.phase['pore.item4'] = -0.34
        self.phase['pore.item5'] = 2e-14
        self.phase.add_model(propname='pore.source1',
                             model=pm.source_terms.natural_exponential,
                             A1='pore.item1',
                             A2='pore.item2',
                             A3='pore.item3',
                             A4='pore.item4',
                             A5='pore.item5',
                             X='pore.mole_fraction',
                             regen_mode='normal')
        self.alg = op.algorithms.ReactiveTransport(network=self.net,
                                                   phase=self.phase)
        self.alg.set_value_BC(values=0.4, pores=self.BC_pores)
        self.alg.set_source(propname='pore.source1',
                            pores=self.source_pores)
        self.alg.settings._update({'conductance': 'throat.diffusive_conductance',
                                   'quantity': 'pore.mole_fraction'})
        self.alg.run()
        self.phase.update(self.alg.soln)
        self.phase.regenerate_models(propnames='pore.source1')
        X = self.phase['pore.mole_fraction']
        r1 = np.sum(0.8e-11 * np.exp(0.5 * X[self.source_pores]**2 - 0.34) + 2e-14)
        r2 = np.sum(self.phase['pore.source1.rate'][self.source_pores])
        # assert_allclose(actual=r2, desired=r1)

    def test_logarithm(self):
        self.phase['pore.item1'] = 0.16e-13
        self.phase['pore.item2'] = 10
        self.phase['pore.item3'] = 4
        self.phase['pore.item4'] = 1.4
        self.phase['pore.item5'] = 0.133
        self.phase['pore.item6'] = -5.1e-13
        self.phase.add_model(propname='pore.source1',
                             model=pm.source_terms.logarithm,
                             A1='pore.item1',
                             A2='pore.item2',
                             A3='pore.item3',
                             A4='pore.item4',
                             A5='pore.item5',
                             A6='pore.item6',
                             X='pore.mole_fraction',
                             regen_mode='normal')
        self.alg = op.algorithms.ReactiveTransport(network=self.net,
                                                   phase=self.phase)
        self.alg.set_value_BC(values=0.4, pores=self.BC_pores)
        self.alg.set_source(propname='pore.source1',
                            pores=self.source_pores)
        self.alg.settings._update({'conductance': 'throat.diffusive_conductance',
                                   'quantity': 'pore.mole_fraction'})
        self.alg.run()
        self.phase.update(self.alg.soln)
        self.phase.regenerate_models(propnames='pore.source1')
        X = self.phase['pore.mole_fraction']
        r1 = np.sum(0.16e-13 * np.log(4*X[self.source_pores]**(1.4) + 0.133)
                    / np.log(10) - 5.1e-13)
        r2 = np.sum(self.phase['pore.source1.rate'][self.source_pores])
        assert_allclose(actual=r2, desired=r1)

    def test_natural_logarithm(self):
        self.phase['pore.item1'] = 0.16e-14
        self.phase['pore.item2'] = 4
        self.phase['pore.item3'] = 1.4
        self.phase['pore.item4'] = 0.133
        self.phase['pore.item5'] = -5.1e-14
        self.phase.add_model(propname='pore.source1',
                             model=pm.source_terms.natural_logarithm,
                             A1='pore.item1',
                             A2='pore.item2',
                             A3='pore.item3',
                             A4='pore.item4',
                             A5='pore.item5',
                             X='pore.mole_fraction',
                             regen_mode='on_demand')
        self.alg = op.algorithms.ReactiveTransport(network=self.net,
                                                   phase=self.phase)
        self.alg.set_value_BC(values=0.4, pores=self.BC_pores)
        self.alg.set_source(propname='pore.source1',
                            pores=self.source_pores)
        self.alg.settings._update({'conductance': 'throat.diffusive_conductance',
                                   'quantity': 'pore.mole_fraction'})
        self.alg.run()
        self.phase.update(self.alg.soln)
        self.phase.regenerate_models(propnames='pore.source1')
        X = self.phase['pore.mole_fraction']
        r1 = np.sum(0.16e-14*np.log(4*X[self.source_pores]**1.4 + 0.133) - 5.1e-14)
        r2 = np.sum(self.phase['pore.source1.rate'][self.source_pores])
        # assert_allclose(actual=r2, desired=r1)

    def test_general_symbolic(self):
        # natural log function
        y = "a*ln(b*x**c + d)+e"
        self.phase['pore.item1'] = 0.16e-14
        self.phase['pore.item2'] = 4
        self.phase['pore.item3'] = 1.4
        self.phase['pore.item4'] = 0.133
        self.phase['pore.item5'] = -5.1e-14
        self.phase.add_model(propname='pore.source1',
                             model=pm.source_terms.natural_logarithm,
                             A1='pore.item1',
                             A2='pore.item2',
                             A3='pore.item3',
                             A4='pore.item4',
                             A5='pore.item5',
                             X='pore.mole_fraction',
                             regen_mode='normal')
        arg_map = {'a': 'pore.item1',
                   'b': 'pore.item2',
                   'c': 'pore.item3',
                   'd': 'pore.item4',
                   'e': 'pore.item5'}
        self.phase.add_model(propname='pore.general',
                             model=op.models.physics.source_terms.general_symbolic,
                             eqn=y, x='pore.mole_fraction', **arg_map)
        assert np.allclose(self.phase['pore.source1.rate'],
                           self.phase['pore.general.rate'])
        assert np.allclose(self.phase['pore.source1.S1'],
                           self.phase['pore.general.S1'])
        assert np.allclose(self.phase['pore.source1.S2'],
                           self.phase['pore.general.S2'])

    def test_butler_volmer_kinetics(self):
        np.random.seed(10)
        self.net["pore.reaction_area"] = np.random.rand(self.net.Np)
        self.phase['pore.electrolyte_voltage'] = np.random.rand(self.net.Np) * 0.2
        self.phase['pore.solid_voltage'] = 1.1
        self.phase['pore.open_circuit_voltage'] = 1.2
        self.phase['pore.electrolyte_concentration'] = np.random.rand(self.net.Np)
        BV_params = {
            "n": 4,
            "i0_ref": 1e-3,
            "c_ref": 1000,
            "beta": 0.5,
            "gamma": 1
        }
        self.phase.add_model(propname='pore.rxn_BV_c',
                             model=pm.source_terms.butler_volmer_conc,
                             X="pore.electrolyte_concentration", **BV_params)
        self.phase.add_model(propname='pore.rxn_BV_v',
                             model=pm.source_terms.butler_volmer_voltage,
                             X="pore.electrolyte_voltage", **BV_params)
        # Check Butler-Volmer model (concentration)
        S1_BV_c = self.phase["pore.rxn_BV_c.S1"]
        S2_BV_c = self.phase["pore.rxn_BV_c.S2"]
        rate_BV_c = self.phase["pore.rxn_BV_c.rate"]
        eps = np.finfo(float).eps * np.abs(rate_BV_c).max()
        assert_allclose(S2_BV_c.mean(), 0, atol=eps)
        assert_allclose(S1_BV_c.mean(), -0.0008190647392381356)
        assert_allclose(rate_BV_c.mean(), -0.00040556020470030826)
        # Check Butler-Volmer model (voltage)
        S1_BV_v = self.phase["pore.rxn_BV_v.S1"]
        S2_BV_v = self.phase["pore.rxn_BV_v.S2"]
        rate_BV_v = self.phase["pore.rxn_BV_v.rate"]
        assert_allclose(S2_BV_v.mean(), 2104.1093852527683)
        assert_allclose(S1_BV_v.mean(), -12190.386173792602)
        assert_allclose(rate_BV_v.mean(), -156.52244418065774)
        # The two Butler-Volmer models must only differ by n*F (unit conversion)
        assert_allclose(rate_BV_v, rate_BV_c * BV_params["n"] * 96485.33212)


if __name__ == '__main__':

    t = GenericSourceTermTest()
    self = t
    t.setup_class()
    for item in t.__dir__():
        if item.startswith('test'):
            print(f"Running test: {item}")
            t.__getattribute__(item)()