mtnlion.models.thermal module

Isothermal model extended with thermal modeling

class mtnlion.models.thermal.Thermal(Ns)[source]

Bases: mtnlion.models.isothermal.Isothermal

The thermal model extends the isothermal model to allow the modeling of internal heat generation which is used to determine the temperature of the cell at any location.

class AdaptT[source]

Bases: mtnlion.formula.Formula

An adapter formula to allow existing formulas to use the temperature variable T as if it were still a parameter.

form(arguments: mtnlion.formula.Arguments, domain: str) → ufl.core.expr.Expr[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class DeEff[source]

Bases: mtnlion.formula.Formula

Effective diffusivity of the electrolyte.

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class Ds[source]

Bases: mtnlion.formula.Formula

Solid diffusivity.

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class ExchangeCurrentDensity[source]

Bases: mtnlion.models.isothermal.ExchangeCurrentDensity

The exchange current density is the current in the absence of net electrolysis and at zero overpotential.

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class HeatGeneration[source]

Bases: mtnlion.formula.Formula

Total heat generated in the cell.

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class HeatGenerationChemical[source]

Bases: mtnlion.formula.Formula

Irreversible heat generation due to chemical reactions for each chemical reaction at the interface.

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class HeatGenerationEntropy[source]

Bases: mtnlion.formula.Formula

Reversible heat generation due to a change in entropy for each chemical reaction at the interface

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class JouleHeatingElectrolyte1[source]

Bases: mtnlion.formula.Formula

Joule heating due to electrical potential gradient in the electrolyte

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class JouleHeatingElectrolyte2[source]

Bases: mtnlion.formula.Formula

Joule heating due to electrical potential gradient in the electrolyte

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class JouleHeatingSolid[source]

Bases: mtnlion.formula.Formula

Joule heating due to electrical potential gradient in the solid.

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class KappaDEff[source]

Bases: mtnlion.formula.Formula

kappa_d effective.

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class KappaEff[source]

Bases: mtnlion.models.isothermal.KappaEff

Effective conductivity of the electrolyte.

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class SigmaEff[source]

Bases: mtnlion.formula.Formula

Effective conductivity (electrode-dependent parameter), represents a volume averaged conductivity of the solid matrix in a porous media in the vicinity of a given point.

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form

class Temperature[source]

Bases: mtnlion.formula.Formula

Temperature of the cell.

form(arguments, domain)[source]

This method must be overloaded to define the form of the Formula.

Parameters

  • arguments – All arguments defined by overriding one or more of Formula.Variables, Formula.Formulas, Formula.Parameters, Formula.Lambdas, and Formula.TimeDiscretization

  • domain – The current domain in which the function is being evaluated

Returns

FFL form