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
use ion::{ Ion };
use molecule::{ Molecule };
use trait_element::{ Element };
use trait_properties::{ Properties };
use trait_reaction::{ Reaction };
use types::*;

use std::collections::HashMap;
use std::ops::*;


#[derive(Debug, Eq, PartialEq, Clone, Hash)]
/// An elementair reaction (not containing ions)
pub struct ElemReaction<E: Element> {
    /// The left-hand-side
    pub lhs: ReactionSide<E>,


    /// The right-hand-side
    pub rhs: ReactionSide<E>,


    // If it's an equilibrium
    pub is_equilibrium: bool
}


#[derive(Debug, Eq, PartialEq, Clone, Hash)]
/// A side of a reaction
pub struct ReactionSide<E: Element> {
    /// The compounds of this side
    pub compounds: Vec< ReactionCompound<E> >
}


#[derive(Debug, Eq, Clone, Hash)]
/// A reaction compound
pub struct ReactionCompound<E: Element> {
    /// The element it uses
    pub element: E,


    /// The amount of moles needed
    pub amount: u16
}



impl<E: Element> ElemReaction<E> {
    /// Convert a string representation of a reaction into one
    pub fn ion_from_string(string: String) -> Option< ElemReaction<Ion> > {
        let mut token = String::new();

        let mut lhs = None;
        let mut rhs = None;
        let mut is_equilibrium = false;

        for c in string.chars() {
            if c == '<' || c == '>' || c == '⇌' || c == '→' {
                if lhs == None {
                    lhs = ReactionSide::<Ion>::ion_from_string(token.clone());
                    token = String::new();
                }

                if c == '<' || c == '⇌' {
                    is_equilibrium = true;
                }

                continue;
            }

            token.push(c);
        }

        if token.len() > 0 {
            rhs = ReactionSide::<Ion>::ion_from_string(token.clone());
        }


        if let (Some(lhs), Some(rhs)) = (lhs, rhs) {
            Some(ElemReaction {
                lhs: lhs,
                rhs: rhs,
                is_equilibrium: is_equilibrium
            })
        } else {
            None
        }
    }


    /// Convert a string representation of a reaction into one
    pub fn molecule_from_string(string: String) -> Option< ElemReaction<Molecule> > {
        let mut token = String::new();

        let mut lhs = None;
        let mut rhs = None;
        let mut is_equilibrium = false;

        for c in string.chars() {
            if c == '<' || c == '>' || c == '⇌' || c == '→' {
                if lhs == None {
                    lhs = ReactionSide::<Molecule>::molecule_from_string(token.clone());
                    token = String::new();
                }

                if c == '<' || c == '⇌' {
                    is_equilibrium = true;
                }

                continue;
            }

            token.push(c);
        }

        if token.len() > 0 {
            rhs = ReactionSide::<Molecule>::molecule_from_string(token.clone());
        }


        if let (Some(lhs), Some(rhs)) = (lhs, rhs) {
            Some(ElemReaction {
                lhs: lhs,
                rhs: rhs,
                is_equilibrium: is_equilibrium
            })
        } else {
            None
        }
    }


    /// Get the sign of the equation ( → or ⇌ ), depending whether it is an equilibrium or not
    pub fn reaction_sign(&self) -> &str {
        if self.is_equilibrium {
            " ⇌ "
        } else {
            " → "
        }
    }


    /// Swap the equation
    pub fn swap(mut self) -> Self {
        let x = self.lhs;
        self.lhs = self.rhs;
        self.rhs = x;
        self
    }
}


impl<E: Element> ReactionSide<E> {
    /// Convert a string representation of a reactionside into one
    pub fn ion_from_string(symbol: String) -> Option< ReactionSide<Ion> > {
        let mut compounds = vec! {};

        let mut token = String::new();
        for c in symbol.chars() {
            if is_whitespace!(c) {
                continue;
            }

            if c == '+' {
                if let Some(compound) = ReactionCompound::<Ion>::ion_from_string(token) {
                    compounds.push(compound);
                }
                token = String::new();
                continue;
            }

            token.push(c);
        }

        if token.len() > 0 {
            if let Some(compound) = ReactionCompound::<Ion>::ion_from_string(token) {
                compounds.push(compound);
            }
        }


        if compounds.len() > 0 {
            Some(ReactionSide {
                compounds: compounds
            })
        } else {
            None
        }
    }


