Main Content

CellModelBlock

Set of conditional parameters for Cell object

Description

Use CellModelBlock to construct the CellModelOptions property of a Cell object. This property contains the conditional parameters of the block that you specify in the CellModelBlockPath property.

Creation

Description

example

import simscape.battery.builder.*; cellModelOpt = CellModelBlock sets default model options for the Cell object. To modify these options for your application, use dot notation.

Properties

expand all

Library path to a Simscape battery cell block, specified as a string. This object only supports the Battery (Table-Based) block.

Example: cellModelOpt.CellModelBlockPath = "batt_lib/Cells/Battery(Table-Based)"

Conditional compile-time parameters of the cell block that you specify in the CellModelBlockPath property.

Note

This property does not include the run-time parameters of the specified cell block.

These are the conditional parameters for the default Battery (Table-Based) block:

  • T_dependence — Temperature-dependent tables

  • thermal_port — Thermal port

  • prm_age_OCV — Storage condition

  • prm_age_capacity — Capacity calendar aging

  • prm_age_resistance — Internal resistance calendar aging

  • prm_age_modeling — Modeling option

  • prm_dyn — Charge dynamics

  • prm_dir — Current directionality

  • prm_fade — Fade characteristic

  • prm_leak — Self-discharge

Example: cellModelOpt.BlockParameters.thermal_port = "model"

Examples

collapse all

Create a default CellModelBlock option set.

cellModelOpt = CellModelBlock
  CellModelBlock with properties:

    CellModelBlockPath: "batt_lib/Cells/Battery↵(Table-Based)"
       BlockParameters: [1×1 struct]

Show the BlockParameters property.

cellModelOpt.BlockParameters
    struct with fields:

          T_dependence: no
          thermal_port: omit
           prm_age_OCV: OCV
      prm_age_capacity: disabled
    prm_age_resistance: disabled
      prm_age_modeling: equation
               prm_dyn: off
               prm_dir: noCurrentDirectionality
              prm_fade: disabled
              prm_leak: disabled

Specify options using dot notation.

cellModelOpt.BlockParameters.thermal_port = "model";

Any property values you do not specify retain their default values.

Create a default Cell object.

batteryCell = Cell
  batteryCell = 

  Cell with properties:

            Geometry: []
    CellModelOptions: [1×1 simscape.battery.builder.CellModelBlock]
                Mass: [1×1 simscape.Value]

Show the BlockParameters property of the CellModelOptions object inside the Cell object.

batteryCell.CellModelOptions.BlockParameters
      struct with fields:

          T_dependence: no
          thermal_port: model
           prm_age_OCV: OCV
      prm_age_capacity: disabled
    prm_age_resistance: disabled
      prm_age_modeling: equation
               prm_dyn: off
               prm_dir: noCurrentDirectionality
              prm_fade: disabled
              prm_leak: disabled

Specify options using dot notation.

batteryCell.CellModelOptions.BlockParameters.thermal_port = "model";

Version History

Introduced in R2022b