Main Content

CylindricalGeometry

Cylindrical geometry for battery cell

Since R2022b

expand all in page

Description

Use CylindricalGeometry to represent the geometry of a cylindrical battery cell. To specify the dimensions of a cylindrical geometry, use the Radius and Height properties.

Creation

Syntax

cylinder = CylindricalGeometry
cylinder = CylindricalGeometry(Name=Value)

Description

Note

To quickly create a CylindricalGeometry object, use the batteryCylindricalGeometry function. By using this function, you avoid importing the namespace, using the full class name, or dealing only with name-value arguments when creating the object. (since R2024a)

To use this object, at the MATLAB® Command Window, run this command at least once each MATLAB session:

import simscape.battery.builder.*;
All properties are exposed as name-value arguments in this object.

cylinder = CylindricalGeometry creates a cylindrical geometry with default property values.

cylinder = CylindricalGeometry(Name=Value) creates a cylindrical geometry with a specified radius and height using name-value arguments.

Properties

expand all

Radius of the cylinder, specified as a positive scalar or a simscape.Value object that represents a positive scalar with a unit of length. This value must be less than 0.5 meters.

If you set this property directly with a positive scalar value instead of using a simscape.Value object, the object converts the value to a simscape.Value object with meter as its physical unit.

Height of the cylinder, specified as a positive scalar or a simscape.Value object that represents a positive scalar with a unit of length. The length of the cylinder is aligned with the z-axis of the reference frame. This value must be strictly positive.

If you set this property directly with a positive scalar value instead of using a simscape.Value object, the object converts the value to a simscape.Value object with meter as its physical unit.

Version History

Introduced in R2022b

See Also

Apps

Objects

Functions

Topics