Attachment #2413 for bug #2403

View | Details | Raw Unified | Return to bug 2403
Collapse All | Expand All

(-)a/src/energy/model/basic-energy-source.cc (-9 / +58 lines)

Lines 40-49	Link Here

    .AddConstructor<BasicEnergySource> ()

    .AddConstructor<BasicEnergySource> ()

    .AddAttribute ("BasicEnergySourceInitialEnergyJ",

    .AddAttribute ("BasicEnergySourceInitialEnergyJ",

                   "Initial energy stored in basic energy source.",

                   "Initial energy stored in basic energy source.",

                   DoubleValue (10),  // in Joules

                   DoubleValue (0),  // in Joules

                   MakeDoubleAccessor (&BasicEnergySource::SetInitialEnergy,

                   MakeDoubleAccessor (&BasicEnergySource::SetInitialEnergy,

                                       &BasicEnergySource::GetInitialEnergy),

                                       &BasicEnergySource::GetInitialEnergy),

                   MakeDoubleChecker<double> ())

                   MakeDoubleChecker<double> ())

    .AddAttribute ("BasicEnergySourceCapacityJ",

                   "Energy capacity that can be stored in basic energy source.",

                   DoubleValue (0),  // in Joules

                   MakeDoubleAccessor (&BasicEnergySource::SetEnergyCapacity,

                                       &BasicEnergySource::GetEnergyCapacity),

                   MakeDoubleChecker<double> ())

    .AddAttribute ("BasicEnergySupplyVoltageV",

    .AddAttribute ("BasicEnergySupplyVoltageV",

                   "Initial supply voltage for basic energy source.",

                   "Initial supply voltage for basic energy source.",

                   DoubleValue (3.0), // in Volts

                   DoubleValue (3.0), // in Volts

Lines 77-82	Link Here

BasicEnergySource::BasicEnergySource ()

BasicEnergySource::BasicEnergySource ()

  NS_LOG_FUNCTION (this);

  NS_LOG_FUNCTION (this);

  m_energyCapacityJ = 0;

  m_lastUpdateTime = Seconds (0.0);

  m_lastUpdateTime = Seconds (0.0);

  m_depleted = false;

  m_depleted = false;

Lines 91-98	Link Here

  NS_LOG_FUNCTION (this << initialEnergyJ);

  NS_LOG_FUNCTION (this << initialEnergyJ);

  NS_ASSERT (initialEnergyJ >= 0);

100

  NS_ASSERT (initialEnergyJ >= 0);

101

  NS_ASSERT (initialEnergyJ <= m_energyCapacityJ || m_energyCapacityJ == 0);

  m_initialEnergyJ = initialEnergyJ;

102

  m_initialEnergyJ = initialEnergyJ;

  m_remainingEnergyJ = m_initialEnergyJ;

103

  m_remainingEnergyJ = m_initialEnergyJ;

104

  if(m_energyCapacityJ == 0)

105

106

      m_energyCapacityJ = m_initialEnergyJ;

107

108

109

void

110

void

Lines 145-151	Link Here

145

  NS_LOG_FUNCTION (this);

157

  NS_LOG_FUNCTION (this);

146

  // update energy source to get the latest remaining energy.

158

  // update energy source to get the latest remaining energy.

147

  UpdateEnergySource ();

159

  UpdateEnergySource ();

148

  return m_remainingEnergyJ / m_initialEnergyJ;

160

  if(m_energyCapacityJ == 0)

161

162

      return 0;

163

164

  return m_remainingEnergyJ / m_energyCapacityJ;

149

165

150

166

151

void

167

void

Lines 161-166	Link Here

161

177

162

178

163

  m_energyUpdateEvent.Cancel ();

179

  m_energyUpdateEvent.Cancel ();

180

181

  if(m_energyCapacityJ == 0)

182

183

      m_energyCapacityJ = m_initialEnergyJ;

184

185

  if(m_initialEnergyJ == 0)

186

187

      m_initialEnergyJ = m_energyCapacityJ;

188

164

189

165

  CalculateRemainingEnergy ();

190

  CalculateRemainingEnergy ();

166

191

Lines 183-188	Link Here

183

                                             this);

208

                                             this);

