simulation package¶
Submodules¶
Alterations¶
Circuits¶
-
simulation.circuits.cir_RC_parallel(angular_freq, **circuit_elements)¶ Function that simulates the impedance response of a resistor and a capacitor in a parallel configuration. String representation for this circuit: -(RC)-
- angular_freq : array-like
- Angular frequency [1/s]
**circuit_elements : dictionary or keyword arguments
- resistance : single value (int or float)
- Solution resistance [ohm]
- capacitance : single value (int or float)
- Capacitance of an electrode surface [F]
- Z_complex : array-like
- impedance response of the circuit under investigation [ohm]
-
simulation.circuits.cir_RC_series(angular_freq, **circuit_elements)¶ Function that simulates the impedance response of a resistor and a capacitor in a series configuration. This circuit configuration is used to simulate the response of an ideally polarizable electrode, also known as a blocking electrode. String representation for this circuit: -R-C-
Parameters: - angular_freq (array-like) – Angular frequency [1/s]
- **circuit_elements (dictionary or keyword arguments) –
- resistance : single value (int or float)
- Solution resistance [ohm]
- capacitance : single value (int or float)
- Capacitance of an electrode surface [F]
Returns: Z_complex – impedance response of the circuit under investigation [ohm]
Return type: array-like
-
simulation.circuits.cir_RQ_parallel(angular_freq, **circuit_elements)¶ Function that simulates the impedance response of a resistor and a constant phase element in a parallel configuration. String representation for this circuit: -(RQ)-
- angular_freq : array-like
- Angular frequency [1/s]
**circuit_elements : dictionary or keyword arguments
- resistance : single value (int or float)
- Solution resistance [Ohm]
- constant_phase_element : single value (int or float)
- Constant phase angle [s^(alpha-1)/ohm]
- alpha : single value -float
- Exponent of the constant phase element. Should be a value between 0 and 1 [-]
- Z_complex : array-like
- impedance response of the circuit under investigation [Ohm]
-
simulation.circuits.cir_RQ_series(angular_freq, **circuit_elements)¶ Function that simulates the impedance response of a resistor and a constant phase element in a series configuration. This circuit configuration is used to simulate the response of a blocking electrode with distribution of reactivity. String representation for this circuit: -R-Q-
Parameters: - angular_freq (array-like) – Angular frequency [1/s]
- **circuit_elements (dictionary or keyword arguments) –
- resistance : single value (int or float)
- Solution resistance [ohm]
- constant_phase_element : single value (int or float)
- Constant phase angle [s^(alpha-1)/ohm]
- alpha : single value -float
- Exponent of the constant phase element. Should be a value between 0 and 1 [-]
Returns: Z_complex – impedance response of the circuit under investigation [Oom]
Return type: array-like
-
simulation.circuits.cir_Randles_simplified(angular_freq, **circuit_elements)¶ Return the impedance of a Randles circuit with a simplified Warburg element This form of the Randles circuit is only meant for to simulate semi-infinate linear diffusion String representation for this circuit: -Rs-(Q-(RW)-)-
Parameters: - angular_freq (array-like) – Angular frequency [1/s]
- **circuit_elements (dictionary or keyword arguments) –
- solution_resistance : single value (int or float)
- Solution resistance [ohm]
- parallel_resistance : single value (int or float)
- resistance of the element in parallel with the capacitor [ohm]
- constant_phase_element : single value (int or float)
- Constant phase angle [s^(alpha-1)/ohm]
- alpha : single value (float)
- Exponent of the constant phase element. Should be a value between 0 and 1 [-]
sigma: single value (float)
Returns: Z_complex – impedance response of the circuit under investigation [Ohm]
Return type: array-like
-
simulation.circuits.cir_RsRC(angular_freq, **circuit_elements)¶ ‘ Function that simulates the impedance response of a solution resistor in series with a resistor in parallel with a capacitor. String representation for this circuit: -Rs-(RC)-
Parameters: - angular_freq (array-like) – Angular frequency [1/s]
- **circuit_elements (dictionary or keyword arguments) –
- solution_resistance : single value (int or float)
- Solution resistance [ohm]
- parallel_resistance : single value (int or float)
- resistance of the element in parallel with the capacitor [ohm]
- capacitance : single value (int or float)
- Capacitance of an electrode surface [F]
Returns: Z_complex – impedance response of the circuit under investigation [Ohm]
Return type: array-like
-
simulation.circuits.cir_RsRCRC(angular_freq, **circuit_elements)¶ Function that simulates the impedance response of a solution resistor in series with two sets of a resistor in parallel with a capacitor. String representation for this circuit: -Rs-(RC)-(RC)-
Parameters: - angular_freq (array-like) – Angular frequency [1/s]
- **circuit_elements (dictionary or keyword arguments) –
- solution_resistance : single value (int or float)
- Solution resistance [ohm]
- parallel_resistance_1 : single value (int or float)
- first combination of resistor in parallel with capacitor [ohm]
- capacitance_1 : single value (int or float)
- Capacitance of an electrode surface whichi is part of
- the first combination of RC in parallel [F]
- parallel_resistance_2 : single value (int or float)
- second combination of resistor in parallel with capacitor [ohm]
- capacitance_2 : single value (int or float)
- Capacitance of an electrode surface whichi is part of the second combination of RC in parallel [F]
Returns: Z_complex – impedance response of the circuit under investigation [Ohm]
Return type: array-like
-
simulation.circuits.cir_RsRQ(angular_freq, **circuit_elements)¶ ‘ Function that simulates the impedance response of a solution resistor in series with a resistor in parallel with a constant phase element.
String representation for this circuit: -Rs-(RQ)-
Parameters: - angular_freq (array-like) – Angular frequency [1/s]
- **circuit_elements (dictionary or keyword arguments) –
- solution_resistance : single value (int or float)
- Solution resistance [ohm]
- parallel_resistance : single value (int or float)
- resistance of the element in parallel with the capacitor [ohm]
- constant_phase_element : single value (int or float)
- Constant phase angle [s^(alpha-1)/ohm]
- alpha : single value -float
- Exponent of the constant phase element. Should be a value between 0 and 1 [-]
Returns: Z_complex – impedance response of the circuit under investigation [Ohm]
Return type: array-like
-
simulation.circuits.cir_RsRQRQ(angular_freq, **circuit_elements)¶ Function that simulates the impedance response of a solution resistor in series with two sets of a resistor in parallel with a constant phase elements. String representation for this circuit: -Rs-(RQ)-(RQ)-
- angular_freq : array-like
- Angular frequency [1/s]
**circuit_elements : dictionary or keyword arguments
- solution_resistance : single value (int or float)
- Solution resistance [ohm]
- parallel_resistance_1 : single value (int or float)
- first combination of resistor in parallel with constant phase element [ohm]
- constant_phase_element_1 : single value (int or float)
- First constant phas angle [s^(alpha-1)/ohm]
- alpha_1 : single value -float
- Exponent of the first constant phase element. Should be a value between 0 and 1 [-]
- parallel_resistance_2 : single value (int or float)
- Second combination of resistor in parallel with constant phase element [ohm]
- constant_phase_element_2 : single value (int or float)
- Second Constant phase angle [s^(alpha-1)/ohm]
- alpha_2 : single value -float
- Exponent of the second constant phase element. Should be a value between 0 and 1 [-]
- Z_complex : array-like
- impedance response of the circuit under investigation [Ohm]
-
simulation.circuits.freq_gen(high_freq, low_freq, decades=10)¶ Function that generates the frequency range used to investigate the impedance response of an electrical circuit Frequency Generator with logspaced freqencies
Parameters: - high_freq (single value (int or float)) – initial frequency value (high frequency domain) [Hz]
- high_freq – final frequency value (low frequency domain) [Hz]
- decades (integer) – number of frequency decades to be used as range. Default value is set to be 10 [-]
Returns: - [0] = frequency range [Hz]
- [1] = Angular frequency range [1/s]