IOionworks
Simulations

Get Simulation Spatial Field

Changed on

Evaluate a 2D/3D field on an unstructured mesh from stored solution chunks.

Returns the mesh as a VTK unstructured grid plus the field's cell values at up to max_time_points stored times, for rendering with vtk.js.

get/simulations/{simulation_id}/spatial-field

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/simulations/{simulation_id}/spatial-field
  • Auth
    none declared

Path parameters

simulation_idstring uuid required

Query parameters

variablestring required
max_time_pointsinteger

Response

Successful Response

variablestring required

Evaluated PyBaMM variable name.

dimension2 | 3 required

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

axis_namesstring[] required

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

n_pointsinteger required

Number of mesh vertices.

pointsstring required

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

n_cellsinteger required

Number of mesh cells.

nodes_per_cellinteger required

Vertices per cell.

cell_typeinteger required

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

connectivitystring required

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

association'cell' | 'point' required

Whether values are per cell or per vertex.

timesnumber[] required

Sampled simulation times in seconds.

valuesstring required

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

value_rangenumber[] required

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

domainsstring[]

PyBaMM domains the field spans.

Changes