Module (Generated Block)
Description
The Module block represents a custom generated system model of a battery module. You can
create this Simscape™ block by using the buildBattery
function with a Module object as
an input argument. The Module generated block is inside the Simulink library that you specify
in the LibraryName argument of the buildBattery
function.
Note
To allow for structural changes and further customization, when you add the Module (Generated Block) masked library block from the parent library to a Simulink® model, the linked block does not contain the link or path to the parent library block. If you modify any of the battery structural properties, such as NumSeriesAssemblies or NumParallelCells, you must rebuild the original parent library and copy the block in your model again.
For more information about parent and linked blocks, see Linked Blocks.
Variables
To set the priority and initial target values for the block variables prior to simulation, use the Initial Targets section in the block dialog box or Property Inspector. For more information, see Set Priority and Initial Target for Block Variables.
For a detailed list of the variables in the ParallelAssembly block, see the Initial Targets (Variables) section.
Note
The values of variables for cell-level components refer to the value of a single physical cell and not that of a cell model. (since R2023a)
For example, consider a parallel assembly with 10 cells in parallel and a lumped model resolution. The ParallelAssembly generated block exposes the variable v of the cell component as vCell. For a cell with a voltage of 4.2 V, vCell is equal to 4.2 V. Before R2023a, the generated blocks exposed the cell variables with the suffix CellModel and represented the variables of the entire model they represented. For example, using the previous ParallelAssembly generated block, the block exposed a vCellModel variable with a value equal to 4.2*10 = 42V.
Nominal values provide a way to specify the expected magnitude of a variable in a model. Using system scaling based on nominal values increases the simulation robustness. Nominal values can come from different sources, one of which is the Nominal Values section in the block dialog box or Property Inspector. For more information, see System Scaling by Nominal Values.
Examples
Build Simple Model of Battery Module in MATLAB and Simscape
Create and build a Simscape system model of a battery module with Simscape Battery™.
Build Simple Model of Battery Pack in MATLAB and Simscape
Create and build a Simscape system model of a battery pack with Simscape Battery.
Apply Parameter Variation to Cells in Module
Specify a parameter variation between the individual cell models in a battery block that you generate using Simscape™ Battery™ objects and functions. When you need a high-fidelity model of a battery, to achieve high accuracy, you must consider the deviations between individual cells. This deviation can be random, for example, due to manufacturing tolerances, or specific to individual cells, for example, if the state of health (SOH) varies between cells. The battery blocks that you generate with Simscape Battery support the specification of a variation in the parameters at different design levels.
Ports
Input
Output
Conserving
Parameters
Note
The names of these parameters and variables depend on the block you have specified in
the CellModelOptions property of the underlying Cell
object that constitutes this module.
The names of the parameters and variables in this page refer to a Cell
object with the Battery
(Table-Based) block as the cell component model block. If you specify a
custom block for the cell component model, the names of the parameters and variables might
differ.
The parameters of this block need to be set for the cell-level and depend on how you
define the Module object that
you use to generate this custom model. The block parameters are divided into these sections:
Main
Dynamics
Fade
Calendar Aging
Thermal
Cell Balancing
The visibility of each section also depends on the generated Module
object.
For a list of the parameters in the Main, Dynamics, Fade, and Calendar Aging sections, see the documentation page of the Battery (Table-Based) block.
If, in the Module object that
you use to generate this custom model, you set the CellParameterDeviation
property to "PercentDeviation", each cell parameter (that is not an
enumeration or a boolean) has an associated Percent deviation
parameter:
Percent deviation for k — Percent deviation for specific cell parameter
vector of scalars | matrix
Since R2023b
Percent deviation of the value of the corresponding cell parameter k for each cell model in the battery. k is the name of the cell parameter associated with this percent deviation.
The number of parameters of this type is equal to the number of cell parameters in this block. Parameters of type enumeration and boolean do not have an associated Percent deviation parameter.
The value of the corresponding cell parameter with the deviation applied is equal to:
For this parameter, you can specify either:
A vector, with one element for each cell model in the battery. These elements are concatenated vertically. For example, for a
Moduleobject with two parallel assemblies, three cells, and theModelResolutionproperty set to"Detailed", this vector requires six elements. For aModuleobject with theModelResolutionproperty set to"Grouped", the size of this vector depends on the number of cells modeled in the module. The number of modeled cells is equal to the sum of the elements of theParallel grouping simulation strategyproperty. You can find this property in the Description tab of the Property Inspector of the Module block.
A matrix, where each element of the matrix is either a scalar or a matrix of the same size of the underlying associated cell parameter. The parameter deviation elements are concatenated vertically. For example, if a cell parameter has a size of
[2,7]and a detailed parallel assembly comprises two cells, then the size of the Percent Deviation for this parameter is equal to[4,7].
For more information about cell-to-cell parameter variation, see the Apply Temperature-Dependent Cell Parameter Variation in Battery Module example.
Dependencies
To enable this parameter, set the CellParameterDeviation
property of the Module object to
"PercentDeviation".
Thermal
Thermal mass — Thermal mass at cell level
100
J/K (default) | positive scalar
Thermal inertia of a single battery cell. This value represents the energy required to raise the temperature of the thermal port by one degree.
The Module block automatically scales this value up to the system level.
Cell level coolant thermal path resistance — Coolant thermal path resistance at cell level
1.2
K/W (default) | positive scalar | row vector of positive scalars
Resistance of the coolant thermal path at cell level. The size of this parameter is equal to the total number of electrical models in the system.
Dependencies
To enable this parameter, set the CoolantThermalPath
property of the Module object to
"CellBasedThermalResistance". Alternatively, set the
CoolantThermalPath property to
"CellBasedThermalResistance" inside the parent object
of which the Module object is a subcomponent.
Cell level ambient thermal path resistance — Ambient thermal path resistance at cell level
25
K/W (default) | positive scalar | row vector of positive scalars
Resistance of the ambient thermal path at cell level. The size of this parameter is equal to the total number of electrical models in the system.
Dependencies
To enable this parameter, set the CoolantThermalPath
property of the Module object to
"CellBasedThermalResistance". Alternatively, set the
CoolantThermalPath property to
"CellBasedThermalResistance" inside the parent object
of which the Module object is a subcomponent.
Inter-cell thermal path resistance — Thermal path resistance between cells
1
K/W (default) | scalar | row vector of scalars
Since R2023a
Resistance of the thermal path between the cells inside the module. The size of this parameter must be equal to the number of inter-cell thermal connections that this block models.
Dependencies
To enable this parameter, set the InterCellThermalPath
property of the Module object to "On".
Alternatively, set the InterCellThermalPath property to
"On" inside the parent object of which the
Module object is a subcomponent.
Inter-parallel assembly thermal path resistance — Thermal path resistance between parallel assemblies
1
K/W (default) | scalar | row vector of scalars
Since R2023a
Resistance of the thermal path between the parallel assemblies inside the module. The size of this parameter must be equal to the number of inter-parallel assembly thermal connections that this block models.
Dependencies
To enable this parameter, set the InterCellThermalPath
property of the Module object to "On".
Alternatively, set the InterCellThermalPath property to
"On" inside the parent object of which the
Module object is a subcomponent.
Inter-cell radiation heat transfer area — Transfer area of radiation heat between cells
1e-3
m^2 (default) | scalar | row vector of scalars
Since R2023a
Area of the radiation heat transfer between the cells inside the module. The size of this parameter must be equal to the number of inter-cell thermal connections that this block models.
Dependencies
To enable this parameter, set the
InterCellRadiativeThermalPath property of the
Module object to "On". Alternatively,
set the InterCellRadiativeThermalPath property to
"On" inside the parent object of which the
Module object is a subcomponent.
Inter-cell radiation heat transfer coefficient — Coefficient of radiation heat transfer between cells
1e-6
W/(K^4*m^2) (default) | scalar | row vector of scalars
Since R2023a
Coefficient of the radiation heat transfer between the cells inside the module. The size of this parameter must be equal to the number of inter-cell thermal connections that this block models.
Dependencies
To enable this parameter, set the
InterCellRadiativeThermalPath property of the
Module object to "On". Alternatively,
set the InterCellRadiativeThermalPath property to
"On" inside the parent object of which the
Module object is a subcomponent.
Inter-parallel assembly area for radiation heat transfer — Area of radiation heat transfer between parallel assemblies
1e-3
m^2 (default) | scalar | row vector of scalars
Since R2023a
Area of the radiation heat transfer between the parallel assemblies inside the module. The size of this parameter must be equal to the number of inter-parallel assemblies thermal connections that this block models.
Dependencies
To enable this parameter, set the
InterCellRadiativeThermalPath property of the
Module object to "On". Alternatively,
set the InterCellRadiativeThermalPath property to
"On" inside the parent object of which the
Module object is a subcomponent.
Inter-parallel assembly coefficient for radiation heat transfer — Coefficient of radiation heat transfer between parallel assemblies
1e-6
W/(K^4*m^2) (default) | scalar | row vector of scalars
Since R2023a
Coefficient of the radiation heat transfer between the parallel assemblies inside the module. The size of this parameter must be equal to the number of inter-parallel assemblies thermal connections that this block models.
Dependencies
To enable this parameter, set the
InterCellRadiativeThermalPath property of the
Module object to "On". Alternatively,
set the InterCellRadiativeThermalPath property to
"On" inside the parent object of which the
Module object is a subcomponent.
Cell-level thermal path resistance at Xmin boundary — Thermal path resistance of cells at Xmin boundary
25
K/W (default) | positive scalar | row vector of positive scalars
Since R2024a
Resistance of the thermal path at the cell level at the minimum X-axis boundary. The size of this parameter is equal to the total number of Xmin thermal connections that the block models.
Dependencies
To enable this port, set the XminThermalNodes property of
the Module object to "Scalar" or
"Vectorized".
Cell-level thermal path resistance at Xmax boundary — Thermal path resistance of cells at Xmax boundary
25
K/W (default) | positive scalar | row vector of positive scalars
Since R2024a
Resistance of the thermal path at the cell level at the maximum X-axis boundary. The size of this parameter is equal to the total number of Xmax thermal connections that the block models.
Dependencies
To enable this port, set the XmaxThermalNodes property of
the Module object to "Scalar" or
"Vectorized".
Cell-level thermal path resistance at Ymin boundary — Thermal path resistance of cells at Ymin boundary
25
K/W (default) | positive scalar | row vector of positive scalars
Since R2024a
Resistance of the thermal path at the cell level at the minimum Y-axis boundary. The size of this parameter is equal to the total number of Ymin thermal connections that the block models.
Dependencies
To enable this port, set the YminThermalNodes property of
the Module object to "Scalar" or
"Vectorized".
Cell-level thermal path resistance at Ymax boundary — Thermal path resistance of cells at Ymax boundary
25
K/W (default) | positive scalar | row vector of positive scalars
Since R2024a
Resistance of the thermal path at the cell level at the maximum Y-axis boundary. The size of this parameter is equal to the total number of Ymax thermal connections that the block models.
Dependencies
To enable this port, set the YmaxThermalNodes property of
the Module object to "Scalar" or
"Vectorized".
Cell-level thermal path resistance at serpentine boundary — Thermal path resistance of cells at serpentine boundary
25
K/W (default) | positive scalar | row vector of positive scalars
Since R2024a
Resistance of the thermal path at the cell level at the serpentine boundary. The size of this parameter is equal to the total number of serpentine thermal connections that the block models.
Dependencies
To enable this port, set the SerpentineCoolingPlate
property of the Module object to
"SingleSidedAlongStackingAxis" or
"DoubleSidedAlongStackingAxis".
Parallel Assembly
Non-cell electrical resistance — Parallel assembly non-cell resistance
1 / 1000
Ohm (default) | positive scalar
Non-cell electrical resistance of each parallel assembly in the module.
Dependencies
To enable this parameter, set the NonCellResistance
property of the Module object to "On".
Alternatively, set the NonCellResistance property to
"On" inside the parent object of which the
Module object is a subcomponent.
Module
Non-cell electrical resistance — Module non-cell resistance
1 / 1000
Ohm (default) | positive scalar
Non-cell electrical resistance of the module.
Dependencies
To enable this parameter, set the NonCellResistance
property of the Module object to "On".
Alternatively, set the NonCellResistance property to
"On" inside the parent object of which the
Module object is a subcomponent.
Cell Balancing
Cell balancing switch closed resistance — Closed resistance of cell balancing switch
0.01
Ohm (default) | positive scalar
Closed resistance of the cell balancing switch.
Cell balancing switch open conductance — Open conductance of cell balancing switch
1e-8
1/Ohm (default) | positive scalar
Open conductance of the cell balancing switch.
Cell balancing switch operation threshold — Threshold for cell balancing switch operation
0.5 (default) | positive scalar
Threshold to activate the cell balancing switch operation.
Cell balancing shunt resistance — Resistance of cell balancing shunt
50
Ohm (default) | positive scalar
Resistance of the cell balancing shunt.
Initial Targets (Variables)
The size of these variables is equal to the total number of electrical models in the
system. For example, in a Module block with 2 parallel assemblies and 2 series cells, the
size of the variables depends on the ModelResolution property of the
Module object and is equal to 4 for
Detailed, 1 for
Lumped, or 3 when the
SeriesGrouping property is equal to [1 1] and the
ParallelGrouping property is equal to [1
2].
Cell current (positive in) — Cell-level current, iCell
0
A (default) | scalar | vector
Current at the cell level. The size of this variable is equal to the total number of electrical models in the system.
Cell terminal voltage — Cell-level voltages, vCell
0
V (default) | scalar | vector
Voltages at the cell level. The size of this signal is equal to the total number of electrical models in the system.
Cell state of charge — Cell-level state of charge, socCell
1 (default) | scalar | vector
State of charge at cell level. The value of this variable typically varies between 0 and 1. The size of this signal is equal to the total number of electrical models in the system.
Cell discharge cycles — Cell-level number of cycles, numCyclesCell
0 (default) | scalar | vector
Cell-level number of cycles related to battery aging. The size of this signal is equal to the total number of electrical models in the system.
Cell temperature — Cell-level temperature, temperatureCell
298.15
K (default) | positive scalar
Temperature at the cell level. The size of this signal is equal to the total number of electrical models in the system.
Parallel Assembly Voltage — Parallel assembly-level voltages, vParallelAssembly
repmat(0,4,1)
V (default) | scalar | vector
Voltages at the parallel assembly level. The size of this signal is equal to the total number of parallel assemblies in the module.
Parallel Assembly state of charge — State of charge at parallel assembly level, socParallelAssembly
repmat(1,4,1) (default) | scalar | vector
State of charge at the parallel assembly level. The size of this signal is equal to the total number of parallel assemblies in the module.
Version History
Introduced in R2022bSee Also
Apps
Simscape Blocks
- Array of Thermal Nodes Connector | ParallelAssembly (Generated Block) | ModuleAssembly (Generated Block) | Pack (Generated Block)
Objects
Functions
You can also select a web site from the following list
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)
Asia Pacific
- Australia (English)
- India (English)
- New Zealand (English)
- 中国
- 日本Japanese (日本語)
- 한국Korean (한국어)