eisgenerator 2.1.x
Model Format

The model format of eisgenerator encodes any series/ parallel combination of implemented impedances.

Currently eisgenerator implements the following elements. omega is the angular frequency in rad/s and j the imaginary unit.

char element parameters impedance Z(omega)
r resistor R resistance, Ohm R
c capacitor C capacitance, F 1 / (j omega C)
l inductor L inductance, H j omega L
w Warburg (semi-infinite linear diffusion) A coefficient, Ohm s^-1/2 A (1 - j) / sqrt(omega)
p constant phase element Q admittance coefficient, S s^a
alpha exponent
1 / (Q (j omega)^alpha)
t transmission line, closed (insulating) end R Ohm m^-1
Q S s^a m^-1
alpha exponent
l length
Z0 tanh(gamma l)
o transmission line, open (reflecting) end R Ohm m^-1
Q S s^a m^-1
alpha exponent
l length
Z0 / tanh(gamma l)

For the two transmission lines the characteristic impedance and propagation constant are

Z0    = sqrt( R / (Q (j omega)^alpha) )
gamma = sqrt( (j omega)^alpha R Q )

Element identifiers are case insensitive. Each element's own class documentation repeats its formula together with its limits and caveats.

Conventions

These are the choices that differ between EIS tools, so check them before moving a fit from one program to another:

  • Angular frequency. Every element takes omega in rad/s. The CLI --hz flag converts a temporal frequency range for you; the library does not.
  • Sign of the imaginary part. The e^(+j omega t) convention is used, so a capacitor has Im(Z) = -1/(omega C), negative. Spectra are written as omega, Re(Z), Im(Z) with the sign as computed. Boukamp's convention plots -Im(Z), which flips the plot across the real axis but not the numbers.
  • Ideal elements. c, l and r have exactly zero real, imaginary or frequency dependent parts respectively. There is no lossy capacitor: a depressed semicircle needs a p, and a series resistance needs an explicit r.
  • Warburg coefficient. A is the sigma of the common Z = sigma omega^-1/2 (1 - j) form. Tools that absorb the (1 - j) or use 2 sigma disagree with A by a factor of sqrt(2) or 2.
  • Parallel is the implicit operator. See Combinations below.

Exact identities between elements

p is the general element and the others are special cases of it, so substituting an exponent converts one into another exactly, not approximately:

p{Q,alpha} is equivalent to condition conversion
c{C} alpha = 1 C = Q
w{A} alpha = 0.5 A = 1 / (Q sqrt(2))
r{R} alpha = 0 R = 1 / Q
l{L} alpha = -1 L = 1 / Q

Because of these, a model's parameters are often not uniquely determined by its spectrum. eis::Model::getEquivalentParameterPermutations() enumerates the assignments that give an identical spectrum, using these identities plus the commutativity of series and parallel.

Combinations

Combinations of these elements are achieved by writing them against each other for a parallel combination, or with a '-' in between for serial combinations:

"r-c" is thus a serial combination of a resistor and a capacitance:

r-c

While "cr" is a parallel combination of a resistor and a capacitance:

rc

While "r-cr" is a parallel combination of a resistor and a capacitance in series with another resistance, not that the implicit parallel operator has operator precedence:

r-cr

Brackets '(' and ')' are also supported and modify the order of operations as one would expect. Thus "(r-c)r" is a series combination of a resistor and a capacitance in parallel with another resistance:

(r-c)r

Parameters

To pass circuit element parameters to eisgenerator a format embedded into the strings is preferred. Parameters are passed by adding them in braces behind the element thus "r{100}-c{3e-6}r{1e4}" is a 100 Ohm resistor in series with a 3 microfarad capacitance that is in parallel with a 3 kOhm resistance.

When an element takes multiple parameters, those are separated by a ',' like so: r{5e4}p{1e-5, 0.8}

Ranges are also supported, here ~ is used as a separator between the start and the end of a range, thus r{1~1e3} is a resistor with a value in a linear range between 1 and 1000 Ohms. By adding a trailing 'L' the range can be marked as distributed logarithmic in base 10, thus r{1~1e3L} is such a logarithmic range.

Ranges are used to make eisgenerator generate spectra for all combinations of parameters in the range(s) of the circuit elements.

Translators

For interoperability with other software, translators to and from eisgenerator model generators are available see Translators