IOionworks
Simulations

Get Simulation Spatial Profile

Changed on

Evaluate a one-dimensional spatial field from stored solution chunks.

get/simulations/{simulation_id}/spatial-profile

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/simulations/{simulation_id}/spatial-profile
  • 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.

coordinate_namestring required

Spatial coordinate used for the profile.

coordinatesnumber[] required

One-dimensional mesh coordinates in metres.

timesnumber[] required

Stored simulation times in seconds.

domainsstring[]

Ordered PyBaMM domains along the coordinate.

domain_boundariesnumber[]

Internal boundaries between adjacent domains in metres.

Changes