dandeliion.client.solve

dandeliion.client.solve(simulator: Simulator, params: str, experiment: Experiment, var_pts: dict = None, model: str = 'DFN', initial_condition: dict = None, t_output: list = None, dt_eval: float = 0.1) → Solution[source]

Method for submitting/running a Dandeliion simulation.

Parameters:

  • simulator (Simulator) – instance of simulator class providing information to connect to simulation server

  • params (str) – path to BPX parameter file

  • experiment (Experiment) –

    instance of pybamm Experiment; currently only those supported with

    • only pybamm.experiment.step.steps.Current steps (or their equivalent in str representation) as steps

    • time and/or voltage termination criteria

  • var_pts (dict, optional) –

    simulation mesh specified by the following parameters in dictionary (if none or only subset is provided, either user-defined values stored in the bpx or, if not present, default values will be used instead):

    • ’x_n’ - Number of nodes in the electrolyte (negative electrode). Default is 30.

    • ’x_s’ - Number of nodes in the electrolyte (separator). Default is 20.

    • ’x_p’ - Number of nodes in the electrolyte (positive electrode). Default is 30.

    • ’r_n’ - Number of nodes in particles (negative electrode). Default is 30.

    • ’r_p’ - Number of nodes in particles (positive electrode). Default is 30.

  • model (str, optional) –

    name of model to be simulated. Default is ‘DFN’. Currently supported models are:

    • ’DFN’ - Newman 1D model

  • initial_condition (dict, optional) –

    dictionary of additional initial conditions (overwrites parameters provided in parameter file if they exist). Currently supported initial conditions are:

    • ’Initial temperature [K]’

    • ’Initial concentration in electrolyte [mol.m-3]’

    • ’Initial state of charge’

  • t_output (list, optional) – list of times to create outputs for. If not provided, then output times derived from experiment will be used (requires time stop criterion to be provided then)

  • dt_eval (float, optional) – time step used for resolving discontinuities in experiment. Default is 0.1 seconds.

Returns:

solution for this simulation run

Return type:

Solution