Docs Check

This page is made at each build. It lists what needs work in the documentation of SU2 commit 6b54b78464.

Options named in the docs that do not exist

These names are not options of the code: the option was renamed or removed, or the name has a typo. Fix the page in the website repository.

Found: 0

Options without any description (3)

No description in Common/src/CConfig.cpp and no comment in config_template.cfg.

• Freestream Conditions: FREESTREAM_NU_FACTOR, LOWER_LIMIT_OMEGA_FACTOR
• Multizone definition: NUM_NEAREST_NEIGHBORS

Options with a description only in config_template.cfg (21)

Move or copy the text into the comment above the option in Common/src/CConfig.cpp.

• Freestream Conditions: CONDUCTIVITY_MODEL, FREESTREAM_INTERMITTENCY, FREESTREAM_TURBULENCEINTENSITY, LOWER_LIMIT_K_FACTOR, ENGINE_NU_FACTOR, ACTDISK_SECONDARY_FLOW, INITIAL_BCTHRUST, FREESTREAM_TURB2LAMVISCRATIO
• Boundary Markers: MARKER_ACTDISK, SPECIFIED_INLET_PROFILE
• Adjoint and Gradient: FIX_AZIMUTHAL_LINE
• FEA solver: TOPOL_OPTIM_OUTFILE, TOPOL_OPTIM_SIMP_EXPONENT, TOPOL_OPTIM_SIMP_MINSTIFF, TOPOL_OPTIM_FILTER_KERNEL, TOPOL_OPTIM_FILTER_RADIUS, TOPOL_OPTIM_KERNEL_PARAM, TOPOL_OPTIM_SEARCH_LIMIT, TOPOL_OPTIM_PROJECTION_TYPE, TOPOL_OPTIM_PROJECTION_PARAM
• Multizone definition: PRINT_INLET_INTERPOLATED_DATA

Options with a very short description (296)

The comment in Common/src/CConfig.cpp has 6 words or fewer.

