cideMOD.models.base.base_models.inputs

Classes

BaseCellModelInputs()

Base mixin class that contains the mandatory methods to be overrided related to the inputs of cideMOD.models.BaseCellModel.

class cideMOD.models.base.base_models.inputs.BaseCellModelInputs[source]

Bases: ABC

Base mixin class that contains the mandatory methods to be overrided related to the inputs of cideMOD.models.BaseCellModel.

build_cell_components(cell: CellParser) → None[source]

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', ElectrodeParser)

It is also possible to create the class dinamically:

>>> cell.set_component('anode', 'ElectrodeParser')

compute_reference_cell_properties(cell: CellParser) → None[source]

This method computes the general reference cell properties of this specific model.

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

Notes

This method is called once the cell parameters has been parsed.

abstract classmethod is_active_model(model_options) → bool[source]

This method checks the model options configured by the user to evaluate if this 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_cell_structure(cell: CellParser) → None[source]

This method parse the cell structure. If there are any component this model does not know, then this method should return the list of unrecognized components. Maybe this components has been defined by other models, so this task should be delegated to these model.

Parameters:

cell (CellParser) – Parser of the cell dictionary.

Returns:

Whether or not the cell structure is valid. If there are any component this model does not know, then this method should return the list of unrecognized components.

If this model has not added any component, then return None.

Return type:

Optional[Union[bool, list]]

set_cell_state(problem, **kwargs) → None[source]

This method set the current state of the cell.

Parameters:

problem (Problem) – Object that handles the battery cell simulation.
kwargs (dict) – Dictionary containing the variables that defines the cell state. They must be defined by the active models.

Notes

Notice that Problem will call this method at least once to set the default values.

Examples

>>> problem.SoC_ini = SoC_ini