184

209

185

210

211

void

212

BasicEnergySource::SetEnergyCapacity (double energyCapacityJ)

213

214

  NS_LOG_FUNCTION (this << energyCapacityJ);

215

  NS_ASSERT (energyCapacityJ >= 0);

216

  NS_ASSERT (energyCapacityJ >= m_initialEnergyJ || energyCapacityJ == 0);

217

  m_energyCapacityJ = energyCapacityJ;

218

  if(m_initialEnergyJ == 0)

219

220

      m_initialEnergyJ = m_energyCapacityJ;

221

      m_remainingEnergyJ = m_initialEnergyJ;

222

223

224

225

double

226

BasicEnergySource::GetEnergyCapacity () const

227

228

  NS_LOG_FUNCTION (this);

229

  return m_energyCapacityJ;

230

231

186

/*

232

/*

187

 * Private functions start here.

233

 * Private functions start here.

188

*/

234

*/

Lines 226-240	Link Here

226

  NS_ASSERT (duration.GetSeconds () >= 0);

272

  NS_ASSERT (duration.GetSeconds () >= 0);

227

  // energy = current * voltage * time

273

  // energy = current * voltage * time

228

  double energyToDecreaseJ = totalCurrentA * m_supplyVoltageV * duration.GetSeconds ();

274

  double energyToDecreaseJ = totalCurrentA * m_supplyVoltageV * duration.GetSeconds ();

229

275

230

  if (m_remainingEnergyJ < energyToDecreaseJ)

276

  // handles consuming energy below the low battery threshold

277

  if (m_remainingEnergyJ <= m_energyCapacityJ * m_lowBatteryTh && energyToDecreaseJ > 0)

231

278

232

      m_remainingEnergyJ = 0; // energy never goes below 0

279

      energyToDecreaseJ = 0;

233

280

234

  else

281

  // handles recharging above the energy capacity

282

  if (m_remainingEnergyJ >= m_energyCapacityJ && energyToDecreaseJ < 0)

235

283

236

      m_remainingEnergyJ -= energyToDecreaseJ;

284

      energyToDecreaseJ = 0;

237

285

286

  m_remainingEnergyJ -= energyToDecreaseJ;

238

287

239

  NS_LOG_DEBUG ("BasicEnergySource:Remaining energy = " << m_remainingEnergyJ);

288

  NS_LOG_DEBUG ("BasicEnergySource:Remaining energy = " << m_remainingEnergyJ);

240

289

(-)a/src/energy/model/basic-energy-source.h (+19 lines)

Lines 47-52	Link Here

   * Implements GetInitialEnergy.

   * Implements GetInitialEnergy.

*/

*/

  virtual double GetInitialEnergy (void) const;

  virtual double GetInitialEnergy (void) const;

/**

   * \return The source energy capacity, in Joules.

   * Implements GetEnergyCapacity.

*/

  virtual double GetEnergyCapacity (void) const;

/**

/**

   * \returns Supply voltage at the energy source.

   * \returns Supply voltage at the energy source.

Lines 80-87	Link Here

   * Sets initial energy stored in the energy source. Note that initial energy

   * Sets initial energy stored in the energy source. Note that initial energy

   * is assumed to be set before simulation starts and is set only once per

   * is assumed to be set before simulation starts and is set only once per

   * simulation.

   * simulation.

   * Note that if the initial energy is not set, it is assumed to be equal to

   * the source energy capacity.

*/

*/

  void SetInitialEnergy (double initialEnergyJ);

  void SetInitialEnergy (double initialEnergyJ);