    /// Convert a string representation of a reactionside into one
    pub fn molecule_from_string(symbol: String) -> Option< ReactionSide<Molecule> > {
        let mut compounds = vec! {};

        let mut token = String::new();
        for c in symbol.chars() {
            if is_whitespace!(c) {
                continue;
            }

            if c == '+' {
                if let Some(compound) = ReactionCompound::<Molecule>::molecule_from_string(token) {
                    compounds.push(compound);
                }
                token = String::new();
                continue;
            }

            token.push(c);
        }

        if token.len() > 0 {
            if let Some(compound) = ReactionCompound::<Molecule>::molecule_from_string(token) {
                compounds.push(compound);
            }
        }


        if compounds.len() > 0 {
            Some(ReactionSide {
                compounds: compounds
            })
        } else {
            None
        }
    }


    /// Calculate the total charge of this reaction side
    pub fn total_charge(&self) -> IonCharge {
        let mut total_charge = 0;

        for compound in self.compounds.iter() {
            if let Some(charge) = compound.element.get_charge() {
                total_charge += charge;
            }
        }

        return total_charge;
    }


    /// Calculate the energy this side has
    pub fn energy(&self) -> Energy {
        // FIXME: Calculate actual energy
        1_000.0 - (self.compounds.len() as f64) * 100.0
    }


    /// Calculate the total amount of atoms this side contains
    pub fn total_atoms(&self) -> HashMap<AtomNumber, u16> {
        let mut atoms: HashMap<AtomNumber, u16> = HashMap::new();

        // for molecule_compound in self.compounds:
        for reaction_compound in self.compounds.iter() {
            if let Some(ref molecule) = reaction_compound.element.get_molecule() {
                for molecule_compound in molecule.compounds.iter() {


                    let atom_number = molecule_compound.atom.number;

                    if atom_number == 0 {
                        // Ignore electrons in the atom count
                        continue;
                    }

                    let mut amount;
                    if let Some(&old_amount) = atoms.get(&atom_number) {
                        amount = old_amount;
                    } else {
                        amount = 0;
                    }

                    amount += (molecule_compound.amount as u16) * reaction_compound.amount;

                    atoms.insert(atom_number, amount);
                }
            }
        }

        return atoms;
    }
}


impl<E: Element> ReactionCompound<E> {
    /// Convert a string representation of a reaction compound into one
    pub fn ion_from_string(symbol: String) -> Option< ReactionCompound<Ion> > {
        let mut amount: u16 = 0;
        let mut element = None;

        let mut set_amount = true;
        let mut token = String::new();

        for c in symbol.chars() {
            if set_amount && is_number!(c) {
                amount *= 10;
                amount += to_number!(c) as u16;
                continue;
            } else {
                set_amount = false;
            }

            token.push(c);
        }

        if token.len() > 0 {
            element = Ion::from_string(token);
        }

        if amount == 0 {
            amount = 1;
        }

        if let Some(element) = element {
            Some(ReactionCompound {
                amount: amount,
                element: element
            })
        } else {
            None
        }
    }


    /// Convert a string representation of a reaction compound into one
    pub fn molecule_from_string(symbol: String) -> Option< ReactionCompound<Molecule> > {
        let mut amount: u16 = 0;
        let mut element = None;

        let mut set_amount = true;
        let mut token = String::new();

        for c in symbol.chars() {
            if set_amount && is_number!(c) {
                amount *= 10;
                amount += to_number!(c) as u16;
                continue;
            } else {
                set_amount = false;
            }

            token.push(c);
        }

        if token.len() > 0 {
            element = Molecule::from_string(token);
        }

        if amount == 0 {
            amount = 1;
        }

        if let Some(element) = element {
            Some(ReactionCompound {
                amount: amount,
                element: element
            })
        } else {
            None
        }
    }
}


