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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
import argparse
import pickle
import time
from functools import lru_cache
from math import exp, pi, sqrt, tan

import numpy as np
import scipy.integrate
import scipy.signal

import np_uptake.figures.utils as fiu
import np_uptake.model.system_definition as sysdef


class EnergyComputation:
    """A class that computes the total energy of the system

    Attributes:
    ----------
    None

    Methods:
    -------
    compute_bending_energy_zone_3(self, f, particle, s_list_region3):
        Computes the variation of bending energy in region 3
    compute_bending_energy_zone_2r(self, f, particle, mechanics, wrapping, membrane):
        Computes the variation of bending energy in region 2r
    compute_bending_energy_zone_2l(self, f, particle, mechanics, wrapping, membrane):
        Computes the variation of bending energy in region 2l
    sum_adimensional_bending_energy_contributions(self, adimensional_bending_energy_2r,
            adimensional_bending_energy_2l, adimensional_bending_energy_3):
        Computes the variation of bending energy in regions 2r, 2l and 3
    compute_adimensional_adhesion_energy(self, f, particle, mechanics, wrapping, l3):
        Computes the variation of adhesion energy
    compute_adimensional_tension_energy(self, f, particle, mechanics, wrapping, membrane, l3, r_2r,
            r_2l):
        Computes the variation of tension energy
    sum_adimensional_energy_contributions(self, total_adimensional_bending_energy,
            adimensional_adhesion_energy, adimensional_tension_energy):
        Computes the total variation of adimensional energy
    compute_total_adimensional_energy_for_a_given_wrapping_degree(self, f, particle, mechanics,
            wrapping, membrane):
        Computes the total variation of energy by executing the intermediate functions that have
            been introduced above
    compute_total_adimensional_energy_during_wrapping(self, particle, mechanics, wrapping,
            membrane):
        Computes the total variation of energy for all the wrapping degrees defined in the method
            Wrapping.wrapping_list by executing the intermediate functions that have been introduced
        above
    """

    def compute_bending_energy_zone_3(self, f, particle, s_list_region3):
        """Computes the variation of bending energy in region 3

        Parameters:
        ----------
        f: float
            Wrapping degree
        particle: class
            Parameters class which defines the geometry of the particle
        s_list_region3: array
            Discretization of the arclength in region 3

        Returns:
        ----------
        adimensionalized_energy: float
            The variation of the bending energy in the region 3 (bending of the membrane) between
            the state at wrapping f and the initial state: E(f) - E(0)
        """

        dpsi3_list_region3 = particle.get_squared_dpsi_region3(f)
        energy = scipy.integrate.simps(dpsi3_list_region3, s_list_region3[0:-1])
        adimensionalized_energy = 0.25 * particle.effective_radius * energy
        return adimensionalized_energy

    def compute_bending_energy_zone_2r(self, f, particle, mechanics, wrapping, membrane):
        """Computes the variation of bending energy in region 2r

        Parameters:
        ----------
        f: float
            Wrapping degree
        particle: class
            model.system_definition.ParticleGeometry class
        mechanics: class
            model.system_definition.MechanicalProperties_Adaptation class
        wrapping: class
            model.system_definition.Wrapping class
        membrane: class
            model.system_definition.MembraneGeometry class

        Returns:
        ----------
        adimensionalized_energy: float
            The variation of the bending energy in the region 2r (bending of the free membrane)
            between the state at wrapping f and the initial state: E(f) - E(0)
        """

        a = particle.get_alpha_angle(f)
        t = tan(0.25 * a)
        t2 = t ** 2
        b = sqrt(mechanics.sigma_bar / 2)
        energy = (
            -8
            * b
            / particle.effective_radius
            * t2
            * ((1 / (t2 + exp(2 * b * membrane.l2 / particle.effective_radius))) - (1 / (t2 + 1)))
        )
        adimensionalized_energy = 0.25 * particle.effective_radius * energy
        return adimensionalized_energy

    @lru_cache(maxsize=10)
    def compute_bending_energy_zone_2l(self, f, particle, mechanics, wrapping, membrane):
        """Computes the variation of bending energy in region 2l

        Parameters:
        ----------
        f: float
            Wrapping degree
        particle: class
            model.system_definition.ParticleGeometry class
        mechanics: class
            model.system_definition.MechanicalProperties_Adaptation class
        wrapping: class
            model.system_definition.Wrapping class
        membrane: class
            model.system_definition.MembraneGeometry class

        Returns:
        ----------
        adimensionalized_energy: float
            The variation of the bending energy in the region 2l (bending of the free membrane)
            between the state at wrapping f and the initial state: E(f) - E(0)
        """

        adimensionalized_energy_2r = self.compute_bending_energy_zone_2r(f, particle, mechanics, wrapping, membrane)
        adimensionalized_energy_2l = adimensionalized_energy_2r
        return adimensionalized_energy_2l

    @lru_cache(maxsize=10)
    def sum_adimensional_bending_energy_contributions(
        self,
        adimensional_bending_energy_2r,
        adimensional_bending_energy_2l,
        adimensional_bending_energy_3,
    ):
        """Computes the variation of bending energy in regions 2r, 2l and 3

        Parameters:
        ----------
        adimensional_bending_energy_2r: float
            The variation of the bending energy in the region 2r (bending of the membrane) between
            the state at wrapping f and the initial state: E(f) - E(0)
        adimensional_bending_energy_2l: float
            The variation of the bending energy in the region 2l (bending of the membrane) between
            the state at wrapping f and the initial state: E(f) - E(0)
        adimensional_bending_energy_3: float
            The variation of the bending energy in the region 3 (bending of the membrane) between
            the state at wrapping f and the initial state: E(f) - E(0)

        Returns:
        ----------
        total_adimensional_bending_energy: float
            The variation of the bending energy in regions 2r, 2l and 3 between the state at
            wrapping f and the initial state: E(f) - E(0)
        """

        total_adimensional_bending_energy = (
            adimensional_bending_energy_2r + adimensional_bending_energy_2l + adimensional_bending_energy_3
        )
        return total_adimensional_bending_energy

    @lru_cache(maxsize=10)
    def compute_adimensional_adhesion_energy(self, f, particle, mechanics, wrapping, l3):
        """Computes the variation of adhesion energy

        Parameters:
        ----------
        f: float
            Wrapping degree
        particle: class
            model.system_definition.ParticleGeometry class
        mechanics: class
            model.system_definition.MechanicalProperties_Adaptation class
        wrapping: class
            model.system_definition.Wrapping class
        l3: float
            total arclength of region 3

        Returns:
        ----------
        adimensional_adhesion_energy: float
            The variation of the adhesion energy
            between the state at wrapping f and the initial state: E(f) - E(0)
        """

        adimensional_adhesion_energy = -mechanics.gamma_bar(f, wrapping) * l3 * 0.25 / particle.effective_radius
        return adimensional_adhesion_energy

    def compute_adimensional_tension_energy(self, f, particle, mechanics, wrapping, membrane, l3, r_2r, r_2l):
        """Computes the variation of tension energy

        Parameters:
        ----------
        f: float
            Wrapping degree
        particle: class
            model.system_definition.ParticleGeometry class
        mechanics: class
            model.system_definition.MechanicalProperties_Adaptation class
        wrapping: class
            model.system_definition.Wrapping class
        membrane: class
            model.system_definition.MembraneGeometry class
        l3: float
            total arclength of region 3
        r2r: array
            r abscises in region 2r
        r2l: array
            r abscises in region 2l

        Returns:
        ----------
        adimensional_tension_energy: float
            The variation of the tension energy
            between the state at wrapping f and the initial state: E(f) - E(0)
        """

        adimensional_tension_energy = (
            mechanics.sigma_bar * (l3 + 2 * membrane.l2 - (r_2r[-1] - r_2l[-1])) * 0.25 / particle.effective_radius
        )
        return adimensional_tension_energy

    @lru_cache(maxsize=10)
    def sum_adimensional_energy_contributions(
        self, total_adimensional_bending_energy, adimensional_adhesion_energy, adimensional_tension_energy
    ):
        """Computes the total variation of adimensional energy

        Parameters:
        ----------
        adimensional_bending_energy: float
            The variation of the bending energy
            between the state at wrapping f and the initial state: E(f) - E(0)
        adimensional_adhesion_energy: float
            The variation of the adhesion energy
            between the state at wrapping f and the initial state: E(f) - E(0)
        adimensional_tension_energy: float
            The variation of the tension energy
            between the state at wrapping f and the initial state: E(f) - E(0)

        Returns:
        ----------
        total_adimensional_energy: float
            The sum of the contributions of energy
        """

        total_adimensional_energy = (
            total_adimensional_bending_energy + adimensional_adhesion_energy + adimensional_tension_energy
        )
        return total_adimensional_energy

    @lru_cache(maxsize=10)
    def compute_total_adimensional_energy_for_a_given_wrapping_degree(self, f, particle, mechanics, wrapping, membrane):
        """Computes the total variation of energy by executing the intermediate functions that have
            been introduced above

        Parameters:
        ----------
        f: float
            Wrapping degree
        particle: class
            model.system_definition.ParticleGeometry class
        mechanics: class
            model.system_definition.MechanicalProperties_Adaptation class
        wrapping: class
            model.system_definition.Wrapping class
        membrane: class
            model.system_definition.MembraneGeometry class

        Returns:
        ----------
        total_adimensional_energy: float
            The variation of the total adimensional energy
        """
        _, _, _, _, s_list_region3, l3, _, _ = particle.define_particle_geometry_variables(f)
        r_2r, _, r_2l, _ = membrane.compute_r2r_r2l_z2r_z2l_from_analytic_expression(f, particle, mechanics, wrapping)
        adimensional_bending_energy_2r = self.compute_bending_energy_zone_2r(f, particle, mechanics, wrapping, membrane)

        adimensional_bending_energy_2l = self.compute_bending_energy_zone_2l(f, particle, mechanics, wrapping, membrane)

        adimensional_bending_energy_3 = self.compute_bending_energy_zone_3(f, particle, s_list_region3)

        total_adimensional_bending_energy = self.sum_adimensional_bending_energy_contributions(
            adimensional_bending_energy_2r, adimensional_bending_energy_2l, adimensional_bending_energy_3
        )
        adimensional_adhesion_energy = self.compute_adimensional_adhesion_energy(f, particle, mechanics, wrapping, l3)
        adimensional_tension_energy = self.compute_adimensional_tension_energy(
            f, particle, mechanics, wrapping, membrane, l3, r_2r, r_2l
        )

        total_adimensional_energy = self.sum_adimensional_energy_contributions(
            total_adimensional_bending_energy, adimensional_adhesion_energy, adimensional_tension_energy
        )

        return total_adimensional_energy

    def compute_total_adimensional_energy_during_wrapping(self, particle, mechanics, wrapping, membrane):
        """Computes the total variation of energy for all the wrapping degrees defined in the
            method Wrapping.wrapping_list by executing the intermediate functions that have been
            introduced above

        Parameters:
        ----------
        particle: class
            model.system_definition.ParticleGeometry class
        mechanics: class
            model.system_definition.MechanicalProperties_Adaptation class
        wrapping: class
            model.system_definition.Wrapping class
        membrane: class
            model.system_definition.MembraneGeometry class

        Returns:
        ----------
        adimensional_total_energy_variation_list: array
            The variation of the total adimensional energy for the wrapping degrees defined in
            Wrapping.wrapping_list
        energy_variation_computation_time_list: array
            Computation time compute each element of adimensional_total_energy_variation_list
        """

        adimensional_total_energy_variation_list = np.zeros_like(wrapping.wrapping_list)
        energy_variation_computation_time_list = np.zeros_like(adimensional_total_energy_variation_list)

        for i in range(len(wrapping.wrapping_list)):
            f = wrapping.wrapping_list[i]
            start = time.process_time()
            total_adimensional_energy = self.compute_total_adimensional_energy_for_a_given_wrapping_degree(
                f, particle, mechanics, wrapping, membrane
            )

            end = time.process_time()
            energy_variation_computation_time = end - start
            adimensional_total_energy_variation_list[i] = total_adimensional_energy
            energy_variation_computation_time_list[i] = energy_variation_computation_time
        return adimensional_total_energy_variation_list, energy_variation_computation_time_list