• Problem Definition: SOLVER, MULTIZONE, MULTIZONE_SOLVER, MATH_PROBLEM, KIND_TURB_MODEL, SST_OPTIONS, SA_OPTIONS, KIND_INCOMP_SYSTEM, KIND_PB_ITER, KIND_TRANS_MODEL, LM_OPTIONS, KIND_SCALAR_MODEL, WEAKLY_COUPLED_HEAT_EQUATION, AXISYMMETRIC, ENABLE_CUDA, GRAVITY_FORCE, VORTICITY_CONFINEMENT, STREAMWISE_PERIODIC_TEMPERATURE, RESTART_SOL, WRT_RESTART_COMPACT, READ_BINARY_RESTART, SYSTEM_MEASUREMENTS
• FluidModel: FLUID_MODEL, FLUID_NAME
• Data-driven fluid model parameters: FILENAMES_INTERPOLATOR, CONFINEMENT_PARAM
• Freestream Conditions: GAS_COMPOSITION, FROZEN_MIXTURE, IONIZATION, CATALYTIC_WALL, SUPERCATALYTIC_WALL, SUPERCATALYTIC_WALL_COMPOSITION, CRITICAL_TEMPERATURE, CRITICAL_PRESSURE, CRITICAL_DENSITY, ACENTRIC_FACTOR, VISCOSITY_MODEL, MU_CONSTANT, MIXING_VISCOSITY_MODEL, THERMAL_CONDUCTIVITY_CONSTANT, FREESTREAM_PRESSURE, FREESTREAM_TEMPERATURE, INC_DENSITY_REF, INC_NONDIM, SPECIES_INIT, SPECIES_CLIPPING, SPECIES_CLIPPING_MAX, SPECIES_CLIPPING_MIN, FLAME_INIT_METHOD, SPARK_INIT, FLAME_INIT_IGNITION, DIFFUSIVITY_MODEL, FREESTREAM_VELOCITY, DCL_DALPHA, DNETTHRUST_DBCTHRUST
• Reference Conditions: REF_ORIGIN_MOMENT_X, REF_ORIGIN_MOMENT_Y, REF_ORIGIN_MOMENT_Z, SEMI_SPAN, REF_SHARP_EDGES, REF_VELOCITY, REF_VISCOSITY, REF_DIMENSIONALIZATION
• Boundary Markers: MARKER_EULER, MARKER_FAR, MARKER_SYM, MARKER_NEARFIELD, MARKER_FLUID_INTERFACE, MARKER_DEFORM_MESH, MARKER_DEFORM_MESH_SYM_PLANE, MARKER_DEFORM_MESH_INTERNAL, MARKER_ZONE_INTERFACE, MARKER_CHT_INTERFACE, MARKER_INTERNAL, MARKER_CUSTOM, MARKER_PYTHON_CUSTOM, PYTHON_CUSTOM_SOURCE, ACTDISK_TYPE, INLET_TYPE, RELATIVE_FRAME_SLIDINGPLANE, TURBOMACHINERY_KIND, TURBO_PERF_KIND, MARKER_SUPERSONIC_OUTLET, HIGHLITE_AREA, FAN_POLY_EFF, SUBSONIC_ENGINE, ACTDISK_DOUBLE_SURFACE, ACTDISK_SU2_DEF, MARKER_CLAMPED, MARKER_NORMAL_DISPL, MARKER_DAMPER, DAMP_ENGINE_INFLOW, DAMP_ENGINE_EXHAUST, ENGINE_INFLOW_TYPE, ENGINE, BUFFET_K, BUFFET_LAMBDA, NEWTON_KRYLOV, QUASI_NEWTON_NUM_SAMPLES
• Time-marching: TIME_MARCHING, CFL_NUMBER, CFL_ADAPT, EXT_ITER_OFFSET, RK_ALPHA_COEFF, HB_PRECONDITION, TIME_DISCRE_FLOW, TIME_DISCRE_FEM_FLOW, ADER_PREDICTOR, TIME_DISCRE_ADJFLOW, TIME_DISCRE_TURB, TIME_DISCRE_ADJTURB, TIME_DISCRE_SPECIES, TIME_DISCRE_FEA, TIME_DISCRE_RADIATION, TIME_DISCRE_HEAT, TIMESTEP_HEAT
• Linear solver definition: LINEAR_SOLVER_INNER, RELAXATION_FACTOR_CHT, MSW_ALPHA, ROE_KAPPA, ENTROPY_FIX_COEFF
• Convergence: CONV_FIELD, CONV_STARTITER, CONV_CAUCHY_EPS, CONV_WINDOW_CAUCHY_EPS
• Multi-grid: MGLEVEL, MG_PRE_SMOOTH, MG_POST_SMOOTH, MG_CORRECTION_SMOOTH
• Spatial Discretization: NUM_METHOD_GRAD, CONV_NUM_METHOD_FLOW, NUM_METHOD_FEM_FLOW, MUSCL_KAPPA_FLOW, MUSCL_KAPPA_ADJFLOW, MUSCL_KAPPA_TURB, SLOPE_LIMITER_TURB, CONV_NUM_METHOD_TURB, SLOPE_LIMITER_ADJTURB, MUSCL_KAPPA_SPECIES, SLOPE_LIMITER_SPECIES, CONV_NUM_METHOD_SPECIES, MUSCL_KAPPA_HEAT, SLOPE_LIMITER_HEAT, CONV_NUM_METHOD_HEAT
• Adjoint and Gradient: LIMIT_ADJFLOW, OBJECTIVE_FUNCTION, CUSTOM_OUTPUTS, GEO_BOUNDS, GEO_DESCRIPTION, GEO_WATERLINE_LOCATION, GEO_LOCATION_STATIONS, GEO_PLOT_STATIONS, SENS_SMOOTHING, FROZEN_VISC_CONT, FROZEN_VISC_DISC, FROZEN_LIMITER_DISC, REORIENT_ELEMENTS
• Sobolev Gradient Solver Parameters: SMOOTH_GRADIENT, SOBOLEV_MODE, GRAD_LINEAR_SOLVER, GRAD_LINEAR_SOLVER_PREC
• Input/output files and formats: TABULAR_FORMAT, MESH_FORMAT, MESH_FILENAME, MESH_OUT_FORMAT, PREFERENTIAL_DIFFUSION, CONV_FILENAME, BREAKDOWN_FILENAME, RESTART_FILENAME, VOLUME_FILENAME, GRAD_OBJFUNC_FILENAME, VALUE_OBJFUNC_FILENAME, WRT_AD_STATISTICS
• Dynamic mesh definition: GRID_MOVEMENT, SURFACE_MOVEMENT, MARKER_SOBOLEVBC, MOTION_ORIGIN, SURFACE_MOTION_ORIGIN
• Aeroelastic Simulation (Typical Section Model): AIRFOIL_MASS_RATIO
• Wind Gust: WIND_GUST, GUST_TYPE, GUST_WAVELENGTH, GUST_PERIODS, GUST_AMPL
• Equivalent Area: EQUIV_AREA, EA_SCALE_FACTOR
• Grid deformation: DV_KIND, DV_VALUE, DV_SENSITIVITY_FORMAT
• Deformable mesh: DEFORM_COEFF, DEFORM_LIMIT, DEFORM_LINEAR_SOLVER, DEFORM_LINEAR_SOLVER_PREC, DEFORM_KIND
• FEA solver: FEA_FILENAME, ELASTICITY_MODULUS, POISSON_RATIO, MATERIAL_DENSITY, MATERIAL_THERMAL_EXPANSION_COEFF, KNOWLES_B, KNOWLES_N, DE_EFFECTS, ELECTRIC_FIELD_CONST, ELECTRIC_FIELD_MOD, ELECTRIC_FIELD_DIR, DESIGN_VARIABLE_FEA, REFERENCE_GEOMETRY_FILENAME, REFERENCE_GEOMETRY_FORMAT, REFERENCE_NODE_DISPLACEMENT, GEOMETRIC_CONDITIONS, MATERIAL_MODEL, MATERIAL_COMPRESSIBILITY, PRESTRETCH_FILENAME, NONLINEAR_FEM_SOLUTION_METHOD, FORMULATION_ELASTICITY_2D, CENTRIFUGAL_FORCE, NEWMARK_BETA, NEWMARK_GAMMA, RAMP_LOADING, DYNAMIC_LOAD_TRANSFER, TIME_INT_STRUCT_COEFFS, INCREMENTAL_LOAD, NUMBER_INCREMENTS, INCREMENTAL_CRITERIA, PREDICTOR, PREDICTOR_ORDER, TOPOLOGY_OPTIMIZATION
• Multizone definition: RESTART_ITER, RADIAL_BASIS_FUNCTION_PARAMETER, STAT_RELAX_PARAMETER, BGS_RELAXATION, RELAXATION
• Radiation solver: RADIATION_MODEL, ABSORPTION_COEFF, SCATTERING_COEFF, HEAT_SOURCE_VAL
• Heat solver: CHT_COUPLING_METHOD
• Inverse design problem: INV_DESIGN_CP, INV_DESIGN_HEATFLUX
• FFD point inversion: FFD_FIX_I, FFD_FIX_J, FFD_FIX_K, FFD_SYMMETRY_PLANE, FFD_TOLERANCE, CONVEXITY_CHECK, FFD_DEFINITION, FFD_DEGREE
• Automatic Differentation options: DIRECT_DIFF, AUTO_DIFF, PREACC
• Python Options: GRADIENT_METHOD, GEO_PARAM, DEFINITION_DV, OPT_ITERATIONS, OPT_ACCURACY, DV_VALUE_NEW, DV_VALUE_OLD, NUMBER_PART, FIN_DIFF_STEP, OPT_GRADIENT_FACTOR, OPT_BOUND_UPPER, OPT_BOUND_LOWER, NZONES, PARMETIS_TOLERANCE, PARMETIS_POINT_WEIGHT
• Hybrid_RANSLES Options: WINDOW_START_ITER, DES_CONST, SBS_LENGTHSCALE_COEFF, SBS_TIMESCALE_COEFF, SBS_INTENSITY_COEFF, HYBRID_RANSLES, COMPUTE_AVERAGE, MULTIPOINT_MACH_NUMBER, MULTIPOINT_WEIGHT, MULTIPOINT_AOA, MULTIPOINT_SIDESLIP_ANGLE, MULTIPOINT_TARGET_CL, MULTIPOINT_REYNOLDS_NUMBER, MULTIPOINT_FREESTREAM_TEMPERATURE, MULTIPOINT_FREESTREAM_PRESSURE
• Output Options: SCREEN_OUTPUT, HISTORY_WRT_FREQ_INNER, HISTORY_WRT_FREQ_OUTER, HISTORY_WRT_FREQ_TIME, SCREEN_WRT_FREQ_INNER, SCREEN_WRT_FREQ_OUTER, SCREEN_WRT_FREQ_TIME, OUTPUT_FILES, UQ_DELTA_B, UQ_COMPONENT, UQ_URLX, UQ_PERMUTE
• libROM options: SAVE_LIBROM, LIBROM_BASE_FILENAME, BASIS_GENERATION, MAX_BASIS_DIM

