Add developer guides and generate reference pages from the code

SU2_CFD/flamelet_python_bc.md

@@ -2,7 +2,7 @@
 
 This document explains how to use the Python wrapper (`pysu2`) to set
 custom per-vertex boundary conditions for the flamelet (FGM) scalar transport
-solver, and how the setup differs between the two `FLAMELET_ENTHALPY_BC` modes.
+solver, and how the setup differs between the two `FLAME_ENTHALPY_BC` modes.
 
 ---
 
@@ -20,15 +20,15 @@ The flamelet solver transports `nVar` scalar variables. Their order is:
 Two modes control how the enthalpy boundary condition is derived at thermal
 walls (`MARKER_ISOTHERMAL`, `MARKER_HEATFLUX`):
 
-- **`FLOW_MARKERS`** — enthalpy is derived from the flow thermal field (wall
+- **`FLOW_MARKERS`** (default) — enthalpy is derived from the flow thermal field (wall
   temperature via `MARKER_ISOTHERMAL`, or wall heat flux via `MARKER_HEATFLUX`).
-- **`SPECIES_MARKERS`** (default) — enthalpy and all other scalars are taken
+- **`SPECIES_MARKERS`** — enthalpy and all other scalars are taken
   directly from `MARKER_WALL_SPECIES`, or from the Python wrapper when
   `MARKER_PYTHON_CUSTOM` is active.
 
 ---
 
-## Mode 1: `FLAMELET_ENTHALPY_BC = FLOW_MARKERS`
+## Mode 1: `FLAME_ENTHALPY_BC = FLOW_MARKERS` (default)
 
 ### How it works
 
@@ -57,7 +57,7 @@ driver.SetMarkerCustomNormalHeatFlux(iMarker, iVertex, q_wall)
 ### config.cfg
 
 ```cfg
-FLAMELET_ENTHALPY_BC = FLOW_MARKERS
+FLAME_ENTHALPY_BC = FLOW_MARKERS
 
 % Flow solver wall BC — sets KindBC and provides the fallback heat flux value
 % used when MARKER_PYTHON_CUSTOM is not active.
@@ -103,7 +103,7 @@ driver.Finalize()
 
 ---
 
-## Mode 2: `FLAMELET_ENTHALPY_BC = SPECIES_MARKERS` (default)
+## Mode 2: `FLAME_ENTHALPY_BC = SPECIES_MARKERS`
 
 ### How it works
 
@@ -129,7 +129,7 @@ Adjust the number of `BC_TYPE, value` pairs to match the actual number of
 scalar variables in your setup.
 
 ```cfg
-FLAMELET_ENTHALPY_BC = SPECIES_MARKERS
+FLAME_ENTHALPY_BC = SPECIES_MARKERS
 
 % Flow solver wall BC — still required to set KindBC.
 % The choice between MARKER_ISOTHERMAL and MARKER_HEATFLUX only affects
@@ -222,4 +222,4 @@ driver.Finalize()
   should receive `0.0` unless you intentionally want a non-zero flux there.
 - The `CHT` (conjugate heat transfer) path (`BC_ConjugateHeat_Interface`)
   always uses `BC_Isothermal_Wall_Generic` and is unaffected by
-  `FLAMELET_ENTHALPY_BC`. Python custom BCs are not applicable to CHT markers.
+  `FLAME_ENTHALPY_BC`. Python custom BCs are not applicable to CHT markers.

config_template.cfg

@@ -424,8 +424,8 @@ ITER_DCL_DALPHA= 500
 % Evaluate the dOF_dCL or dOF_dCMy during run time
 EVAL_DOF_DCX= NO
 %
-% Damping factor for thrust BC (actuator disk).
-NETTHRUST_DBCTHRUST= 1.0
+% Estimate of dNetThrust/dBCThrust used in the actuator-disk thrust update.
+DNETTHRUST_DBCTHRUST= 1.0
 %
 % parameter for the definition of a complex objective function
 DCD_DCL_VALUE= 0.0
@@ -677,8 +677,8 @@ MOVE_MOTION_ORIGIN = 0
 %
 % See doi: 10.2514/1.J055172
 %
-% Evaluate buffet sensor on Navier-Stokes markers  (NO, YES)
-BUFFET_MONITORING= NO
+% The compressible viscous solver evaluates the sensor during force evaluation.
+% Request BUFFET in HISTORY_OUTPUT/SCREEN_OUTPUT to monitor its integral.
 %
 % Sharpness coefficient for the buffet sensor Heaviside function
 BUFFET_K= 10.0
@@ -878,9 +878,6 @@ HB_PRECONDITION= NO
 % Omega_HB = 2*PI*frequency - frequencies for Harmonic Balance method
 OMEGA_HB= (0,1.0,-1.0)
 %
-% Determines if the single-zone driver is used. (deprecated)
-SINGLEZONE_DRIVER= NO
-%
 % Determines if the special output is written out
 SPECIAL_OUTPUT= NO
 
@@ -1060,7 +1057,7 @@ CONTROLLING_VARIABLE_SOURCE_NAMES= (ProdRateTot_PV, NULL)
 % Method used to ignite the solution:
 % FLAME_FRONT : the flame is initialized using a plane, defined by a point and a normal. On one side, the solution is initialized
 % using 'burnt' conditions and on the other side 'unburnt' conditions. The normal points in the direction of the 'burnt'
-% condition. The 'burnt' condition is defined as the value of the progress variable for which the temperature exceeds the IGNITION_TEMPERATURE.
+% condition. The 'burnt' condition is defined as the value of the progress variable for which the temperature exceeds the FLAME_INIT_IGNITION.
 % SPARK : the solution is ignited through application of a set of source terms within a specified region for a set number
 % of solver iterations. This artificial spark can be applied after a certain number of iterations has passed, allowing for
 % the flow to evolve before igniting the mixture.
@@ -1118,7 +1115,7 @@ THICKENED_FLAME_CORRECTION= YES
 
 % Flame ignition temperature
 % Flame thickness calculations are performed when the maximum temperature in the flow solution exceeds this value.
-IGNITION_TEMPERATURE= 1100.0
+FLAME_INIT_IGNITION= 1100.0
 
 %
 % --------------------- INVERSE DESIGN SIMULATION -----------------------------%
@@ -1865,11 +1862,6 @@ MG_STARTUP_STAGNATION= 0.99
 % 0 disables the criterion, as MG_STARTUP_STAGNATION= 0 does (default 5).
 MG_STARTUP_STAGNATION_ITER= 5
 
-% -------------------------- MESH SMOOTHING -----------------------------%
-%
-% Before each computation, implicitly smooth the nodal coordinates
-SMOOTH_GEOMETRY= 0
-
 % -------------------- FLOW NUMERICAL METHOD DEFINITION -----------------------%
 %
 % Convective numerical method (JST, JST_KE, JST_MAT, LAX-FRIEDRICH, ROE, AUSM,
@@ -2157,8 +2149,9 @@ USE_ACCURATE_TURB_JACOBIANS= NO
 %
 % --------------------- HEAT NUMERICAL METHOD DEFINITION ----------------------%
 %
-% Value of the thermal diffusivity
-THERMAL_DIFFUSIVITY= 1.0
+% For a standalone HEAT_EQUATION solid, thermal diffusivity is computed as
+% THERMAL_CONDUCTIVITY_CONSTANT / (MATERIAL_DENSITY * SPECIFIC_HEAT_CP).
+% Set those material properties in the solid configuration.
 %
 % Convective numerical method for the heat equation (only SCALAR_UPWIND)
 CONV_NUM_METHOD_HEAT= SCALAR_UPWIND
@@ -2336,7 +2329,7 @@ DV_UNORDERED_SENS_FILENAME= unordered_sensitivity.dat
 HOLD_GRID_FIXED= NO
 %
 % Coordinates of the box where the grid will be deformed (Xmin, Ymin, Zmin, Xmax, Ymax, Zmax)
-HOLD_GRID_FIXED_COORDS= (-1e15, -1e15, -1e15, 1e15, 1e15, 1e15)
+HOLD_GRID_FIXED_COORD= (-1e15, -1e15, -1e15, 1e15, 1e15, 1e15)
 %
 % Design variable for FEA problems
 % options: NONE, YOUNG_MODULUS, POISSON_RATIO, DENSITY, DEAD_WEIGHT, ELECTRIC_FIELD
@@ -2406,7 +2399,7 @@ DEFORM_LIMIT = 1E6
 DEFORM_ELASTICITY_MODULUS= 2e11
 %
 % Poisson ratio for constant stiffness FEA method of grid deformation
-DEFORM_POISSON_RATIO= 0.3
+DEFORM_POISSONS_RATIO= 0.3
 %
 % Size of the layer of highest stiffness for wall distance-based mesh stiffness
 DEFORM_STIFF_LAYER_SIZE= 0.0