From 5e4c32a327b8845e55a0aebdb2fa00b3a309599c Mon Sep 17 00:00:00 2001 From: Felix Oesterle <6945681+fso42@users.noreply.github.com> Date: Tue, 2 Jun 2026 11:31:35 +0200 Subject: [PATCH] docs(com1DFA): clarify time-stepping configuration in docs and config file; fixes #1285 - Updated comment in `com1DFACfg.ini` to clarify `sphKernelRadiusTimeStepping` behavior. - Revised documentation in `com1DFAAlgorithm.rst` to explain time-stepping options, including kernel size consistency. docs(com1DFA): improve comments for time-stepping configuration --- avaframe/com1DFA/com1DFACfg.ini | 4 ++-- docs/com1DFAAlgorithm.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/avaframe/com1DFA/com1DFACfg.ini b/avaframe/com1DFA/com1DFACfg.ini index d51a23bcc..5669d0428 100644 --- a/avaframe/com1DFA/com1DFACfg.ini +++ b/avaframe/com1DFA/com1DFACfg.ini @@ -158,9 +158,9 @@ timeStepDistance = 5 dt = 0.1 # End time [s] tEnd = 400 -# to use a variable time step (time step depends on kernel radius) +# to use a time step that is consistent with the kernel radius (i.e. time step depends on kernel radius) sphKernelRadiusTimeStepping = False -# Upper time step limit coefficient if option sphKernelRadiusTimeStepping is chosen. +# if option sphKernelRadiusTimeStepping is True, cMax and the sphKernelRadius define the computational time step cMax = 0.02 # stopCriterion (based on massFlowing or kinEnergy) stopCritType = kinEnergy diff --git a/docs/com1DFAAlgorithm.rst b/docs/com1DFAAlgorithm.rst index 4d44cbdc0..56ebb091d 100644 --- a/docs/com1DFAAlgorithm.rst +++ b/docs/com1DFAAlgorithm.rst @@ -200,8 +200,8 @@ The mass and momentum equations described in :ref:`theoryCom1DFA:Governing Equat in time using an operator splitting method. The different forces involved are sequentially added to update the velocity (see :ref:`DFAnumerics:Adding forces`). Position is then updated using a centered Euler scheme. -The time step can either be fixed or dynamically computed using the Courant–Friedrichs–Lewy (CFL) condition -(in the second case one must set ``cflTimeStepping`` to ``True`` and set the desired CFL coefficient). +The time step can either be fixed or computed to be consistent with the SPH kernel size (see +``sphKernelRadiusTimeStepping`` in the com1DFA configuration). Go back to :ref:`com1DFAAlgorithm:Algorithm graph`