Options with no example and no explanation (97)

No test case uses the option and no page of this website names it.

• Problem Definition: KIND_SGS_MODEL, KIND_FEM_DG_SHOCK, KIND_MATRIX_COLORING, VOLUME_OUTPUT_PRECISION
• Freestream Conditions: IONIZATION, VT_RESIDUAL_LIMITING, BULK_MODULUS, ACTDISK_SECONDARY_FLOW, INITIAL_BCTHRUST, UPDATE_IH, DNETTHRUST_DBCTHRUST, UPDATE_BCTHRUST
• Boundary Markers: MARKER_DEFORM_MESH_INTERNAL, RELATIVE_FRAME_SLIDINGPLANE, MARKER_SMOLUCHOWSKI_MAXWELL, FAN_POLY_EFF, SUBSONIC_ENGINE, ENGINE_HALF_MODEL, ACTDISK_SU2_DEF, DISTORTION_RACK, SUBSONIC_ENGINE_VALUES, SUBSONIC_ENGINE_CYL, MARKER_NORMAL_DISPL, MARKER_DAMPER, RAMP_AND_RELEASE_LOAD, BC_EVAL_FREQ, DAMP_ENGINE_EXHAUST, ENGINE, BUFFET_K, BUFFET_LAMBDA
• Time-marching: OUTLIER_MITIGATION_PARAM, EXT_ITER_OFFSET, TIME_DISCRE_RADIATION
• Linear solver definition: LINEAR_SOLVER_ILU_GPU_SWEEPS, LINEAR_SOLVER_PREC_THREADS
• Multi-grid: MG_SMOOTH_STAGNATION_TOL, MG_STARTUP_STAGNATION_ITER, MG_CFL_SCALING
• Spatial Discretization: CENTRAL_INC_JACOBIAN_FIX_FACTOR, MUSCL_KAPPA_ADJFLOW, MUSCL_KAPPA_SPECIES, MUSCL_KAPPA_HEAT, SLOPE_LIMITER_HEAT
• Adjoint and Gradient: DCMX_DCL_VALUE, DCMY_DCL_VALUE, DCMZ_DCL_VALUE, GEO_WATERLINE_LOCATION, GEO_NACELLE_LOCATION
• Input/output files and formats: MESH_BOX_OFFSET, MESH_BOX_POLY_SOL_FEM, MULTIZONE_RESIDUAL, VOLUME_SENS_FILENAME, COMM_LEVEL
• Deformable mesh: DEFORM_ELASTICITY_MODULUS, DEFORM_STIFF_LAYER_SIZE
• FEM flow solver definition: JACOBIAN_SPATIAL_DISCRETIZATION_ONLY, ALIGNED_BYTES_MATMUL
• FEA solver: TOTAL_DV_PENALTY, PSEUDO_STATIC, RAMP_TIME, DYNAMIC_LOAD_TRANSFER, TIME_INT_STRUCT_COEFFS, FEA_ID_DIRECTDIFF
• Multizone definition: SPECIAL_OUTPUT, INLET_INTERPOLATION_FUNCTION, INLET_INTERPOLATION_DATA_TYPE, PRINT_INLET_INTERPOLATED_DATA, AITKEN_DYN_MAX_INITIAL, AITKEN_DYN_MIN_INITIAL
• Radiation solver: HEAT_SOURCE, HEAT_SOURCE_VAL, HEAT_SOURCE_ROTATION_Z, HEAT_SOURCE_CENTER, HEAT_SOURCE_AXES
• Visualize Control Volumes: VISUALIZE_CV
• Unsupported options: EXTRA_OUTPUT, EXTRA_HEAT_ZONE_OUTPUT
• Automatic Differentation options: AUTO_DIFF, PREACC
• Python Options: GRADIENT_METHOD, GEO_PARAM, DV_VALUE_NEW, DV_VALUE_OLD, NUMBER_PART, CONSOLE, DECOMPOSED
• Hybrid_RANSLES Options: COMPUTE_AVERAGE, MULTIPOINT_OUTLET_VALUE, MULTIPOINT_MESH_FILENAME
• Output Options: EDGE_COLORING_GROUP_SIZE, EDGE_COLORING_RELAX_DISC_ADJ, RCM_NUM_SEEDS
• libROM options: SAVE_LIBROM, LIBROM_BASE_FILENAME, BASIS_GENERATION, MAX_BASIS_DIM, ROM_SAVE_FREQ

