Skip to main content
Get Simulation Spatial Field

Path Parameters

simulation_id
string<uuid>
required

Query Parameters

variable
string
required
max_time_points
integer
default:60
Required range: 1 <= x <= 500

Response

Successful Response

A time-dependent scalar field on an unstructured 2D or 3D PyBaMM mesh.

Shaped for a VTK unstructured grid. points, connectivity and values are base64-encoded little-endian typed arrays: decode them straight into a Float32Array / Int32Array / Float32Array.

variable
string
required

Evaluated PyBaMM variable name.

dimension
enum<integer>
required

Number of meshed spatial axes (2 = x-z plane, 3 = x-y-z).

Available options:
2,
3
axis_names
string[]
required

Physical axis of each point coordinate, e.g. ['x', 'y', 'z'].

n_points
integer
required

Number of mesh vertices.

points
string
required

Base64 float32 xyz triples in metres, n_points * 3 values. A 2D mesh has z = 0.

n_cells
integer
required

Number of mesh cells.

nodes_per_cell
integer
required

Vertices per cell.

cell_type
integer
required

VTK cell-type code: 5 triangle, 9 quad, 10 tetrahedron, 12 hexahedron.

connectivity
string
required

Base64 int32 vertex indices, n_cells * nodes_per_cell values in VTK node order.

association
enum<string>
required

Whether values are per cell or per vertex.

Available options:
cell,
point
times
number[]
required

Sampled simulation times in seconds.

values
string
required

Base64 float32 field values, time-major: len(times) blocks of n_cells (or n_points) values.

value_range
number[]
required

[min, max] of the finite values over every sampled time.

domains
string[]

PyBaMM domains the field spans.