Too verbose debug output

@uekerman observed that the output of the OpenFOAM adapter is too verbose in general, reducing readability.

We provide a preprocessor flag ADAPTER_DEBUG_MODE to toggle the verbosity, with the goal to improve performance.

Starting time loop

---[preciceAdapter] The preciceAdapter was loaded.
---[preciceAdapter] Reading the adapter's YAML configuration file /home/makish/adapter/tutorials/CHT/flow-over-plate/buoyantPimpleFoam-laplacianFoam/Fluid/precice-adapter-config.yml...
(0) 18:49:18 [impl::SolverInterfaceImpl]:101 in configure: This is preCICE version 1.5.1
(0) 18:49:18 [impl::SolverInterfaceImpl]:102 in configure: Configuring preCICE with configuration: "precice-config.xml"
(0) 18:49:18 [impl::SolverInterfaceImpl]:145 in configure: Run in coupling mode
(0) 18:49:18 [impl::SolverInterfaceImpl]:214 in initialize: Setting up master communication to coupling partner/s
(0) 18:49:18 [impl::SolverInterfaceImpl]:219 in initialize: Masters are connected
(0) 18:49:18 [partition::ProvidedPartition]:36 in communicate: Gather mesh Fluid-Mesh
(0) 18:49:18 [partition::ProvidedPartition]:62 in communicate: Send global mesh Fluid-Mesh
(0) 18:49:18 [partition::ProvidedPartition]:79 in compute: Compute partition for mesh Fluid-Mesh
(0) 18:49:18 [impl::SolverInterfaceImpl]:223 in initialize: Setting up slaves communication to coupling partner/s
(0) 18:49:18 [impl::SolverInterfaceImpl]:228 in initialize: Slaves are connected
(0) 18:49:18 [impl::SolverInterfaceImpl]:254 in initialize: it 1 of 200 | dt# 1 | t 0 of 1 | dt 0.01 | max dt 0.01 | ongoing yes | dt complete no | write-iteration-checkpoint | 
(0) 18:49:18 [cplschemes::SerialCouplingSchemes]:109 in initializeData: initializeData is skipped since no data has to be initialized
---[preciceAdapter] preCICE was configured and initialized
---[preciceAdapter] Setting the solver's endTime to infinity to prevent early exits. Only preCICE will control the simulation's endTime. Any functionObject's end() method will be triggered by the adapter. Yo
u may disable this behavior in the adapter's configuration.
---[preciceAdapter] Setting the solver's endTime to infinity to prevent early exits. Only preCICE will control the simulation's endTime. Any functionObject's end() method will be triggered by the adapter. Yo
u may disable this behavior in the adapter's configuration.
Courant Number mean: 0.0837143 max: 0.403668
Time = 0.01

diagonal:  Solving for rho, Initial residual = 0, Final residual = 0, No Iterations 0
PIMPLE: iteration 1
DILUPBiCGStab:  Solving for Ux, Initial residual = 1, Final residual = 1.17224e-07, No Iterations 2
DILUPBiCGStab:  Solving for Uy, Initial residual = 1, Final residual = 9.27306e-07, No Iterations 2
DILUPBiCGStab:  Solving for h, Initial residual = 1, Final residual = 8.83693e-07, No Iterations 15
DICPCG:  Solving for p_rgh, Initial residual = 0.826826, Final residual = 0.00777972, No Iterations 87
diagonal:  Solving for rho, Initial residual = 0, Final residual = 0, No Iterations 0
time step continuity errors : sum local = 6.94502e-05, global = -1.44705e-07, cumulative = -1.44705e-07
DICPCG:  Solving for p_rgh, Initial residual = 0.311219, Final residual = 9.37315e-09, No Iterations 215
diagonal:  Solving for rho, Initial residual = 0, Final residual = 0, No Iterations 0
time step continuity errors : sum local = 7.66604e-10, global = -6.21739e-10, cumulative = -1.45326e-07
ExecutionTime = 0.22 s  ClockTime = 0 s

