This page lists all types of electrical objects that can be used to build a network, including the structure of the XML elements.

General

Each XML element that describes an electrical object has the attribute "class". This attribute is used to determine the object type. Additionally, the attribute "observale" can be set to true. This causes current, voltage, dissipation power and (if applicable) soc to be calculated and added to the simulation output.

Basic types

Resistance

A resistance is added by setting the "class" attribute to OhmicResistance.

XML Tag	Unit	Type	Explanation
Object	Ohm	Object	Value of the resistance

Definition of a resistance with constant value:

<MyOhmicResistance class="OhmicResistance">
    <Object class="ConstObj">
        <Value>10</Value>
    </Object>
</MyOhmicResistance>

Capacity

A resistance is added by setting the "class" attribute to Capacity.

XML Tag	Unit	Type	Explanation
Object	Farad	Object	Value of the capacitor

Definition of a capacity with constant value:

<MyCapacity class="Capacity">
    <Object class="ConstObj">
        <Value>10</Value>
    </Object>
</MyCapacity>

Voltage Source

A voltage source is added by setting the "class" attribute to VoltageSource.

XML Tag	Unit	Type	Explanation
Object	V	Object	Value of the voltage source

Definition of a voltage source with constant value:

<MyVoltageSource class="VoltageSource">
    <Object class="ConstObj">
        <Value>10</Value>
    </Object>
</MyVoltageSource>

Parallel Connection

A parallel connection of elements is added by setting the "class" attribute to ParallelTwoPort.

XML Tag	Type	Default value	Explanation
Children	List of twoports		List of child elements that are connected in parallel
- Attribute count	int > 0	1	Number of times each child is added

Definition of a parallel connection of a capacitor and a resistor:

<RootElement class="ParallelTwoPort">
    <Children>
        <MyCapacity1 class="Capacity"> ... </MyCapacity>
        <MyCapacity2 class="Capacity"> ... </MyCapacity>
    </Children>
</RootElement>

Serial Connection

A serial connection of elements is added by setting the "class" attribute to SerialTwoPort.

XML Tag	Type	Default value	Explanation
Children	List of twoports		List of child elements that are connected in series
- Attribute count	int > 0	1	Number of times each child is added

Definition of a serial connection of a capacitor and a resistor:

<RootElement class="SerialTwoPort">
    <Children>
        <MyCapacity1 class="Capacity"> ... </MyCapacity>
        <MyCapacity2 class="Capacity"> ... </MyCapacity>
    </Children>
</RootElement>

More complex elements

Zarc Element

A zarc element is added by setting the "class" attribute to ZarcElement. It describes an element with an impedance value of

\[ \underline{Z}_{Zarc} = \frac{R}{1 + (j\omega\tau)^\phi} \]

XML Tag	Unit	Type	Explanation
LookupTau	s	Object	Value of tau
LookupOhmicResistance	Ohm	Object	Value of the resistance R
LookupPhi		Object	Value of phi

If zarc elements are used, the minimal sample rate should be set by using the option <SampleRate>:

<Options>
    <SampleRate> 100000000 </SampleRate>
</Options>

Definition of a zarc element:

<MyZarcElement class="ZarcElement">

    <LookupTau class="LookupObj2DWithState">
        <RowState cacheref="ThermalState"/>
        <ColState cacheref="Soc"/>
        <LookupData> ... </LookupData>
        <MeasurementPointsRow> ... </MeasurementPointsRow>
        <MeasurementPointsColumn> ... </MeasurementPointsColumn>
    </LookupTau>

    <LookupOhmicResistance class="LookupObj2DWithState">
        <RowState cacheref="ThermalState"/>
        <ColState cacheref="Soc"/>
        <LookupData> ... </LookupData>
        <MeasurementPointsRow> ... </MeasurementPointsRow>
        <MeasurementPointsColumn> ... </MeasurementPointsColumn>
    </LookupOhmicResistance>

    <LookupPhi class="LookupObj2DWithState">
        <RowState cacheref="ThermalState"/>
        <ColState cacheref="Soc"/>
        <LookupData> ... </LookupData>
        <MeasurementPointsRow> ... </MeasurementPointsRow>
        <MeasurementPointsColumn> ... </MeasurementPointsColumn>
    </LookupPhi>

</MyZarcElement>

Diffusion - Cotanh

A warburg element with reflective boundary is added by setting the "class" attribute to WarburgCotanh.

XML Tag	Type	Default value	Explanation
Attribute WithCapacity	bool	true	If set to false, no additional capacity is added to the ECM and the capacity can be modeled with a voltage source
Attribute RCCounter	int > 0	5	Number of RC elements to be added
Sigma	Object		Value of sigma
Clim	Object		Value of the limiting capacity

If cotanh elements are used, the minimal sample rate should be set by using the option <SampleRate>:

<Options>
    <SampleRate> 100000000 </SampleRate>
</Options>

Definition of a Warburg-Cotanh:

