li-ion-energy-source.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2010 Andrea Sacco
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Andrea Sacco <andrea.sacco85@gmail.com>
 */

#ifndef LI_ION_ENERGY_SOURCE_H
#define LI_ION_ENERGY_SOURCE_H

#include "ns3/traced-value.h"
#include "ns3/energy-source.h"
#include "ns3/nstime.h"
#include "ns3/event-id.h"

namespace ns3 {

class LiIonEnergySource : public EnergySource
{
public:
  static TypeId GetTypeId (void);
  LiIonEnergySource ();
  virtual ~LiIonEnergySource ();

  virtual double GetInitialEnergy (void) const;

  void SetInitialEnergy (double initialEnergyJ);

  virtual double GetSupplyVoltage (void) const;

  void SetInitialSupplyVoltage (double supplyVoltageV);

  virtual double GetRemainingEnergy (void);

  virtual double GetEnergyFraction (void);

  virtual void DecreaseRemainingEnergy (double energyJ);

  virtual void IncreaseRemainingEnergy (double energyJ);

  virtual void UpdateEnergySource (void);

  void SetEnergyUpdateInterval (Time interval);

  Time GetEnergyUpdateInterval (void) const;
private:
  void DoInitialize (void);
  void DoDispose (void);

  void HandleEnergyDrainedEvent (void);

  void CalculateRemainingEnergy (void);

  double GetVoltage (double current) const;

private:
  double m_initialEnergyJ;                // initial energy, in Joules
  TracedValue<double> m_remainingEnergyJ; // remaining energy, in Joules
  double m_drainedCapacity;               // capacity drained from the cell, in Ah
  double m_supplyVoltageV;                // actual voltage of the cell
  double m_lowBatteryTh;                  // low battery threshold, as a fraction of the initial energy
  EventId m_energyUpdateEvent;            // energy update event
  Time m_lastUpdateTime;                  // last update time
  Time m_energyUpdateInterval;            // energy update interval
  double m_eFull;                         // initial voltage of the cell, in Volts
  double m_eNom;                          // nominal voltage of the cell, in Volts
  double m_eExp;                          // cell voltage at the end of the exponential zone, in Volts
  double m_internalResistance;            // internal resistance of the cell, in Ohms
  double m_qRated;                        // rated capacity of the cell, in Ah
  double m_qNom;                          // cell capacity at the end of the nominal zone, in Ah
  double m_qExp;                          // capacity value at the end of the exponential zone, in Ah
  double m_typCurrent;                    // typical discharge current used to fit the curves
  double m_minVoltTh;                     // minimum threshold voltage to consider the battery depleted
};

} // namespace ns3

#endif /* LI_ION_ENERGY_SOURCE_H */