/**

   * \param The source energy capacity, in Joules.

   * Sets the energy capacity of the source.

   * Note that if the energy capacity is not set, it is assumed to be equal to

100

   * the initial energy.

101

*/

102

  void SetEnergyCapacity (double energyCapacityJ);

103

/**

104

/**

   * \param supplyVoltageV Supply voltage at the energy source, in Volts.

105

   * \param supplyVoltageV Supply voltage at the energy source, in Volts.

Lines 137-142	Link Here

137

155

138

private:

156

private:

139

  double m_initialEnergyJ;                // initial energy, in Joules

157

  double m_initialEnergyJ;                // initial energy, in Joules

158

  double m_energyCapacityJ;               // energy capacity, in Joules

140

  double m_supplyVoltageV;                // supply voltage, in Volts

159

  double m_supplyVoltageV;                // supply voltage, in Volts

141

  double m_lowBatteryTh;                  // low battery threshold, as a fraction of the initial energy

160

  double m_lowBatteryTh;                  // low battery threshold, as a fraction of the initial energy

142

  double m_highBatteryTh;                 // high battery threshold, as a fraction of the initial energy

161

  double m_highBatteryTh;                 // high battery threshold, as a fraction of the initial energy

(-)a/src/energy/model/energy-source.h (+8 lines)

Lines 100-105	Link Here

100

   * with a fixed initial energy (energy capacity), set method is not needed.

100

   * with a fixed initial energy (energy capacity), set method is not needed.

101

*/

101

*/

102

  virtual double GetInitialEnergy (void) const = 0;

102

  virtual double GetInitialEnergy (void) const = 0;

103

104

/**

105

   * \returns Energy capacity of the energy source.

106

107

   * Set method is to be defined in child class only if necessary. For sources

108

   * with a fixed energy capacity, set method is not needed.

109

*/

110

  virtual double GetEnergyCapacity (void) const = 0;

103

111

104

