cideMOD.models.particle_models.SGM_basic.inputs

Classes

`ParticleModelSGMInputs`()
`ParticleModelSGMOptions`(*[, particle_order])	Particle Model. SGM particle_order: int Order of spectral finite elements interpolation in particle. Defaults to 2

class cideMOD.models.particle_models.SGM_basic.inputs.ParticleModelSGMInputs[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_active_material_parameters(am: BaseComponentParser) → None[source]

This method parses the active material parameters of the SGM particle model.

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

class cideMOD.models.particle_models.SGM_basic.inputs.ParticleModelSGMOptions(*, particle_order: int = 2)[source]

Bases: BaseModel

Particle Model. SGM

particle_order: int: Order of spectral finite elements interpolation in particle. Defaults to 2

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.