(0) 18:49:18 [impl::SolverInterfaceImpl]:378 in advance: it 2 of 200 | dt# 1 | t 0 of 1 | dt 0.01 | max dt 0.01 | ongoing yes | dt complete no | read-iteration-checkpoint | 
Courant Number mean: 0.0837143 max: 0.403668
Time = 0.01

Starting time loop

---[preciceAdapter] The preciceAdapter was loaded.
Registered objects: 
35
(
solutionControl
points
neighbour
thermo:mu
MRFProperties
thermo:psi
K
ghf
h
faces
U
rho
radiationProperties
turbulenceProperties
fvSchemes
fvOptions
faceZones
fvSolution
cumulativeContErr
p_rgh
thermophysicalProperties
dpdt
phi
owner
gh
data
cellZones
boundary
p
T
p_0
hRef
thermo:rho
pointZones
thermo:alpha
)

---[preciceAdapter] Reading the adapter's YAML configuration file /home/makish/adapter/tutorials/CHT/flow-over-plate/buoyantPimpleFoam-laplacianFoam/Fluid/precice-adapter-config.yml...
---[preciceAdapter] [DEBUG] Checking the adapter's YAML configuration file...
---[preciceAdapter] [DEBUG]   participant : Fluid
---[preciceAdapter] [DEBUG]   precice-config-file : precice-config.xml
---[preciceAdapter] [DEBUG]   interfaces : 
---[preciceAdapter] [DEBUG]   - mesh      : Fluid-Mesh
---[preciceAdapter] [DEBUG]     locations : faceCenters
---[preciceAdapter] [DEBUG]     Provide mesh connectivity : 0
---[preciceAdapter] [DEBUG]     patches   : 
---[preciceAdapter] [DEBUG]       interface
---[preciceAdapter] [DEBUG]     write-data : 
---[preciceAdapter] [DEBUG]       Temperature
---[preciceAdapter] [DEBUG]     read-data : 
---[preciceAdapter] [DEBUG]       Heat-Flux
---[preciceAdapter] [DEBUG]     subcycling : 1
---[preciceAdapter] [DEBUG]     prevent early exit : 1
---[preciceAdapter] [DEBUG]     evaluate boundaries : 1
---[preciceAdapter] [DEBUG]     disable checkpointing : 0
---[preciceAdapter] [DEBUG]     CHT module enabled : 1
---[preciceAdapter] [DEBUG]     FSI module enabled : 0
---[preciceAdapter] [DEBUG] Configuring the CHT module...
---[preciceAdapter] [DEBUG]     user-defined solver type : none
---[preciceAdapter] [DEBUG]     temperature field name : T
---[preciceAdapter] [DEBUG]     transportProperties name : transportProperties
---[preciceAdapter] [DEBUG]     conductivity name for basic solvers : k
---[preciceAdapter] [DEBUG]     density name for incompressible solvers : rho
---[preciceAdapter] [DEBUG]     heat capacity name for incompressible solvers : Cp
---[preciceAdapter] [DEBUG]     Prandtl number name for incompressible solvers : Pr
---[preciceAdapter] [DEBUG]     Turbulent thermal diffusivity field name for incompressible solvers : alphat
---[preciceAdapter] [DEBUG] Determining the solver type...
---[preciceAdapter] [DEBUG] Did not find the transportProperties dictionary.
---[preciceAdapter] [DEBUG] Found the turbulenceProperties dictionary.
---[preciceAdapter] [DEBUG] Found the thermophysicalProperties dictionary.
---[preciceAdapter] [DEBUG] This is a compressible flow solver, as turbulence and thermophysical properties are provided.
---[preciceAdapter] [DEBUG] Checking the timestep type (fixed vs adjustable)...
---[preciceAdapter] [DEBUG]   Timestep type: fixed.
---[preciceAdapter] [DEBUG] Creating the preCICE solver interface...
---[preciceAdapter] [DEBUG]   Number of processes: 1
---[preciceAdapter] [DEBUG]   MPI rank: 0
---[preciceAdapter] [DEBUG]   preCICE solver interface was created.
---[preciceAdapter] [DEBUG] Configuring preCICE...
(0) 18:56:17 [impl::SolverInterfaceImpl]:101 in configure: This is preCICE version 1.5.1
(0) 18:56:17 [impl::SolverInterfaceImpl]:102 in configure: Configuring preCICE with configuration: "precice-config.xml"
(0) 18:56:17 [impl::SolverInterfaceImpl]:145 in configure: Run in coupling mode
---[preciceAdapter] [DEBUG]   preCICE was configured.
---[preciceAdapter] [DEBUG] Creating interfaces...
---[preciceAdapter] [DEBUG] Number of face centres: 161
---[preciceAdapter] [DEBUG] Interface created on mesh Fluid-Mesh
---[preciceAdapter] [DEBUG] Adding coupling data writers...
---[preciceAdapter] [DEBUG] Added writer: Temperature.
---[preciceAdapter] [DEBUG] Adding coupling data readers...
---[preciceAdapter] [DEBUG] Constructed KappaEff_Compressible.
---[preciceAdapter] [DEBUG] Added reader: Heat Flux for compressible solvers.
---[preciceAdapter] [DEBUG] Initalizing the preCICE solver interface...
(0) 18:56:17 [impl::SolverInterfaceImpl]:214 in initialize: Setting up master communication to coupling partner/s
(0) 18:56:17 [impl::SolverInterfaceImpl]:219 in initialize: Masters are connected
(0) 18:56:17 [partition::ProvidedPartition]:36 in communicate: Gather mesh Fluid-Mesh
(0) 18:56:17 [partition::ProvidedPartition]:62 in communicate: Send global mesh Fluid-Mesh
(0) 18:56:17 [partition::ProvidedPartition]:79 in compute: Compute partition for mesh Fluid-Mesh
(0) 18:56:17 [impl::SolverInterfaceImpl]:223 in initialize: Setting up slaves communication to coupling partner/s
(0) 18:56:17 [impl::SolverInterfaceImpl]:228 in initialize: Slaves are connected
(0) 18:56:17 [impl::SolverInterfaceImpl]:254 in initialize: it 1 of 200 | dt# 1 | t 0 of 1 | dt 0.01 | max dt 0.01 | ongoing yes | dt complete no | write-iteration-checkpoint | 
---[preciceAdapter] [DEBUG] Initializing preCICE data...
(0) 18:56:17 [cplschemes::SerialCouplingSchemes]:109 in initializeData: initializeData is skipped since no data has to be initialized
---[preciceAdapter] preCICE was configured and initialized
---[preciceAdapter] [DEBUG] Reading coupling data...
---[preciceAdapter] [DEBUG] Creating a list of checkpointed fields...
---[preciceAdapter] [DEBUG] Collecting objects of type volScalarField... 
---[preciceAdapter] [DEBUG] Will be checkpointing dpdt
---[preciceAdapter] [DEBUG] Will be checkpointing gh
---[preciceAdapter] [DEBUG] Will be checkpointing thermo:mu
---[preciceAdapter] [DEBUG] Will be checkpointing thermo:psi
---[preciceAdapter] [DEBUG] Will be checkpointing K
---[preciceAdapter] [DEBUG] Will be checkpointing p
---[preciceAdapter] [DEBUG] Will be checkpointing T
---[preciceAdapter] [DEBUG] Will be checkpointing h
---[preciceAdapter] [DEBUG] Will be checkpointing p_0
---[preciceAdapter] [DEBUG] Will be checkpointing rho
---[preciceAdapter] [DEBUG] Will be checkpointing p_rgh
---[preciceAdapter] [DEBUG] Will be checkpointing thermo:rho
---[preciceAdapter] [DEBUG] Will be checkpointing thermo:alpha
---[preciceAdapter] [DEBUG] Collecting objects of type volVectorField... 
---[preciceAdapter] [DEBUG] Will be checkpointing U
---[preciceAdapter] [DEBUG] Collecting objects of type surfaceScalarField...
---[preciceAdapter] [DEBUG] Will be checkpointing phi
---[preciceAdapter] [DEBUG] Will be checkpointing ghf
---[preciceAdapter] [DEBUG] Collecting objects of type surfaceVectorField...
---[preciceAdapter] [DEBUG] Collecting objects of type pointScalarField...
---[preciceAdapter] [DEBUG] Collecting objects of type pointVectorField...
---[preciceAdapter] [DEBUG] Collecting objects of type volTensorField...
---[preciceAdapter] [DEBUG] Collecting objects of type surfaceTensorField...
---[preciceAdapter] [DEBUG] Collecting objects of type pointTensorField...
---[preciceAdapter] [DEBUG] Collecting objects of type volSymmTensorField...
---[preciceAdapter] [DEBUG] Writing a checkpoint...
---[preciceAdapter] [DEBUG] Stored time value t = 0.000000
---[preciceAdapter] [DEBUG] Checkpoint for time t = 0.000000 was stored.
---[preciceAdapter] [DEBUG] Adjusting the solver's timestep...
---[preciceAdapter] [DEBUG] The solver's timestep is the same as the coupling timestep.
---[preciceAdapter] Setting the solver's endTime to infinity to prevent early exits. Only preCICE will control the simulation's endTime. Any functionObject's end() method will be triggered by the adapter. You may disable this behavior in the adapter's configuration.
---[preciceAdapter] Setting the solver's endTime to infinity to prevent early exits. Only preCICE will control the simulation's endTime. Any functionObject's end() method will be triggered by the adapter. You may disable this behavior in the adapter's configuration.
Courant Number mean: 0.0837143 max: 0.403668
Time = 0.01

