Initial Concentration Calculations¶
- class ionworkspipeline.calculations.InitialSOC(soc)¶
Calculate the initial concentration in the negative and positive electrodes from the initial SOC and stoichiometry windows in each electrode.
Parameters¶
- socfloat
The state of charge to calculate the initial concentration at.
Extends:
ionworkspipeline.calculations.calculation.Calculation
- class ionworkspipeline.calculations.InitialSOCHalfCell(electrode, soc)¶
Calculate the initial concentration in the given electrode from the initial SOC and stoichiometry window.
Parameters¶
- electrodestr
The electrode to calculate the initial concentration for. Must be either “negative” or “positive”.
- socfloat, int, or str
The state of charge to calculate the initial concentration at. If a string is provided, it should match the name of a “Electrode stoichiometry at X SOC” parameter in the parameter values dictionary, e.g. “0%”, “100%”, “minimum”, “maximum”.
Extends:
ionworkspipeline.calculations.calculation.Calculation
- class ionworkspipeline.calculations.InitialVoltageFromConcentration(electrode)¶
Calculate the initial voltage in the given electrode from the initial concentration (i.e. find the voltage that gives the correct concentration).
Extends:
ionworkspipeline.calculations.calculation.Calculation
- class ionworkspipeline.calculations.InitialStoichiometryFromVoltageHalfCell(electrode, options=None)¶
Calculate the initial stoichiometry in the given electrode from the initial voltage (i.e. find the stoichiometry that gives the correct voltage).
Parameters¶
- electrodestr
The electrode to calculate the initial concentration for, either “positive” or “negative”.
- optionsdict, optional
A dictionary of options to be passed to the calculation. The following options are available:
- simulation_kwargs: dict
Keyword arguments to pass to the simulation (
iwp.Simulation
). Default is {“solver”: pybamm.AlgebraicSolver()}.
Extends:
ionworkspipeline.calculations.calculation.Calculation
- class ionworkspipeline.calculations.InitialStoichiometryFromVoltageMSMRHalfCell(electrode)¶
Calculate the initial stoichiometry in the given electrode from the initial voltage (i.e. find the stoichiometry that gives the correct voltage) using the MSMR framework.
Parameters¶
- electrodestr
The electrode to calculate the initial concentration for, either “positive” or “negative”.
Extends:
ionworkspipeline.calculations.calculation.Calculation