impl<E: Element> Reaction<E> for ElemReaction<E> {
    /// NOTE: This function is still a WIP!
    fn equalise(&self) -> bool {
        println!("####    The equalise function is not yet ready.");


        let total_left = self.lhs.total_atoms();
        let total_right = self.rhs.total_atoms();


        // If both sides are already equal, do nothing
        if total_left == total_right {
            return true;
        }

        for (atom_number, l_amount) in total_left {
            let r_amount: u16;

            match total_right.get(&atom_number) {
                Some(&x) => { r_amount = x },
                None => { r_amount = 0 }
            }

            if r_amount == 0 {
                println!("It's impossible to make this reaction work: {}", self);
                return false;
            }

            if l_amount != r_amount {
                let difference = {
                    if l_amount > r_amount {
                        l_amount - r_amount
                    } else {
                        r_amount - l_amount
                    }
                };

                if difference > 0 {
                    // Increase right side
                    println!("We know what to do, but it's just not implemented yet.");
                } else {
                    // Increase left side
                    println!("We know what to do, but it's just not implemented yet.");
                }
            }
        }

        // Actually false
        return true;
    }


    fn is_valid(&self) -> bool {
        self.lhs.total_atoms() == self.rhs.total_atoms()
        && self.lhs.total_charge() == self.lhs.total_charge()
    }


    fn energy_cost(&self) -> Energy {
        self.rhs.energy() - self.lhs.energy()
    }


    fn elem_reaction(&self) -> ElemReaction<E> {
        self.clone()
    }
}


impl<E: Element> Add for ReactionSide<E> {
    type Output = ReactionSide<E>;

    /// Adding two ReactionSide's adds their compounds
    fn add(self, mut rhs: ReactionSide<E>) -> ReactionSide<E> {
        let mut compounds = self.compounds.clone();
        compounds.append(&mut rhs.compounds);

        ReactionSide {
            compounds: compounds
        }
    }
}


impl<E: Element> Mul<u16> for ReactionSide<E> {
    type Output = ReactionSide<E>;

    /// Multiplying a ReactionSide with a number
    /// multiplies the amount of all compounds of that side
    fn mul(self, rhs: u16) -> ReactionSide<E> {
        let mut compounds = self.compounds.clone();

        for mut compound in compounds.iter_mut() {
            compound.amount *= rhs;
        }

        ReactionSide {
            compounds: compounds
        }
    }
}


impl<E: Element> PartialEq for ReactionCompound<E> {
    /// Two ReactionCompound's are equal if their elements are equal
    fn eq(&self, rhs: &ReactionCompound<E>) -> bool {
        self.element == rhs.element
    }
}


impl<E: Element> Properties for ElemReaction<E>  {
    fn symbol(&self) -> String {
        let mut symbol = String::new();

        symbol += &self.lhs.symbol();
        symbol += self.reaction_sign();
        symbol += &self.rhs.symbol();

        return symbol;
    }


    fn name(&self) -> String {
        let mut name = String::new();

        name += &self.lhs.name();
        name += self.reaction_sign();
        name += &self.rhs.name();

        return name;
    }


    fn mass(&self) -> AtomMass {
        // Law of Conservation of Mass
        0.0
    }
}


impl<E: Element> Properties for ReactionSide<E>  {
    fn symbol(&self) -> String {
        let mut symbol = String::new();

        let mut first = true;
        for reaction_compound in self.compounds.iter() {
            if ! first {
                symbol += " + ";
            }
            first = false;

            symbol += &reaction_compound.symbol();
        }

        return symbol;
    }


    fn name(&self) -> String {
        let mut name = String::new();

        let mut first = true;
        for reaction_compound in self.compounds.iter() {
            if ! first {
                name += " + ";
            }
            first = false;

            name += &reaction_compound.name();
        }

        return name;
    }


    fn mass(&self) -> AtomMass {
        let mut mass = 0.0;

        for ref reaction_compound in self.compounds.iter() {
            mass += reaction_compound.mass();
        }

        return mass;
    }
}


impl<E: Element> Properties for ReactionCompound<E>  {
    fn symbol(&self) -> String {
        let mut symbol = String::new();

        if self.amount > 1 {
            symbol += &self.amount.to_string();
        }

        symbol += &self.element.symbol();

        return symbol;
    }


    fn name(&self) -> String {
        let mut name = String::new();

        if self.amount > 1 {
            name += &self.amount.to_string();
            name += " ";
        }

        name += &self.element.name();

        return name;
    }


    fn mass(&self) -> AtomMass {
        return (self.amount as AtomMass) * self.element.mass();
    }
}


impl<E: Element> Element for ReactionCompound<E> {
    fn get_charge(&self) -> Option<IonCharge> {
        self.element.get_charge()
    }


    fn get_molecule(&self) -> Option<&Molecule> {
        self.element.get_molecule()
    }
}