def plot_energy(
    particle, mechanics, membrane, wrapping, energy_computation, createfigure, fonts, xticks, xticklabels, savefigure
):
    """Plots the evolution of the adimensional variation of energy_computation during wrapping

    Parameters:
    ----------
    particle: class
        model.system_definition.ParticleGeometry class
    mechanics: class
        model.system_definition.MechanicalProperties_Adaptation class
    membrane: class
        model.system_definition.MembraneGeometry class
    wrapping: class
        model.system_definition.Wrapping class
    createfigure: class
        figures.utils.CreateFigure class
    fonts: class
        figures.utils.Fonts class
    xticks: class
        figures.utils.XTicks class
    xticklabels: class
        figures.utils.XTickLabels class
    savefigure: class
        figures.utils.SaveFigure class

    Returns:
    -------
    None
    """

    energy_list, _ = energy_computation.compute_total_adimensional_energy_during_wrapping(
        particle, mechanics, wrapping, membrane
    )
    fig = createfigure.square_figure_7(pixels=360)
    ax = fig.gca()
    ax.plot(
        wrapping.wrapping_list,
        energy_list,
        "-k",
        label=r"$\overline{r} = $"
        + str(np.round(particle.r_bar, 2))
        + r" ; $\overline{\gamma}_0 = $"
        + str(mechanics.gamma_bar_0)
        + r" ; $\overline{\sigma} = $"
        + str(mechanics.sigma_bar),
        linewidth=4,
    )
    ax.set_xticks(xticks.energy_plots())
    ax.set_xticklabels(
        xticklabels.energy_plots(),
        font=fonts.serif(),
        fontsize=fonts.axis_legend_size(),
    )
    ax.set_yticks([-15, -10, -5, 0, 5])
    ax.set_yticklabels(
        ["-15", "-10", "-5", "0", "5"],
        font=fonts.serif(),
        fontsize=fonts.axis_legend_size(),
    )
    ax.legend(prop=fonts.serif(), loc="lower left", framealpha=0.9)
    ax.set_xlabel(r"$f$ [ - ]", font=fonts.serif(), fontsize=fonts.axis_label_size())
    ax.set_ylabel(r"$\overline{\Delta E}$ [ - ]", font=fonts.serif(), fontsize=fonts.axis_label_size())

    savefigure.save_as_png(fig, "DeltaE_vs_f")


