cideMOD.cell.components

cell_components creates and initializes the corresponding battery components attributes. This also includes the functions for the weak formulation.

Classes

`BaseCellComponent`(root, parser[, tag, verbose])	Base class for cell component creation.
`BatteryCell`(problem)	Class that preprocesses and stores the cell parameters.
`ElectrodeParameters`(root, parser[, tag, verbose])

class cideMOD.cell.components.BaseCellComponent(root, parser: BaseComponentParser, tag: str | None = None, verbose=VerbosityLevel.NO_INFO)[source]

Bases: ABC

Base class for cell component creation.

Parameters:

root (Optional[BaseCellComponent]) – Component to which it belongs. If it does not the case, then it should be None.
config (BaseComponentParser) – Object where the cell component parameters are parsed.
tag (str) – Tag to identify the component between the available tags.

property complete_tag

get_component(name) → Self[source]: This method return the specified component

property label

class property name

property parser: BaseComponentParser

property tag

class cideMOD.cell.components.BatteryCell(problem)[source]

Bases: BaseCellComponent

Class that preprocesses and stores the cell parameters.

Parameters:: problem (Problem) – Object tha handles the battery cell simulation.

class cideMOD.cell.components.ElectrodeParameters(root, parser: BaseComponentParser, tag: str | None = None, verbose=VerbosityLevel.NO_INFO)[source]

Bases: BaseCellComponent

class ActiveMaterialParameters(root, parser, tag=None, verbose=VerbosityLevel.NO_INFO)[source]

Bases: BaseCellComponent

property electrode_tag