Options in config_template.cfg that do not exist

Users copy this file, so a wrong name there stops their run with an “invalid option name” error.

Found: 0

Developer pages that may be out of date

Each developer page ends with “Last checked against SU2 develop <commit>”. These pages name code files that changed since that commit. Read the changes, update the page if needed, then update the commit in its last line.

Pages to review: 10 of 15.

• Adding a Boundary Condition
  • config_template.cfg: 1 commit
• Adding a Config Option
  • Docs/website/tools/build_site.py: 13 commits
  • config_template.cfg: 1 commit
• Adding a Fluid Model
  • config_template.cfg: 1 commit
• Adding a Numerical Scheme
  • config_template.cfg: 1 commit
• Adding a Solver
  • config_template.cfg: 1 commit
• Adding a Transition Model
  • config_template.cfg: 1 commit
• Adding a Turbulence Model
  • config_template.cfg: 1 commit
• Code Structure
  • config_template.cfg: 1 commit
• Documentation Status: no “Last checked against” line
• Glossary
  • config_template.cfg: 1 commit

Code documentation coverage

This section counts the classes declared in the headers of Common/include and SU2_CFD/include. The count uses a simple text search, so the numbers are approximate. Docs/docmain.hpp asks that every class has a Doxygen comment with \brief and \ingroup.

• Classes: 452
• With a Doxygen comment: 403 (89%)
• In a Doxygen group (\ingroup): 233 (52%)

Doxygen warnings

Doxygen found 1891 problems in the code comments.