cideMOD.models.PXD.electrochemical.inputs

Classes

`ElectrochemicalModelInputs`()
`ElectrochemicalModelOptions`(*[, model, ...])	Electrochemical Model particle_coupling: str Coupling between cell and particle problem. Available options: implicit, explicit. Default to implicit. particle_model: int Particle model to be used. Available models: - SGM: Spectral Galerkin Model. Default option.

class cideMOD.models.PXD.electrochemical.inputs.ElectrochemicalModelInputs[source]

Bases: BasePXDModelInputs

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

It is also possible to create the class dinamically:

>>> cell.set_component('anode')

compute_reference_cell_properties(cell: CellParser)[source]

This method computes the general reference cell properties of the electrochemical model.

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

Notes

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

classmethod is_active_model(model_options: BaseModelOptions) → 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_active_material_parameters(am: BaseComponentParser) → None[source]

This method parses the active material parameters of the electrochemical model.

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

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

This methods parses the cell parameters of the electrochemical model.

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

parse_cell_structure(cell: CellParser)[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.
Return type:: Union[bool, list]

parse_current_collector_parameters(cc: BaseComponentParser) → None[source]

This method parses the current collector parameters of the electrochemical model.

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

parse_electrode_parameters(electrode: BaseComponentParser) → None[source]

This method parses the electrode parameters of the electrochemical model.

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

parse_electrolyte_parameters(electrolyte: BaseComponentParser) → None[source]

This method parses the electrolyte parameters of the electrochemical model.

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

parse_separator_parameters(separator: BaseComponentParser) → None[source]

This method parses the separator parameters of the electrochemical model.

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

set_cell_state(problem, SoC=None, T_ext=None, T_ini=None) → None[source]

This method set the current state of the cell.

Parameters:

problem (Problem) – Object that handles the battery cell simulation.
SoC (float, optional) – Current State of Charge of the battery cell. Default initial value to 1.
T_ext (float, optional) – External temperature. Default initial value to 298,15 K.
T_ini (float, optional) – Uniform value of the internal temperature. Default initial value to T_ext.

class cideMOD.models.PXD.electrochemical.inputs.ElectrochemicalModelOptions(*, model: str = 'P2D', particle_coupling: str = 'implicit', particle_model: str = 'SGM', time_scheme: str = 'euler_implicit')[source]

Bases: BaseModel

Electrochemical Model

particle_coupling: str: Coupling between cell and particle problem. Available options: implicit, explicit. Default to implicit.
particle_model: int: Particle model to be used. Available models: - SGM: Spectral Galerkin Model. Default option.

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.

model: str

particle_coupling: str

particle_model: str

time_scheme: str

classmethod validate_model(v)[source]

classmethod validate_particle_coupling(v)[source]

classmethod validate_particle_model(v)[source]