def identify_wrapping_phase(particle, mechanics, membrane, wrapping, energy_computation):
    """Identifies the wrapping phase following the process introduced in [1]

    Parameters:
    ----------
    particle: class
        model.system_definition.ParticleGeometry object
    mechanics: class
        model.system_definition.MechanicalProperties_Adaptation object
    membrane: class
        model.system_definition.MembraneGeometry object
    energy_computation: class
        model.system_definition.EnergyComputation object

    Returns:
    -------
    f_eq: float
        Wrapping degree at equilibrium
    wrapping_phase_number: float
        Phase number (1, 2 or 3)
    wrapping_phase: str
        The wrapping phase as an intelligible string
    energy_list: array
        The variation of the total adimensional energy for the wrapping degrees defined in
        Wrapping.wrapping_list
        Output from function EnergyComputation.compute_total_adimensional_energy_during_wrapping
    time_list: array
        Computation time compute each element of adimensional_total_energy_variation_list
        Output from function EnergyComputation.compute_total_adimensional_energy_during_wrapping
    """

    pickle.dumps(energy_computation.compute_total_adimensional_energy_during_wrapping)
    pickle.dumps(membrane.compute_r2r_r2l_z2r_z2l_from_analytic_expression)
    energy_list, time_list = energy_computation.compute_total_adimensional_energy_during_wrapping(
        particle, mechanics, wrapping, membrane
    )
    min_energy_index_list = scipy.signal.argrelmin(energy_list)
    min_energy_index_list = min_energy_index_list[0]
    # check if the minimum is reached for wrapping.wrapping_list[-1]
    if energy_list[-1] < energy_list[-2]:
        min_energy_index_list = np.concatenate((min_energy_index_list, np.array([-1])), axis=None)

    # check if the minimum is reached for wrapping.wrapping_list[0]
    if energy_list[0] < energy_list[1]:
        min_energy_index_list = np.concatenate((np.array(wrapping.wrapping_list[0]), min_energy_index_list), axis=None)
    if len(min_energy_index_list) == 0:
        min_energy_index_list = [0]
    min_energy_list = [energy_list[int(k)] for k in min_energy_index_list]
    f_min_energy_list = [wrapping.wrapping_list[int(k)] for k in min_energy_index_list]
    # managing possible scipy.signal.argrelextrema outuput types
    if type(min_energy_list[0]) == np.ndarray:
        min_energy_list = min_energy_list[0]
        f_min_energy_list = f_min_energy_list[0]

    f_eq = f_min_energy_list[0]
    wrapping_phase_number = 0
    wrapping_phase = "0"

    if f_eq < 0.2:  # check if wrapping phase is phase 1, according to [1]
        wrapping_phase_number = 1
        wrapping_phase = "no wrapping"
    else:
        r2r, _, r2l, _ = membrane.compute_r2r_r2l_z2r_z2l_from_analytic_expression(f_eq, particle, mechanics, wrapping)
        intersection_membrane = min(r2r) - max(r2l)
        wrapping_phase_number = 3 if intersection_membrane < 0 else 2
        wrapping_phase = "full wrapping" if intersection_membrane < 0 else "partial wrapping"
    return (f_eq, wrapping_phase_number, wrapping_phase, energy_list, time_list)


