Parameter#

class pybamm.Parameter(name: str)[source]#

A node in the expression tree representing a parameter.

This node will be replaced by a pybamm.Scalar node

Parameters:

name (str) – name of the node

Extends: pybamm.expression_tree.symbol.Symbol

create_copy(new_children=None, perform_simplifications=True) → Parameter[source]#

See pybamm.Symbol.new_copy().

is_constant() → Literal[False][source]#

See pybamm.Symbol.is_constant().

to_equation() → Symbol[source]#

Convert the node and its subtree into a SymPy equation.

to_json()[source]#

Method to serialise a Symbol object into JSON.

class pybamm.FunctionParameter(name: str, inputs: dict[str, Symbol], diff_variable: Symbol | None = None, print_name='calculate', post_processor=None)[source]#

A node in the expression tree representing a function parameter.

This node will be replaced by a pybamm.Function node if a callable function is passed to the parameter values, and otherwise (in some rarer cases, such as constant current) a pybamm.Scalar node.

Parameters:

  • name (str) – name of the node

  • inputs (dict) – A dictionary with string keys and pybamm.Symbol values representing the function inputs. The string keys should provide a reasonable description of what the input to the function is (e.g. “Electrolyte concentration [mol.m-3]”)

  • diff_variable (pybamm.Symbol, optional) – if diff_variable is specified, the FunctionParameter node will be replaced by a pybamm.Function and then differentiated with respect to diff_variable. Default is None.

  • print_name (str, optional) – The name to show when printing. Default is ‘calculate’, in which case the name is calculated using sys._getframe().

  • post_processor (callable, optional) – A callable that takes a pybamm.Symbol and returns a pybamm.Symbol. If provided, it will be applied to the function output after the function is evaluated during parameter processing. This can be used to apply regularisation or other transformations. Default is None.

Extends: pybamm.expression_tree.symbol.Symbol

create_copy(new_children=None, perform_simplifications=True)[source]#

See pybamm.Symbol.new_copy().

diff(variable: Symbol) → FunctionParameter[source]#

See pybamm.Symbol.diff().

set_id()[source]#

See pybamm.Symbol.set_id()

to_equation() → Symbol[source]#

Convert the node and its subtree into a SymPy equation.

to_json()[source]#

Method to serialise a Symbol object into JSON.