diagonal:  Solving for rho, Initial residual = 0, Final residual = 0, No Iterations 0
PIMPLE: iteration 1
DILUPBiCGStab:  Solving for Ux, Initial residual = 1, Final residual = 1.17224e-07, No Iterations 2
DILUPBiCGStab:  Solving for Uy, Initial residual = 1, Final residual = 9.27306e-07, No Iterations 2
DILUPBiCGStab:  Solving for h, Initial residual = 1, Final residual = 8.83693e-07, No Iterations 15
DICPCG:  Solving for p_rgh, Initial residual = 0.826826, Final residual = 0.00777972, No Iterations 87
diagonal:  Solving for rho, Initial residual = 0, Final residual = 0, No Iterations 0
time step continuity errors : sum local = 6.94502e-05, global = -1.44705e-07, cumulative = -1.44705e-07
DICPCG:  Solving for p_rgh, Initial residual = 0.311219, Final residual = 9.37315e-09, No Iterations 215
diagonal:  Solving for rho, Initial residual = 0, Final residual = 0, No Iterations 0
time step continuity errors : sum local = 7.66604e-10, global = -6.21739e-10, cumulative = -1.45326e-07
ExecutionTime = 0.22 s  ClockTime = 0 s

---[preciceAdapter] [DEBUG] Writing coupling data...
---[preciceAdapter] [DEBUG] Advancing preCICE...
(0) 18:56:17 [impl::SolverInterfaceImpl]:378 in advance: it 2 of 200 | dt# 1 | t 0 of 1 | dt 0.01 | max dt 0.01 | ongoing yes | dt complete no | read-iteration-checkpoint | 
---[preciceAdapter] [DEBUG] Reading a checkpoint...
---[preciceAdapter] [DEBUG] Reloaded time value t = 0.000000
---[preciceAdapter] [DEBUG] Evaluating the volVector boundary conditions for U
---[preciceAdapter] [DEBUG] Checkpoint was read. Time = 0.000000
---[preciceAdapter] [DEBUG] Reading coupling data...
---[preciceAdapter] [DEBUG] Adjusting the solver's timestep...
---[preciceAdapter] [DEBUG] The solver's timestep is the same as the coupling timestep.
Courant Number mean: 0.0837143 max: 0.403668
Time = 0.01

Both are with filter="%Severity% > debug" in the preCICE configuration and OpenFOAM built in debug mode. Note that we also use ---[preciceAdapter] to signify the adapter's output.

Questions:

1. What could we do to further improve the readability of the output?
2. Could we redirect some of the output to the file? (do we want to?)
3. Would an additional runtime verbosity switch make sense? This way, we would improve the readability, but still affect the performance.