def parse_arguments():
    """Parses arguments to run the code in terminal

    Parameters:
    ----------
    None

    Returns:
    -------
    args: class
        Parse of the arguments of the code
    """

    parser = argparse.ArgumentParser()
    parser.add_argument(
        "-g0",
        "--gamma_bar_0",
        required=False,
        default=10.0,
        type=float,
        help="initial adimensional lineic adhesion bt membrane and NP. Default value = 10.",
    )
    parser.add_argument(
        "-gr",
        "--gamma_bar_r",
        required=False,
        default=1.0,
        type=float,
        help="ratio of adimensional lineic adhesion bt membrane and NP. Default value = 1.",
    )
    parser.add_argument(
        "-gfs",
        "--gamma_bar_fs",
        required=False,
        default=0.0,
        type=float,
        help="adimensional lineic adhesion between the membrane and the particle, inflexion point. Default value = 0.",
    )
    parser.add_argument(
        "-glambda",
        "--gamma_bar_lambda",
        required=False,
        default=10.0,
        type=float,
        help="adimensional lineic adhesion between the membrane and the particle, smoothness. Default value = 10.",
    )
    parser.add_argument(
        "-s0",
        "--sigma_bar_0",
        required=False,
        default=2.0,
        type=float,
        help="adimensional membrane tension, value before wrapping. Default value = 2.",
    )
    parser.add_argument(
        "-sr",
        "--sigma_bar_r",
        required=False,
        default=1.0,
        type=float,
        help="adimensional membrane tension, ratio between final and initial value. Default value = 1.",
    )
    parser.add_argument(
        "-sfs",
        "--sigma_bar_fs",
        required=False,
        default=0.0,
        type=float,
        help="adimensional membrane tension, inflexion point. Default value = 0.",
    )
    parser.add_argument(
        "-slambda",
        "--sigma_bar_lambda",
        required=False,
        default=-10.0,
        type=float,
        help="adimensional membrane tension, smoothness. Default value = -10.",
    )
    parser.add_argument(
        "-r", "--r_bar", required=False, default=1.0, type=float, help="particle aspect ratio. Default value = 1."
    )
    parser.add_argument(
        "-p",
        "--particle_perimeter",
        required=False,
        default=2 * pi,
        type=float,
        help="particle perimeter. Default value = 2pi.",
    )

    args = parser.parse_args()
    return args


