HomeFeaturesExamplesTutorialsHelpTheoryVerificationPricingContact
BoreTherm Online help

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

Co-simulation settings in BoreTherm
English GUI; click to enlarge.
Controls captured from the BoreTherm GUI. Ranges are interface bounds; example values depend on the open project.
ControlMeaning / actionUnitRange / choicesExample value
Simulation period:Simulated period; the first value uses the project's simulation period.years0 to 1000
Use the periodClear 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.s1 to 86400600
Recording interval:Interval of the recorded time series (0 = every step).s0 to 3.1536e+070
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 100020
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 11
Repeat each step with rollback until the loop is consistentImplicit 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 21
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).s1 to 360060
Fluid density:Density for converting mass flow and volume flow (0 = the heat carrier fluid's).kg/m³0 to 20000
Size with several runs at onceSizing runs several borehole lengths at once where the FMUs allow it.
Run co-simulationSimulate the system over the period (results on Co-simulation → Results).
One-day test runSimulate the first day only: a quick check of the connections, units and FMUs.
Size with the co-simulationFind 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).