slide::State_ECM< N_RC > Struct Template Reference

State_ECM template class for holding the states of the ECM model. More...

#include <State_ECM.hpp>

Inheritance diagram for slide::State_ECM< N_RC >:

Collaboration diagram for slide::State_ECM< N_RC >:

Public Types
enum	Index : size_t {   i_T , i_SOC , i_I , i_Ir ,   N_states }
	Enumeration of indices for state variables. More...
Public Types inherited from slide::State< N, N_cumulative >
enum	Index : size_t { i_time = N , i_Ah , i_Wh , N_states }

Public Member Functions
auto	I () const
	Get the current value (const method). More...
auto &	I ()
	Get the current value (non-const method). More...
auto &	Ir (size_t i=0)
	Get the current through the parallel resistance (non-const method). More...
auto &	SOC ()
	Get the state of charge value (non-const method). More...
auto &	T ()
	Get the temperature value (non-const method). More...
Public Member Functions inherited from slide::State< N, N_cumulative >
auto	time () const
	time [s] More...
auto	Ah () const
	Current throughput [Ah]. More...
auto	Wh () const
	Energy throughput [Wh]. More...
auto &	time ()
	time [s] More...
auto &	Ah ()
	Current throughput [Ah]. More...
auto &	Wh ()
	Energy throughput [Wh]. More...
auto	reset ()

Additional Inherited Members
Static Public Member Functions inherited from slide::State< N, N_cumulative >
static constexpr auto	description (size_t i)

Detailed Description

template<size_t N_RC = 1>
struct slide::State_ECM< N_RC >

State_ECM template class for holding the states of the ECM model.

Template Parameters

N_RC	Number of parallel resistance-capacitance elements (default: 1).

Member Enumeration Documentation

Index

template<size_t N_RC = 1>

enum slide::State_ECM::Index : size_t

Enumeration of indices for state variables.

Enumerator
i_T	Cell temperature [K].
i_SOC	State of charge [0-1].
i_I	Current, [A], + for discharge, - for charge.
i_Ir	Current through the parallel resistance, [I].
N_states	Total number of states (not recommended for usage, use .size() instead).

Member Function Documentation

I() [1/2]

template<size_t N_RC = 1>

auto & slide::State_ECM< N_RC >::I ( )

inline

Get the current value (non-const method).

Returns

The current value [A], + for discharge, - for charge.

I() [2/2]

template<size_t N_RC = 1>

auto slide::State_ECM< N_RC >::I ( ) const

inline

Get the current value (const method).

Returns

The current value [A], + for discharge, - for charge. Current, [A], + for discharge, - for charge

Ir()

template<size_t N_RC = 1>

auto & slide::State_ECM< N_RC >::Ir ( size_t  i = 0 )

inline

Get the current through the parallel resistance (non-const method).

Parameters

i	Index of the parallel resistance (default: 0).

Returns

The current through the parallel resistance [I].

SOC()

template<size_t N_RC = 1>

auto & slide::State_ECM< N_RC >::SOC ( )

inline

Get the state of charge value (non-const method).

Returns

The state of charge value [0-1].

T()

template<size_t N_RC = 1>

auto & slide::State_ECM< N_RC >::T ( )

inline

Get the temperature value (non-const method).

Returns

The temperature value [K].

---

The documentation for this struct was generated from the following file:

• src/cells/Cell_ECM/State_ECM.hpp