Skip to content

Commit f637221

Browse files
docs(airfoil): update dataset_slurm_airfoil __main__ docstring
Brings the command line argument descriptions up to date with all current arguments, including the previously undocumented -account, -type, -minutes_per_sim, -n_slurm_array, and the new --field_output flag. Adds defaults to each entry for clarity. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent a2f93d2 commit f637221

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

engibench/problems/airfoil/dataset_slurm_airfoil.py

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,21 @@ def calculate_runtime(group_size, minutes_per_sim=6):
3030
be generalized to other problems as well. It includes functions for simulation of designs.
3131
3232
Command Line Arguments:
33-
-n_designs, --num_designs: How many airfoil designs should we use?
34-
-n_flows, --num_flow_conditions: How many flow conditions should we use per design?
35-
-n_aoas, --num_angles_of_attack: How many angles of attack should we use per design & flow condition pairing?
36-
-group_size, --group_size: How many simulations should we group together on a single cpu?
37-
-n_slurm_array, --num_slurm_array: How many slurm jobs to spawn and submit via slurm arrays? Note this may be limited by the HPC system.
38-
-min_ma, --min_mach_number: Lower bound for mach number
39-
-max_ma, --max_mach_number: Upper bound for mach number
40-
-min_re, --min_reynolds_number: Lower bound for reynolds number
41-
-max_re, --max_reynolds_number: Upper bound for reynolds number
42-
-min_aoa, --min_angle_of_attack: Lower bound for angle of attack
43-
-max_aoa, --max_angle_of_attack: Upper bound for angle of attack
33+
-account, --hpc_account: HPC account allocation to charge for job submission (required)
34+
-type, --job_type: Engibench job type to submit: 'simulate' or 'optimize' (required)
35+
-n_designs, --num_designs: Number of airfoil designs to use (default: 10)
36+
-n_flows, --num_flow_conditions: Number of flow conditions (Mach, Reynolds, AoA) sampled per design via LHS (default: 1)
37+
-group_size, --group_size: Number of simulations batched within each individual SLURM job (default: 2)
38+
-minutes_per_sim, --minutes_per_simulation: Estimated runtime per simulation in minutes, used to set SLURM job walltime (default: 15)
39+
-n_slurm_array, --num_slurm_array: Maximum SLURM array size; varies by HPC system (default: 1000)
40+
-min_ma, --min_mach_number: Lower bound for Mach number sampling (default: 0.5)
41+
-max_ma, --max_mach_number: Upper bound for Mach number sampling (default: 0.9)
42+
-min_re, --min_reynolds_number: Lower bound for Reynolds number sampling (default: 1.0e6)
43+
-max_re, --max_reynolds_number: Upper bound for Reynolds number sampling (default: 2.0e7)
44+
-min_aoa, --min_angle_of_attack: Lower bound for angle of attack sampling in degrees (default: 0.0)
45+
-max_aoa, --max_angle_of_attack: Upper bound for angle of attack sampling in degrees (default: 20.0)
46+
--field_output: Flag to include surface field variables (VelocityX, VelocityY, VelocityZ,
47+
CoefPressure) in simulation output under the 'surface_fields' key (default: False)
4448
"""
4549
# Fetch command line arguments for render and simulate to know whether to run those functions
4650
parser = ArgumentParser()

0 commit comments

Comments
 (0)