cideMOD.models.PXD.base_model

Classes

`BasePXDModel`(options)	Abstract base class for PXD models
`BasePXDModelInputs`()
`BasePXDModelPreprocessing`()

class cideMOD.models.PXD.base_model.BasePXDModel(options)[source]

Bases: BasePXDModelInputs, BasePXDModelPreprocessing, BaseCellModel, ABC

Abstract base class for PXD models

Parameters:

name (str) – Name of the model. Defaults to ‘Unnamed model’
time_scheme (str) – Type of time scheme. It must be either ‘implicit’ or ‘explicit’
root (bool) – Whether or not is a root model
hierarchy (int) – Hierarchy level. The lower the hierarchy the greater its priority. Notice that root model > implicit models > explicit models is always true regardless of its hierarchy level
note:: (..) – Notice that some model methods may be overrided by other models with higher hierarchy level

class cideMOD.models.PXD.base_model.BasePXDModelInputs[source]

Bases: BaseCellModelInputs, ABC

parse_active_material_parameters(am) → None[source]

This method parses the active material parameters of this specific model.

Parameters:: am (BaseComponentParser) – Object that parses the active material parameters.

Examples

To parse a new active material parameter call:

>>> am.new_parameter = am.parse_value('json name', default=1)

parse_cell_parameters(cell) → None[source]

This method parses the cell parameters of this specific model.

Parameters:: cell (CellParser) – Parser of the cell dictionary.

Examples

To parse a new cell parameter call:

>>> cell.new_parameter = cell.parse_value(
        'json name', default=1)

parse_current_collector_parameters(cc) → None[source]

This method parses the current collector parameters of this specific model.

Parameters:: cc (BaseComponentParser) – Object that parses the current collector parameters.

Examples

To parse a new current collector parameter call:

>>> cc.new_parameter = cc.parse_value('json name', default=1)

parse_electrode_parameters(electrode) → None[source]

This method parses the electrode parameters of this specific model.

Parameters:: electrode (BaseComponentParser) – Object that parses the electrode parameters.

Examples

To parse a new electrode parameter call:

>>> electrode.new_parameter = electrode.parse_value(
        'json name', default=1)

parse_electrolyte_parameters(electrolyte) → None[source]

This method parses the electrolyte parameters of this specific model.

Parameters:: electrolyte (BaseComponentParser) – Object that parses the electrolyte parameters.

Examples

To parse a new electrolyte parameter call:

>>> electrolyte.new_parameter = electrolyte.parse_value(
        'json name', default=1)

parse_separator_parameters(separator) → None[source]

This method parses the separator parameters of this specific model.

Parameters:: separator (BaseComponentParser) – Object that parses the separator parameters.

Examples

To parse a new separator parameter call:

>>> separator.new_parameter = separator.parse_value(
        'json name', default=1)

class cideMOD.models.PXD.base_model.BasePXDModelPreprocessing[source]

Bases: BaseCellModelPreprocessing

get_brug(porous_component, dic, problem, phase, **kwargs)[source]

get_brug_e(porous_component, dic, problem, **kwargs)[source]: Calculate Bruggeman constant for the liquid phase in the component.

get_brug_s(porous_component, dic, problem, **kwargs)[source]: Calculate Bruggeman constant for the solid phase in the component.

set_active_material_parameters(am, problem) → None[source]

This method preprocesses the active material parameters of this specific model.

Parameters:

am (BaseCellComponent) – Object where active material parameters are preprocessed and stored.
problem (Problem) – Object that handles the battery cell simulation.

set_cell_parameters(cell, problem) → None[source]

This method preprocesseses the cell parameters of this specific model.

Parameters:

cell (BatteryCell) – Object where cell parameters are preprocessed and stored.
problem (Problem) – Object that handles the battery cell simulation.

set_current_collector_parameters(cc, problem) → None[source]

This method preprocesses the current collector parameters of this specific model.

Parameters:

cc (BaseCellComponent) – Object where the current collector parameters are preprocessed and stored.
problem (Problem) – Object that handles the battery cell simulation.

set_electrode_parameters(electrode, problem) → None[source]

This method preprocesses the electrode parameters of this specific model.

Parameters:

electrode (BaseCellComponent) – Object where electrode parameters are preprocessed and stored.
problem (Problem) – Object that handles the battery cell simulation.

set_electrolyte_parameters(electrolyte, problem) → None[source]

This method preprocesses the electrolyte parameters of this specific model.

Parameters:

electrolyte (BaseCellComponent) – Object where the electrolyte parameters are preprocessed and stored.
problem (Problem) – Object that handles the battery cell simulation.

set_separator_parameters(separator, problem) → None[source]

This method preprocesses the separator parameters of this specific model.

Parameters:

separator (BaseCellComponent) – Object where separator parameters are preprocessed and stored.
problem (Problem) – Object that handles the battery cell simulation.