In this step, you learn how preCICE handles non-matching timestep sizes and a few more things about simulation time.

In previous steps, you have already seen that there are quite some things going on with timestep sizes. Let us now have a look at what is actually happening.

...
double dt; // solver timestep size
double precice_dt; // maximum precice timestep size

precice_dt = precice.initialize();
while (not simulationDone()){ // time loop
  dt = beginTimeStep(); // e.g. compute adaptive dt 
  dt = min(precice_dt, dt);
  solveTimeStep(dt);
  precice_dt = precice.advance(dt);
  endTimeStep(); // e.g. update variables, increment time
}

Good thing to know: in this step, you do really not have to alter your code. Everything needed is already there :relieved:. We now simply want to learn on what actually happens.

There are basically two options to choose from in the configuration.

<time-window-size value="..." method="..."/>

method can be:

  • fixed: A fixed time window with size value is prescribed, during which both participants can use whatever timestep sizes they want. Communication of coupling data happens only after each time window.
  • first-participant: The first participant prescribes the timestep size for the second one. Communication of coupling data happens after each timestep. This option is only available for serial coupling schemes (more about configuration of coupling schemes). The attribute value is not applicable.

Let us have a closer look at both options.

Fixed time window

The preCICE configuration defines a fixed time window. Both participants can use smaller timestep sizes, but then they subcycle, i.e. coupling data is only communicated at the end of each time window. The figure below illustrates this procedure (k is the subcycling index, the dashed lines mark the time window):

Timestepping with a fixed time window

  • After each timestep, both participants tell preCICE which timestep size dt they just used. This way, preCICE can keep track of the total time. preCICE returns the remainder time to the next window.
precice_dt = precice.advance(dt);
  • Both participants compute their next (adaptive) timestep size. It can be larger or smaller than the remainder.
dt = beginTimeStep();

If it is larger, the remainder dt_precice is used instead (orange participant, dark orange is used). If it is smaller, the participant’s timestep size dt can be used (blue participant, dark blue is used). These two cases are reflected in:

dt = min(precice_dt, dt)
  • Once both participants reach the end of the time window, coupling data is exchanged.

If a participant subcycles it is actually not necessary to write data to or read data from preCICE. To avoid unnecessary calls, preCICE offers two optional helper functions:

bool isReadDataAvailable () const;
bool isWriteDataRequired (double computedTimestepLength) const;

You can use them as follows:

while (not simulationDone()){ // time loop
  if (precice.isReadDataAvailable()){
    precice.readBlockVectorData(displID, vertexSize, vertexIDs, displacements);
    setDisplacements(displacements);
  }
  dt = beginTimeStep(); // e.g. compute adaptive dt 
  dt = min(precice_dt, dt);
  solveTimeStep(dt);
  if (precice.isWriteDataRequired(dt)){
    computeForces(forces);
    precice.writeBlockVectorData(forceID, vertexSize, vertexIDs, forces);
  }
  precice_dt = precice.advance(dt);
  endTimeStep(); // e.g. update variables, increment time
}

First participant prescribes timestep size

The first participant sets the timestep size. This requires that the second participant runs after the first one. Thus, as stated above, this option is only applicable for serial coupling.

First participant prescribes timestep size

  • The blue participant B is first and computes a step with its timestep size (Step 1).
  • In advance, this timestep size is given to preCICE (Step 2).
precice_dt = precice.advance(dt);
  • preCICE has tracked the time level of the orange participant A and returns the remainder to reach B’s timestep size.
  • A computes its next (adaptive) timestep size. It can now be larger or smaller than the remainder.
dt = beginTimeStep();

If it is larger, the remainder dt_precice is used instead (the case below in Step 3, dark orange is used). If it is smaller, the participant’s timestep size dt can be used (not visualized). These two cases are again reflected in the formula:

dt = min(precice_dt, dt)
  • The procedure starts over with the blue participant B.

Steering the end of the simulation

One last thing about time. There is also a helper function in preCICE that allows you to steer the end of a coupled simulation:

bool isCouplingOngoing();

This functions looks at max-time-windows and max-time as defined in the preCICE configuration and knows when it is time to go. Then, you should call finalize. It replaces your simulationDone().

while (not precice.isCouplingOngoing()){ // time loop
  ...
}
precice.finalize();