Previous topic

Base Experiment Class

Next topic

Utility functions

This Page

Post-Process Variables

class pybamm.ProcessedVariable(base_variable, solution, known_evals=None)[source]

An object that can be evaluated at arbitrary (scalars or vectors) t and x, and returns the (interpolated) value of the base variable at that t and x.

Parameters:
  • base_variable (pybamm.Symbol) – A base variable with a method evaluate(t,y) that returns the value of that variable. Note that this can be any kind of node in the expression tree, not just a pybamm.Variable. When evaluated, returns an array of size (m,n)
  • solution (pybamm.Solution) – The solution object to be used to create the processed variables
  • interp_kind (str) – The method to use for interpolation
  • known_evals (dict) – Dictionary of known evaluations, to be used to speed up finding the solution
call_2D(t, x, r, z)[source]

Evaluate a 2D variable

call_3D(t, x, r, y, z)[source]

Evaluate a 3D variable

data

Same as entries, but different name

initialise_3D()[source]

Initialise a 3D object that depends on x and r, or x and z.