if __name__ == "__main__":
    args = parse_arguments()
    createfigure = fiu.CreateFigure()
    fonts = fiu.Fonts()
    savefigure = fiu.SaveFigure()
    xticks = fiu.XTicks()
    xticklabels = fiu.XTickLabels()
    particle = sysdef.ParticleGeometry(r_bar=1, particle_perimeter=2 * pi, sampling_points_circle=300)

    mechanics = sysdef.MechanicalProperties_Adaptation(
        testcase="testcase",
        gamma_bar_r=args.gamma_bar_r,
        gamma_bar_fs=args.gamma_bar_fs,
        gamma_bar_lambda=args.gamma_bar_lambda,
        gamma_bar_0=args.gamma_bar_0,
        sigma_bar=args.sigma_bar_0,
    )

    membrane = sysdef.MembraneGeometry(particle, sampling_points_membrane=100)

    wrapping = sysdef.Wrapping(wrapping_list=np.arange(0.03, 0.97, 0.003125))

    energy_computation = EnergyComputation()

    plot_energy(
        particle,
        mechanics,
        membrane,
        wrapping,
        energy_computation,
        createfigure,
        fonts,
        xticks,
        xticklabels,
        savefigure,
    )
    f_eq, wrapping_phase_number, wrapping_phase, energy_list, time_list = identify_wrapping_phase(
        particle, mechanics, membrane, wrapping, energy_computation
    )
    print("wrapping degree at equilibrium = ", np.round(f_eq, 2))
    print("wrapping phase at equilibrium: ", wrapping_phase)