/**

112

/**

105

   * \returns Remaining energy at the energy source.

113

   * \returns Remaining energy at the energy source.




    .SetGroupName ("Energy")
    .AddConstructor<LiIonEnergySource> ()
    .AddAttribute ("LiIonEnergySourceInitialEnergyJ",
                   "Initial energy stored in LiIon energy source.",
                   DoubleValue (0),  // in Joules
                   MakeDoubleAccessor (&LiIonEnergySource::SetInitialEnergy,
                                       &LiIonEnergySource::GetInitialEnergy),
                   MakeDoubleChecker<double> ())
    .AddAttribute ("LiIonEnergySourceCapacityJ",
                   "Energy capacity that can be stored in LiIon energy source.",
                   DoubleValue (0),  // in Joules
                   MakeDoubleAccessor (&LiIonEnergySource::SetEnergyCapacity,
                                       &LiIonEnergySource::GetEnergyCapacity),
                   MakeDoubleChecker<double> ())
    .AddAttribute ("LiIonEnergyLowBatteryThreshold",
                   "Low battery threshold for LiIon energy source.",
                   DoubleValue (0.10), // as a fraction of the initial energy

}

LiIonEnergySource::LiIonEnergySource ()
  : m_energyCapacityJ (0.0),
    m_drainedCapacity (0.0),
    m_lastUpdateTime (Seconds (0.0))
{
  NS_LOG_FUNCTION (this);

{
  NS_LOG_FUNCTION (this << initialEnergyJ);
  NS_ASSERT (initialEnergyJ >= 0);
  NS_ASSERT (initialEnergyJ <= m_energyCapacityJ || m_energyCapacityJ == 0);
  m_initialEnergyJ = initialEnergyJ;
  // set remaining energy to be initial energy
  m_remainingEnergyJ = m_initialEnergyJ;
  if(m_energyCapacityJ == 0)
    {
      m_energyCapacityJ = m_initialEnergyJ;
    }
}

double

  NS_LOG_FUNCTION (this);
  // update energy source to get the latest remaining energy.
  UpdateEnergySource ();
  if(m_energyCapacityJ == 0)
    {
      return 0;
    }
  return m_remainingEnergyJ / m_initialEnergyJ;
}


    }

  m_energyUpdateEvent.Cancel ();
  
  if(m_energyCapacityJ == 0)
    {
      m_energyCapacityJ = m_initialEnergyJ;
    }
  if(m_initialEnergyJ == 0)
    {
      m_initialEnergyJ = m_energyCapacityJ;
    }

  CalculateRemainingEnergy ();


                                             this);
}

void
LiIonEnergySource::SetEnergyCapacity (double energyCapacityJ)
{
  NS_LOG_FUNCTION (this << energyCapacityJ);
  NS_ASSERT (energyCapacityJ >= 0);
  NS_ASSERT (energyCapacityJ >= m_initialEnergyJ || energyCapacityJ == 0);
  m_energyCapacityJ = energyCapacityJ;
  if(m_initialEnergyJ == 0)
    {
      m_initialEnergyJ = m_energyCapacityJ;
      m_remainingEnergyJ = m_initialEnergyJ;
    }
}

double
LiIonEnergySource::GetEnergyCapacity () const
{
  NS_LOG_FUNCTION (this);
  return m_energyCapacityJ;
}

/*
 * Private functions start here.
 */

  // energy = current * voltage * time
  double energyToDecreaseJ = totalCurrentA * m_supplyVoltageV * duration.GetSeconds ();

  // handles consuming energy below the low battery threshold
  if (m_remainingEnergyJ <= m_energyCapacityJ * m_lowBatteryTh && energyToDecreaseJ > 0)
    {
      energyToDecreaseJ = 0;
    }
  // handles recharging above the energy capacity
  if (m_remainingEnergyJ >= m_energyCapacityJ && energyToDecreaseJ < 0) 
    {
      energyToDecreaseJ = 0;
    }
  m_remainingEnergyJ -= energyToDecreaseJ;

  m_drainedCapacity += (totalCurrentA * duration.GetSeconds () / 3600);
  // update the supply voltage




   * before simulation starts and is set only once per simulation.
   */
  void SetInitialEnergy (double initialEnergyJ);
  
  /**
   * \return The source energy capacity, in Joules.
   *
   * Implements GetEnergyCapacity.
   */
  virtual double GetEnergyCapacity (void) const;
  
  /**
   * \param The source energy capacity, in Joules.
   *
   * Sets the energy capacity of the source.
   * Note that if the energy capacity is not set, it is assumed to be equal to
   * the initial energy.
   */
  void SetEnergyCapacity (double energyCapacityJ);

  /**
   * \returns Supply voltage at the energy source.


private:
  double m_initialEnergyJ;                // initial energy, in Joules
  double m_energyCapacityJ;               // energy capacity, 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

(-)a/src/energy/model/rv-battery-model.cc (+7 lines)

Lines 115-120	Link Here

115

116

117

double

117

double

118

RvBatteryModel::GetEnergyCapacity (void) const

119

120

  NS_LOG_FUNCTION (this);

121

  return m_alpha * GetSupplyVoltage ();

122

123

124

double

118

RvBatteryModel::GetSupplyVoltage (void) const

125

RvBatteryModel::GetSupplyVoltage (void) const

119

126

120

  NS_LOG_FUNCTION (this);

127

  NS_LOG_FUNCTION (this);

(-)a/src/energy/model/rv-battery-model.h (+7 lines)

Lines 60-65	Link Here

   * Implements GetInitialEnergy.

   * Implements GetInitialEnergy.

*/

*/

  virtual double GetInitialEnergy (void) const;

  virtual double GetInitialEnergy (void) const;

/**

   * \return The source energy capacity, in Joules.

   * Implements GetEnergyCapacity.

*/

  virtual double GetEnergyCapacity (void) const;

/**

/**

   * \returns Supply voltage at the energy source.

   * \returns Supply voltage at the energy source.

Return to bug 2403