util_error.hpp

Go to the documentation of this file.

/*
 * Util_error.hpp
 *
 * Utility functions for error. So the code is less verbose.
 *
 * A cycler implements check-up procedures and degradation procedures.
 * The data from the check-up procedures is written in csv files in the same subfolder as where the cycling data of a cell is written (see BasicCycler.cpp).
 * There is one file per 'type' of check-up (capacity measurement, OCV measurement, CCCV cycles and a pulse discharge).
 *
 * Copyright (c) 2019, The Chancellor, Masters and Scholars of the University
 * of Oxford, VITO nv, and the 'Slide' Developers.
 * See the licence file LICENCE.txt for more information.
 */
 
#pragma once
 
#include "../cells/Cell.hpp"
 
class Cell;
 
namespace slide::util::error {
void checkInputParam_CalAge(Cell &c, double V, double Ti, int Time, int timeCheck, int mode);
void checkInputParam_CC_V_CV_I(Cell &c, double Crate, double Vset, double Ccut);
void checkInputParam_CycAge(Cell &c, double Vma, double Vmi, double Ccha, double Ccutcha,
                            double Cdis, double Ccutdis, double Ti, int nrCycles, int nrCap);
 
inline void checkInputParam_CalAge(Cell &c, double V, double Ti, int Time, int timeCheck, int mode)
{
 
  bool vmax = V > c.Vmax(); 
  if (vmax)
    std::cerr << "Error in Cycler::CalendarAgeing. The voltage " << V << " is too high. The maximum value is " << c.Vmax() << ".\n";
 
  bool vmin = V < c.Vmin(); 
  if (vmin)
    std::cerr << "Error in Cycler::CalendarAgeing. The voltage " << V << " is too low. The minimum value is " << c.Vmin() << ".\n";
 
  bool Temin = Ti < settings::Tmin_K; 
  if (Temin)
    std::cerr << "Error in Cycler::CalendarAgeing. The temperature " << Ti << "K is too low. The minimum value is 273.\n";
 
  bool Temax = Ti > settings::Tmax_K; 
  if (Temax)
    std::cerr << "Error in Cycler::CalendarAgeing. The temperature " << Ti << " is too high. The maximum value is (273+60).\n";
 
  bool mod = (mode < 0 || mode > 2); 
  if (mod)
    std::cerr << "Error in Cycler::CalendarAgeing. The resting mode " << mode << " is illegal. Only values of 0, 1 or 2 are allowed.\n";
 
  bool cycles = (std::fmod(Time, timeCheck) > 1); 
  if (cycles)                                     
    std::cerr << "Error in Cycler::CalendarAgeing. The total resting time " << Time
              << " is not a multiple of the time between two check ups " << timeCheck << ".\n";
 
  if (vmax || vmin || Temin || Temax || mod || cycles)
    throw 1014;
 
  if (mode == 2)
    std::cout << "Warning in Cycler::CalendarAgeing. You have chosen to float the cell at a constant voltage for a long period. "
                 "It will take long to simulate this.\n";
}
 
inline void checkInputParam_CC_V_CV_I(Cell &c, double Crate, double Vset, double Ccut)
{
 
  bool vmax = Vset > c.Vmax(); 
  if (vmax)
    std::cerr << "Error in BasicCycler::CC_V_CV_I. The voltage " << Vset << " is too high. The maximum value is " << c.Vmax() << ".\n";
 
  bool vmin = Vset < c.Vmin(); 
  if (vmin)
    std::cerr << "Error in BasicCycler::CC_V_CV_I. The voltage " << Vset << " is too low. The minimum value is " << c.Vmin() << ".\n";
 
  if (vmax || vmin)
    throw 1005;
 
  bool currCV = Ccut < 0;
  if (currCV) {
    std::cerr << "Error in BasicCycler::CC_V_CV_I. The cutoff C rate " << Ccut << " is negative. It must be positive.\n";
 
    throw 1008;
  }
 
  bool currCC = Crate < 0;
  if (currCC) {
    std::cerr << "Error in BasicCycler::CC_V_CV_I. The Crate " << Crate << " is negative. It must be positive.\n";
    throw 1010;
  }
}
 
inline void checkInputParam_CycAge(Cell &c, double Vma, double Vmi, double Ccha, double Ccutcha,
                                   double Cdis, double Ccutdis, double Ti, int nrCycles, int nrCap)
{
  bool vmax = Vma > c.Vmax(); 
  if (vmax)
    std::cerr << "Error in Cycler::cycleAgeing. The maximum voltage " << Vma << " is too high. The maximum value is " << c.Vmax() << ".\n";
 
  bool vmin = Vmi < c.Vmin(); 
  if (vmin)
    std::cerr << "Error in Cycler::cycleAgeing. The minimum voltage " << Vmi << " is too low. The minimum value is " << c.Vmin() << ".\n";
 
  bool Temin = Ti < settings::Tmin_Cell_K; 
  if (Temin)
    std::cerr << "Error in Cycler::cycleAgeing. The temperature " << Ti << "K is too low. The minimum value is 273.\n";
 
  bool Temax = Ti > settings::Tmax_Cell_K; 
  if (Temax)
    std::cerr << "Error in Cycler::cycleAgeing. The temperature " << Ti << " is too high. The maximum value is (273+60).\n";
 
  bool cchar = Ccha <= 0; 
  if (cchar)
    std::cerr << "Error in Cycler::cycleAgeing. The charging Crate " << Ccha << " is negative. It must be positive.\n";
 
  bool cdis = Cdis <= 0; 
  if (cdis)
    std::cerr << "Error in Cycler::cycleAgeing. The discharging Crate " << Cdis << " is negative. It must be positive.\n";
 
  bool ccvchar = Ccutcha <= 0; 
  if (ccvchar)
    std::cerr << "Error in Cycler::cycleAgeing. The Crate of the cutoff current for the CV charge " << Ccutcha << " is negative. It must be positive.\n";
 
  bool ccvdis = Ccutdis <= 0; 
  if (ccvdis)
    std::cerr << "Error in Cycler::cycleAgeing. The Crate of the cutoff current for the CV discharge " << Ccutdis << " is negative. It must be positive.\n";
 
  bool cycles = nrCycles <= nrCap; 
  if (cycles)
    std::cerr << "Error in Cycler::cycleAgeing. The number of cycles between two check ups " << nrCap << " is higher than the total number of cycles " << nrCycles << ".\n";
 
  if (vmax || vmin || Temin || Temax || cchar || cdis || ccvchar || ccvdis || cycles)
    throw 1014;
}
 
} // namespace slide::util::error