Symbol Processor#

class pybamm.SymbolProcessor[source]#

Processes symbols for a model by applying parameter values and discretisation.

This class provides a convenient way to process symbols using both pybamm.ParameterValues and pybamm.Discretisation objects. Once both are set, calling the processor on a symbol will first substitute parameters, then discretise the result.

parameter_values#

The parameter values used to process symbols.

Type:: pybamm.ParameterValues or None

discretisation#

The discretisation used to process symbols.

Type:: pybamm.Discretisation or None

can_process_symbols#

Whether symbol processing is enabled.

Type:: bool

Examples

>>> processor = pybamm.SymbolProcessor()
>>> processor.parameter_values = param
>>> processor.discretisation = disc
>>> processed_symbol = processor("my variable", symbol)

copy()[source]#: Return a copy of this SymbolProcessor.

disable()[source]#: Disable symbol processing.