Co-simulation settings
Set communication step, start/stop time, coupling iteration, tolerance, relaxation, isolated host timeout and recorded outputs. A smaller step and convergence study are needed for fast or tightly coupled systems.
Step-by-step workflows · Menus and keyboard

| Control | Meaning / action | Unit | Range / choices | Example value |
|---|---|---|---|---|
| Simulation period: | Simulated period; the first value uses the project's simulation period. | years | 0 to 100 | 0 |
| Use the period | Clear the stored stop time: the run then covers the simulation period above. | |||
| Communication step: | Communication step: the FMUs and the borehole field exchange values at this interval (default 600 s). Smaller steps reduce the coupling error and take longer. | s | 1 to 86400 | 600 |
| Recording interval: | Interval of the recorded time series (0 = every step). | s | 0 to 3.1536e+07 | 0 |
| Coupling: | Explicit: a loop uses the value of the previous sweep (the error falls with the step). Iterate: fixed-point iteration at every communication point. | Explicit / Iterate | ||
| Iterations at most: | Iterations per communication point at most. | 1 to 1000 | 20 | |
| Tolerance: | Relative change on the loop connections that ends the iteration. | 10⁻³ / 10⁻⁴ / 10⁻⁵ / 10⁻⁶ / 10⁻⁷ / 10⁻⁸ / 10⁻⁹ / 10⁻¹⁰ | ||
| Relaxation: | Under-relaxation of the iteration (1 = none). | 0.05 to 1 | 1 | |
| Repeat each step with rollback until the loop is consistent | Implicit coupling: needs every FMU in the loop to save and restore its state. | |||
| Long-term mode: | Hybrid: year 1 coupled; years 2 … N−1 from the ground load of year 1 (times the growth factor per year); the last year coupled again. Much faster for long periods. | Automatic (hybrid over 2 years) / Full (coupled over the whole period) / Hybrid (first and last year coupled) | ||
| Growth factor per year: | Hybrid mode: factor per year on the extended ground load. | 0.5 to 2 | 1 | |
| Run FMUs: | Isolated: every FMU runs in its own process, so a crash or a hang cannot take BoreTherm down. In-process: about ten times faster, for trusted, well-behaved FMUs. | Isolated (separate process) / In-process (faster) | ||
| Time-out per call: | Isolated host: an FMU call that takes longer is stopped (watchdog). | s | 1 to 3600 | 60 |
| Fluid density: | Density for converting mass flow and volume flow (0 = the heat carrier fluid's). | kg/m³ | 0 to 2000 | 0 |
| Size with several runs at once | Sizing runs several borehole lengths at once where the FMUs allow it. | |||
| Run co-simulation | Simulate the system over the period (results on Co-simulation → Results). | |||
| One-day test run | Simulate the first day only: a quick check of the connections, units and FMUs. | |||
| Size with the co-simulation | Find the borehole length that keeps the mean fluid temperature within the design limits, with a coupled run at every length tried (range and limits from the project). |