<MyWarburgCotanh1 class = "WarburgCotanh" RCCounter = "10" WithCapacity="True">
    <Sigma class="LookupObj2dWithState">
            <RowState cacheref="Soc"/>
            <ColState cacheref="ThermalState"/>
            <LookupData>
                ...
            </LookupData>
            <MeasurementPointsRow desc="StateOfCharge">
                ...
            </MeasurementPointsRow>
            <MeasurementPointsColumn desc="ThermalState">
                ...
            </MeasurementPointsColumn>
    </Sigma>
    <Clim class="LookupObj2dWithState">
            <RowState cacheref="Soc"/>
            <ColState cacheref="ThermalState"/>
            <LookupData>
                ...
            </LookupData>
            <MeasurementPointsRow desc="StateOfCharge">
                ...
            </MeasurementPointsRow>
            <MeasurementPointsColumn desc="ThermalState">
                ...
            </MeasurementPointsColumn>
    </Clim>
</MyWarburgCotanh1>

Diffusion - Tanh

A warburg element with transmissive boundary is added by setting the "class" attribute to WarburgTanh.

XML Tag	Unit	Type	Default value	Explanation
Attribute RCCounter		int > 0	5	Number of RC elements to be added
OhmicResistance	Ohm	Object		Value of sigma
Tau	s	Object		Value of tau

If tanh elements are used, the minimal sample rate should be set by using the option <SampleRate>:

<Options>
    <SampleRate> 100000000 </SampleRate>
</Options>

Definition of a Warburg-Tanh:

<MyWarburgTanh class = "WarburgTanh">
        <OhmicResistance class="LookupObj2dWithState">
                <RowState cacheref="Soc"/>
                <ColState cacheref="ThermalState"/>
                <LookupData>
                    ...
                </LookupData>
                <MeasurementPointsRow desc="StateOfCharge">
                    ...
                </MeasurementPointsRow>
                <MeasurementPointsColumn desc="ThermalState">
                    ...
                </MeasurementPointsColumn>
        </OhmicResistance>
        <Tau class="LookupObj2dWithState">
                <RowState cacheref="Soc"/>
                <ColState cacheref="ThermalState"/>
                <LookupData>
                    ...
                </LookupData>
                <MeasurementPointsRow desc="StateOfCharge">
                    ...
                </MeasurementPointsRow>
                <MeasurementPointsColumn desc="ThermalState">
                    ...
                </MeasurementPointsColumn>
        </Tau>
</MyWarburgTanh>

Battery

This element represents a battery cell and is added by setting the "class" attribute to CellElement.

XML Tag	Unit	Type	Default value	Explanation
ThermalState		State object of class "ThermalState"		Thermal state of the cell, should be cached and used as parameter for lookup tables
Soc		State object of class "Soc"		Soc of the cell, should be cached and used as parameter for lookup tables
Children		List of twoports		List of child elements that are connected in series
ReversibleHeat	W / (K * A)	Object	no reversible heat generation	Reversible heat generated by the cell

Definition of an example battery in full cell configuration:

<MyCellElement class="CellElement">

    <ThermalState class="ThermalState" cache="True">
        <InitialTemperature> ... </InitialTemperature>
    </ThermalState>

    <Soc class="Soc" cache="True">
        <InitialCapacity> ... </InitialCapacity>
        <InitialSoc> ... </InitialSoc>
        <MeasurementPoints> ... </MeasurementPoints>
    </Soc>

    <Children>
        <OhmicResistance ref="MyOhmicResistance"/>
        <VoltageSource ref="MyVoltageSource"/>
        <ZarcElement1 ref="MyZarcElement"/>
    </Children>

</MyCellElement>

Definition of an example battery in half cell configuration (see halfcell simulation):

<MyCellElement class="CellElement">

    <ThermalState class="ThermalState" cache="True">
        <InitialTemperature> ... </InitialTemperature>
    </ThermalState>

    <Soc class="Soc" cache="True">
        <InitialCapacity> ... </InitialCapacity>
        <InitialSoc> ... </InitialSoc>
        <MeasurementPoints> ... </MeasurementPoints>
    </Soc>

    <Anode>
        <AnodeElement1 class="AnodeElement">
            <Children>...</Children>
        </AnodeElement1>
    </Anode>

    <Cathode>
        <CathodeElement1 class="CathodeElement">
            <Children>...</Children>
        </CathodeElement1>
    </Cathode>

    <Other>
        ...
    </Other>

</MyCellElement>

Anode particle

This element represents an anode particle in a halfcell simulation and is added by setting the "class" attribute to AnodeElement.

XML Tag	Type	Default value	Explanation
Children	List of twoports		List of child elements that are connected in series
Soc	State object of class "Soc"	Soc of the parent cell, see below	Soc of the anode element, should be cached and used as parameter for lookup tables

If no soc is given, the capacity of the anode element will be equal to the capacity of the parent cell divided by the number of anode elements and the initial soc will be the same as that of the parent cell. The children of this element must not be additional serial or parallel connections, only electrical elements are allowed. The values of voltage sources will be inverted, so that the cell OCV is the difference between the cathode and anode OCVs.

Cathode particle

This element represents a cathode particle in a halfcell simulation and is added by setting the "class" attribute to CathodeElement.

XML Tag	Type	Default value	Explanation
Children	List of twoports		List of child elements that are connected in series
Soc	State object of class "Soc"	Soc of the parent cell, see below	Soc of the anode element, should be cached and used as parameter for lookup tables

If no soc is given, the capacity of the cathode element will be equal to the capacity of the parent cell divided by the number of cathode elements and the initial soc will be the same as that of the parent cell. The children of this element must not be additional serial or parallel connections, only electrical elements are allowed.