cideMOD.models.PXD.thermal.inputs

Classes

`ThermalModelInputs`()
`ThermalModelOptions`(*[, solve_thermal])	Thermal Model solve_thermal: bool Whether or not to solve the thermal model

class cideMOD.models.PXD.thermal.inputs.ThermalModelInputs[source]

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_cell_parameters(cell: CellParser) → None[source]

This methods parses the cell parameters of the thermal model.

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

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

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

parse_electrode_parameters(electrode: BaseComponentParser)[source]

This method parses the electrode parameters of the thermal 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 thermal 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 thermal model.

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

class cideMOD.models.PXD.thermal.inputs.ThermalModelOptions(*, solve_thermal: bool = False)[source]

Bases: BaseModel

Thermal Model

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.