Skip to content

Commit 90d7b75

Browse files
authored
Update Execution.md
1 parent b7e12c9 commit 90d7b75

1 file changed

Lines changed: 38 additions & 24 deletions

File tree

_docs_v7/Execution.md

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,20 @@ permalink: /docs_v7/Execution/
55

66
Once downloaded and installed, SU2 will be ready to run simulations and design problems. Using simple command line syntax, users can execute the individual C++ programs while specifying the problem parameters in the all-purpose configuration file. For users seeking to utilize the more advanced features of the suite (such as shape optimization or adaptive mesh refinement), Python scripts that automate more complex tasks are available. Appropriate syntax and information for running the C++ modules and python scripts can be found below.
77

8+
---
9+
10+
## Content
11+
12+
- [C++ Modules](#c-modules)
13+
- [Python Scripts](#python-scripts)
14+
- [Parallel Computation Script (parallel-computation.py)](#parallel-computation-script-parallel_computationpy)
15+
- [Continuous Adjoint Gradient Calculation (continuous_adjoint.py)](#continuous-adjoint-gradient-calculation-continuous_adjointpy)
16+
- [Discrete Adjoint Gradient Calculation (discrete_adjoint.py)](#discrete-adjoint-gradient-calculation-discrete_adjointpy)
17+
- [Finite Difference Gradient Calculation (finite_differences.py)](#finite-difference-gradient-calculation-finite_differencespy)
18+
- [Shape Optimization Script (shape_optimization.py)](#shape-optimization-script-shape_optimizationpy)
19+
20+
---
21+
822
## C++ Modules
923

1024
As described in the [Software Components](/docs_v7/Software-Components/) page, there are a number of C++ modules that are the core of the SU2 suite. After compilation, each can be executed at the command line using a Unix-based terminal (or appropriate emulator, such as Cygwin). The executables for these modules can be found in the `$SU2_HOME/<MODULE_NAME>/bin` directories and in the `$SU2_HOME/SU2_PY` directory. The configuration file specifies the problem and solver parameters for all SU2 modules and must be included at runtime.
@@ -40,10 +54,10 @@ The parallel computation script, parallel_computation.py, coordinates the steps
4054
Usage: `$ python parallel_computation.py [options]`
4155

4256
Options:
43-
* -h, --help show this help message and exit
44-
* -f FILE, --file=FILE read config from FILE
45-
* -n PARTITIONS, --partitions=PARTITIONS number of PARTITIONS
46-
* -c COMPUTE, --compute=COMPUTE COMPUTE direct and adjoint problem
57+
* `-h, --help` show help message and exit
58+
* `-f FILE, --file=FILE` read config from FILE
59+
* `-n PARTITIONS, --partitions=PARTITIONS` number of PARTITIONS
60+
* `-c COMPUTE, --compute=COMPUTE COMPUTE` direct and adjoint problem
4761

4862
### Continuous Adjoint Gradient Calculation (continuous_adjoint.py)
4963

@@ -52,11 +66,11 @@ The continuous adjoint calculation script, continuous_adjoint.py, automates the
5266
Usage: `$ python continuous_adjoint.py [options]`
5367

5468
Options:
55-
* -h, --help show this help message and exit
56-
* -f FILE, --file=FILE read config from FILE
57-
* -n PARTITIONS, --partitions=PARTITIONS number of PARTITIONS
58-
* -c COMPUTE, --compute=COMPUTE COMPUTE direct and adjoint problem
59-
* -s STEP, --step=STEP DOT finite difference STEP
69+
* `-h, --help` show help message and exit
70+
* `-f FILE, --file=FILE` read config from FILE
71+
* `-n PARTITIONS, --partitions=PARTITIONS` number of PARTITIONS
72+
* `-c COMPUTE, --compute=COMPUTE COMPUTE` direct and adjoint problem
73+
* `-s STEP, --step=STEP DOT` finite difference STEP
6074

6175
### Discrete Adjoint Gradient Calculation (discrete_adjoint.py)
6276

@@ -65,10 +79,10 @@ Similar to the continuous adjoint script, the discrete adjoint script calls SU2_
6579
Usage: `$ python discrete_adjoint.py [options]`
6680

6781
Options:
68-
* -h, --help show this help message and exit
69-
* -f FILE, --file=FILE read config from FILE
70-
* -n PARTITIONS, --partitions=PARTITIONS number of PARTITIONS
71-
* -c COMPUTE, --compute=COMPUTE COMPUTE direct and adjoint problem
82+
* `-h, --help` show help message and exit
83+
* `-f FILE, --file=FILE` read config from FILE
84+
* `-n PARTITIONS, --partitions=PARTITIONS` number of PARTITIONS
85+
* `-c COMPUTE, --compute=COMPUTE COMPUTE` direct and adjoint problem
7286

7387
### Finite Difference Gradient Calculation (finite_differences.py)
7488

@@ -77,11 +91,11 @@ The finite difference calculation script is used to calculate the gradient of an
7791
Usage: `$ python finite_differences.py [options]`
7892

7993
Options:
80-
* -h, --help show this help message and exit
81-
* -f FILE, --file=FILE read config from FILE
82-
* -n PARTITIONS, --partitions=PARTITIONS number of PARTITIONS
83-
* -s STEP, --step=STEP finite difference STEP
84-
* -q QUIET, --quiet=QUIET, if True, output QUIET to log files
94+
* `-h, --help` show help message and exit
95+
* `-f FILE, --file=FILE` read config from FILE
96+
* `-n PARTITIONS, --partitions=PARTITIONS` number of PARTITIONS
97+
* `-s STEP, --step=STEP` finite difference STEP
98+
* `-q QUIET, --quiet=QUIET` if True, output QUIET to log files
8599

86100
### Shape Optimization Script (shape_optimization.py)
87101

@@ -90,9 +104,9 @@ The shape optimization script coordinates and synchronizes the steps necessary t
90104
Usage: `$ python shape_optimization.py [options]`
91105

92106
Options:
93-
* -h, --help show this help message and exit
94-
* -f FILE, --file=FILE read config from FILE
95-
* -r NAME, --name=NAME try to restart from project file NAME
96-
* -n PARTITIONS, --partitions=PARTITIONS number of PARTITIONS
97-
* -g GRADIENT, --gradient=GRADIENT Method for computing the GRADIENT (ADJOINT, DISCRETE_ADJOINT, FINDIFF, NONE)
98-
* -q QUIET, --quiet=QUIET True/False Quiet all SU2 output (optimizer output only)
107+
* `-h, --help` show help message and exit
108+
* `-f FILE, --file=FILE` read config from FILE
109+
* `-r NAME, --name=NAME` try to restart from project file NAME
110+
* `-n PARTITIONS, --partitions=PARTITIONS` number of PARTITIONS
111+
* `-g GRADIENT, --gradient=GRADIENT` Method for computing the GRADIENT (ADJOINT, DISCRETE_ADJOINT, FINDIFF, NONE)
112+
* `-q QUIET, --quiet=QUIET` True/False Quiet all SU2 output (optimizer output only)

0 commit comments

Comments
 (0)