2.4.1 Post-step hook function

Demonstrate the simple hook function in PDE, which is called after each time step and may modify the state and abort the simulation.

  0%|          | 0/10000.0 [00:00<?, ?it/s]
Initializing:   0%|          | 0/10000.0 [00:00<?, ?it/s]
  0%|          | 0/10000.0 [00:12<?, ?it/s]
  0%|          | 0.1/10000.0 [00:12<342:14:13, 123.21s/it]
  0%|          | 0.2/10000.0 [00:12<171:07:07, 61.60s/it]
  0%|          | 17.0/10000.0 [00:12<2:00:35,  1.38it/s]
  6%|▌         | 558.9/10000.0 [00:12<03:28, 45.26it/s]
  6%|▌         | 558.9/10000.0 [00:12<03:28, 45.18it/s]
  6%|▌         | 558.9/10000.0 [00:12<03:28, 45.18it/s]

from pde import PDE, ScalarField, UnitGrid


def post_step_hook(state_data, t):
    """Helper function called after every time step."""
    state_data[24:40, 24:40] = 1  # set central region to given value

    if t > 1e3:
        raise StopIteration  # abort simulation at given time

    return state_data


eq = PDE({"c": "laplace(c)"}, post_step_hook=post_step_hook)
state = ScalarField(UnitGrid([64, 64]))
result = eq.solve(state, dt=0.1, t_range=1e4)
result.plot()