cideMOD.models.PXD.degradation.SEI.base_SEI

Classes

BaseSEIModel(options)
BaseSEIModelOptions(*[, SEI_model])	SEI Model SEI_model: Optional[str] Which limiting mechanism is applied to the SEI model, one of solvent_diffusion, electron_migration. Use None in order to deactivate the SEI model. Defaults to None.
SEIParameters(root, parser[, tag, verbose])
SEIParser(electrode, dic[, tag])

class cideMOD.models.PXD.degradation.SEI.base_SEI.BaseSEIModel(options)

Bases: BasePXDModel

build_cell_components(cell) → None

This method builds the components of the cell that fit our model type, e.g. electrodes, separator, current collectors, etc.

Parameters:

cell (CellParser) – Parser of the cell dictionary.

Examples

>>> cell.set_component('anode')

It is also possible to create the class dinamically:

>>> cell.set_component('anode')

build_weak_formulation(equations: ProblemEquations, var: ProblemVariables, cell: BatteryCell, mesher: BaseMesher, DT: TimeScheme, W: BlockFunctionSpace, problem) → None

This method builds the weak formulation of this specific model.

Parameters:

• equations (ProblemEquations) – Object that contains the system of equations of the problem.

• var (ProblemVariables) – Object that store the preprocessed problem variables.

• cell (BatteryCell) – Object where cell parameters are preprocessed and stored.

• mesher (BaseMesher) – Object that store the mesh information.

• DT (TimeScheme) – Object that provide the temporal derivatives with the specified scheme.

• W (BlockFunctionSpace) – Object that store the function space of each state variable.

• problem (Problem) – Object that handles the battery cell simulation.

get_solvers_info(solvers_info, problem) → None

This method get the solvers information that concerns this specific model.

Parameters:

• solvers_info (dict) – Dictionary containing solvers information.

• problem (Problem) – Object that handles the battery cell simulation.

classmethod is_active_model(model_options: BaseModelOptions) → bool

This method checks the model options configured by the user to evaluate if this SEI model should be added to the cell model.

Parameters:

model_options (BaseModelOptions) – Model options already configured by the user.

Returns:

Whether or not this model should be added to the cell model.

Return type:

bool

parse_SEI_parameters(SEI) → None

This method parses the electrode parameters of the SEI model.

Parameters:

SEI (BaseComponentParser) – Object that parses the SEI parameters.

parse_compactSEI_parameters(compact) → None

This method parses the electrode parameters of the compact SEI model.

Parameters:

compactSEI (BaseComponentParser) – Object that parses the compact SEI parameters.

parse_porousSEI_parameters(porous) → None

This method parses the electrode parameters of the SEI model.

Parameters:

SEI (BaseComponentParser) – Object that parses the SEI parameters.

set_SEI_parameters(SEI, problem) → None

This method preprocesses the electrode parameters of the electrochemical model.

Parameters:

• SEI (BaseCellComponent) – Object where electrode parameters are preprocessed and stored.

• problem (Problem) – Object that handles the battery cell simulation.

set_compactSEI_parameters(compact, problem) → None

This method preprocesses the electrode parameters of the compact SEI model.

Parameters:

• compactSEI (BaseCellComponent) – Object where electrode parameters are preprocessed and stored.

• problem (Problem) – Object that handles the battery cell simulation.

set_porousSEI_parameters(porous, problem) → None

This method preprocesses the electrode parameters of the electrochemical model.

Parameters:

• SEI (BaseCellComponent) – Object where electrode parameters are preprocessed and stored.

• problem (Problem) – Object that handles the battery cell simulation.

class cideMOD.models.PXD.degradation.SEI.base_SEI.BaseSEIModelOptions(*, SEI_model: str | None = None)

Bases: BaseModel

SEI Model

SEI_model: Optional[str]

Which limiting mechanism is applied to the SEI model, one of solvent_diffusion, electron_migration. Use None in order to deactivate the SEI model. Defaults to None.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

SEI_model: str | None

classmethod validate_particle_coupling(v)

class cideMOD.models.PXD.degradation.SEI.base_SEI.SEIParameters(root, parser: BaseComponentParser, tag: str | None = None, verbose=VerbosityLevel.NO_INFO)

Bases: BaseCellComponent

class CompactLayerParameters(SEI, parser, tag=None, verbose=VerbosityLevel.NO_INFO)

Bases: BaseCellComponent

class PorousLayerParameters(SEI, parser, tag=None, verbose=VerbosityLevel.NO_INFO)

Bases: BaseCellComponent

class cideMOD.models.PXD.degradation.SEI.base_SEI.SEIParser(electrode, dic, tag=None)

Bases: BaseComponentParser

class CompactLayerParser(SEI, dic, tag=None)

Bases: BaseComponentParser

class PorousLayerParser(SEI, dic, tag=None)

Bases: BaseComponentParser