SU2

https://github.com/su2code/su2
Admin
Open-source CFD code for numerical solution of PDEs with applications in computational fluid...
Tokens:254,190
Snippets:1,353
Trust Score:9.4
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Configure SU2 with MPI, CGNS, TecIO, and optimization

Source: https://github.com/su2code/su2/wiki/Build-from-Source

Example configure command for parallel calculations with ParMETIS and MPI, plus CGNS and TecIO support (both enabled by default) and high compiler optimization. Replace paths with system-specific values. Note that the --prefix destination must be writable when installing.

```bash
$ ./configure --prefix=/path/to/install/SU2 --enable-mpi --with-cc=/path/to/mpicc 
--with-cxx=/path/to/mpicxx CXXFLAGS="-O3"
```

--------------------------------

### Install SU2 with make install

Source: https://github.com/su2code/su2/wiki/Build-from-Source

Run 'make install' to copy programs and Python scripts to the prefix folder (default /usr/local/bin). Requires write access to the destination.

```bash
$ make install
```

--------------------------------

### Build example with make on Linux

Source: https://github.com/su2code/su2/blob/master/externals/tecio/examples/readme.txt

Run 'make' in the example folder to build the application. Edit the Makefile to change targets; not all examples support the MPI tecio library. If building against a source-built tecio/teciompi library, see base.make in this folder.

```makefile
make <cr>
```

--------------------------------

### szcombine example command

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Example command that executes szcombine with the base file name myfile.szplt, combining the temporary files into a .szplt file.

```text
szcombine myfile.szplt
```

--------------------------------

### Basic SU2 Build and Install Commands

Source: https://github.com/su2code/su2/wiki/Simple-Build

Run these commands in a terminal after extracting the SU2 source code to compile the most basic version (single-threaded, no optional features). The --prefix option sets the installation location; if omitted, the code installs to /usr/local/bin, which may require admin access.

```bash
$ cd /path/to/your/SU2/
$ ./configure --prefix=/path/to/install/SU2
$ make
$ make install
```

--------------------------------

### Build and install SU2 with ninja

Source: https://github.com/su2code/su2/blob/master/README.md

Compiles and installs SU2 using ninja after the build configuration has been set up. This command builds and installs the binaries and Python scripts.

```bash
./ninja -C build install
```

--------------------------------

### Install SWIG on Linux with apt-get

Source: https://github.com/su2code/su2/wiki/Python-Wrapper-Build

Install SWIG on Linux using the APT package manager.

```bash
sudo apt-get install swig
```

--------------------------------

### Configure and install SU2 with MPI support

Source: https://github.com/su2code/su2/wiki/Parallel-Build

Commands to build SU2 for parallel execution. Requires MPI (mpicc/mpicxx) and optionally ParMETIS (shipped with source). The --prefix option sets install location; -j 8 compiles with 8 cores.

```bash
$ cd /path/to/SU2
$ ./configure --prefix=/path/to/install/SU2 CXXFLAGS="-O3" --enable-mpi 
--with-cc=/path/to/mpicc --with-cxx=/path/to/mpicxx
$ make -j 8 install
```

--------------------------------

### Install Xcode developer tools on Mac

Source: https://github.com/su2code/su2/wiki/Build-from-Source

If gcc, make, etc. are not found after installing Xcode, run this command to install the remaining developer tools.

```bash
xcode-select --install
```

--------------------------------

### Stage files with git add

Source: https://github.com/su2code/su2/wiki/Developing-SU2-on-GitHub-(Internal-Developers)

Add files to the staging area before committing. The example stages 'file1.cpp' and 'file2.cpp'.

```bash
git add file1.cpp file2.cpp
```

--------------------------------

### Polygonal Example: Initialize data file (Step 1) - TECINI142 call

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

This snippet shows the call to TECINI142 to initialize the data file for the polygonal example. It defines the file name, variables, scratch directory, and file format. The comment notes that only PLT format is currently supported for polygonal zones.

```C++
INTEGER4 Debug = 1;
INTEGER4 VIsDouble = 0;
INTEGER4 FileType = 0;
INTEGER4 FileFormat = 0; // 0 == PLT, 1 == SZPLT; Only PLT is currently
// supported for polygonal zones.
INTEGER4 I; /* used to check return codes */
/*
* Open the file and write the Tecplot datafile
* header information */ I = TECINI142((char*)”Octagon”, (char*)”X Y P”, /* Defines the variables for the data
* file. Each zone must contain each
* of the vars listed here. The order
* of the variables in the list is
* used to define the variable number
* (e.g. X is Variable 1). When
* referring to variables in other
* TecIO functions, you will refer to
* thevariable by its number. */ (char*)”Octagon.plt”, (char*)”.”, /* scratch directory */ &FileFormat, &FileType, &Debug, &VIsDouble);
```

--------------------------------

### Set GKlib installation prefix: make config prefix=~/local

Source: https://github.com/su2code/su2/blob/master/externals/metis/GKlib/BUILD.txt

Configures the installation prefix to ~/local, causing GKlib to be installed into that tree when 'make install' is run.

```shell
$ make config prefix=~/local
```

--------------------------------

### Run SU2_CFD with default.cfg

Source: https://github.com/su2code/su2/wiki/Execution

Example of running the SU2_CFD solver with a configuration file named default.cfg, both located in the current working directory.

```bash
$ ./SU2_CFD default.cfg
```

--------------------------------

### Install SWIG on macOS with brew

Source: https://github.com/su2code/su2/wiki/Python-Wrapper-Build

Install SWIG on macOS using the Homebrew package manager.

```bash
sudo brew install swig
```

--------------------------------

### Example temporary file names for szcombine

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Example list of the six temporary files produced by passing myfile.szplt into TECINI142. These files are combined by szcombine to produce a .szplt file.

```text
myfile.szplt.szhdr myfile.szplt.szdat myfile.szplt.szaux myfile.szplt.sztxt
myfile.szplt.szgeo myfile.szplt.szlab
```

--------------------------------

### Configure SU2 with --enable-PY_WRAPPER

Source: https://github.com/su2code/su2/wiki/Python-Wrapper-Build

Configure a parallel SU2 build with the Python wrapper enabled, installing to the given prefix. Requires SWIG and, for parallel builds, MPI bindings for Python (e.g., mpi4py).

```bash
./configure --prefix=/path/to/install/SU2 CXXFLAGS="-O3" --enable-mpi 
      --with-cc=/path/to/mpicc --with-cxx=/path/to/mpicxx --enable-PY_WRAPPER
```

--------------------------------

### Install mpi4py on macOS with pip

Source: https://github.com/su2code/su2/wiki/Python-Wrapper-Build

Install mpi4py on macOS using Python pip after installing pip with easy_install.

```bash
sudo easy_install pip
sudo pip install mpi4py
```

--------------------------------

### Create IJ-ordered zone with TECZNE142 and TECDAT142

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

This example demonstrates creating two IJ-ordered zones (Ordered Zone and Ordered Zone2) using TECZNE142 and writing data with TECDAT142. It initializes the file with TECINI142 and ends with TECEND142.

```C
#include "TECIO.h"
#include "MASTER.h" /* for defintion of NULL */
int main()
{
INTEGER4 Debug = 1;
INTEGER4 VIsDouble = 0;
INTEGER4 FileType = 0;
INTEGER4 FileFormat = 0; // 0 == PLT, 1 == SZPLT
INTEGER4 I = 0; /* Used to track return codes */
/*
I = TECINI142((char*)"IJ Ordered Zones", /* Name of the entire
dataset. */ (char*)"X Y P", /* Defines the variables for the data
file. Each zone must contain each of
the variables listed here. The order
of the variables in the list is used
to define the variable number (e.g.
X is Var 1). */ (char*)"ij_ordered.plt", (char*)".", /* Scratch Directory */
&FileFormat,
&FileType,
&Debug,
&VIsDouble);
float X1[4];
float Y1[4];
float P1[4];
float X2[4];
float Y2[4];
float P2[4];
INTEGER4 ICellMax = 0;
INTEGER4 JCellMax = 0;
INTEGER4 KCellMax = 0;
INTEGER4 DIsDouble = 0;
double SolTime = 360.0;
INTEGER4 StrandID = 0; /* StaticZone */
INTEGER4 ParentZn = 0;
INTEGER4 IsBlock = 1; /* Block */
INTEGER4 NFConns = 0;
INTEGER4 FNMode = 0;
INTEGER4 TotalNumFaceNodes = 1;
INTEGER4 TotalNumBndryFaces = 1;
INTEGER4 TotalNumBndryConnections = 1;
INTEGER4 ShrConn = 0;
/*Ordered Zone Parameters*/
INTEGER4 IMax = 2;
INTEGER4 JMax = 2;
INTEGER4 KMax = 1;
X1[0] = .125;
Y1[0] = .5;
P1[0] = 5;
X1[1] = .625;
Y1[1] = .5;
P1[1] = 7.5;
X1[2] = .125;
Y1[2] = .875;
P1[2] = 10;
X1[3] = .625;
Y1[3] = .875;
P1[3] = 7.5;
X2[0] = .375;
Y2[0] = .125;
P2[0] = 5;
X2[1] = .875;
Y2[1] = .125;
P2[1] = 7.5;
X2[2] = .375;
Y2[2] = .5;
P2[2] = 10;
X2[3] = .875;
Y2[3] = .5;
P2[3] = 7.5;
/* Ordered Zone */
INTEGER4 ZoneType = 0;
I = TECZNE142((char*)"Ordered Zone",
&ZoneType,
&IMax,
&JMax,
&KMax,
&ICellMax,
&JCellMax,
&KCellMax,
&SolTime,
&StrandID,
&ParentZn,
&IsBlock,
&NFConns,
&FNMode,
&TotalNumFaceNodes,
&TotalNumBndryFaces,
&TotalNumBndryConnections,
NULL,
NULL,
NULL,
&ShrConn);
INTEGER4 III = IMax * JMax * KMax;
I = TECDAT142(&III, X1, &DIsDouble);
I = TECDAT142(&III, Y1, &DIsDouble);
I = TECDAT142(&III, P1, &DIsDouble);
I = TECZNE142((char*)"Ordered Zone2",
&ZoneType,
&IMax,
&JMax,
&KMax,
&ICellMax,
&JCellMax,
&KCellMax,
&SolTime,
&StrandID,
&ParentZn,
&IsBlock,
&NFConns,
&FNMode,
&TotalNumFaceNodes,
&TotalNumBndryFaces,
&TotalNumBndryConnections,
NULL,
NULL,
NULL,
&ShrConn);
I = TECDAT142(&III, X2, &DIsDouble);
I = TECDAT142(&III, Y2, &DIsDouble);
I = TECDAT142(&III, P2, &DIsDouble);
I = TECEND142();
return 0;
}
```

--------------------------------

### Install mpi4py on Linux with pip

Source: https://github.com/su2code/su2/wiki/Python-Wrapper-Build

Install mpi4py on Linux using Python pip after ensuring a working MPI distribution.

```bash
sudo apt-get install python-pip
sudo pip install mpi4py
```

--------------------------------

### IJK-Ordered Data in BLOCK Format

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Example data file for an IJK-ordered zone with 3x2x2 points and 4 variables (X, Y, Z, Temp) in BLOCK format. Each column corresponds to a data point, each row to a variable.

```text
VARIABLES = "X" "Y" "Z" "Temp"
ZONE I=3, J=2, K=2, DATAPACKING=BLOCK
0 3 6 0 3 6 0 3 6 0 3 6
0 0 0 6 6 6 0 0 0 6 6 6
0 1 3 3 4 6 8 9 11 11 12 14
0 5 10 10 41 72 0 29 66 66 130 169
```

--------------------------------

### Delete Zone 1 (Step 2)

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Deletes the zone with handle P_Z1. This is part of the polyface zone example setup.

```C++
delete P_Z1;
```

--------------------------------

### I-Ordered Data in BLOCK Format

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Example data file for an I-ordered zone with 5 points and 2 variables (X, Y) in BLOCK format. Each column corresponds to a data point, each row to a variable.

```text
VARIABLES = "X", "Y"
ZONE I=5, DATAPACKING=BLOCK
2 3 5 6 7
4 9 25 36 49
```

--------------------------------

### IJ-Ordered Data in BLOCK Format

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Example data file for an IJ-ordered zone with 2x3 points and 4 variables (X, Y, Temperature, Pressure) in BLOCK format. Each column corresponds to a data point, each row to a variable.

```text
VARIABLES = "X", "Y", "Temperature", "Pressure"
ZONE I=2, J=3, DATAPACKING=BLOCK
3 7 2 6 1 5
0 2 4 6 8 9
0 0 1 0 1 1
50 43 42 37 30 21
```

--------------------------------

### Configure SU2 without AD (baseline)

Source: https://github.com/su2code/su2/wiki/AD-Build

Standard configure command for a parallel build with MPI and optimization flags. This is the starting point before enabling AD.

```bash
./configure --enable-mpi --prefix=$SU2_INSTALLPATH CXXFLAGS="-O3 -Wall"
```

--------------------------------

### Initialize Data File with TECINI142 for Multiple Polygonal Zones

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Initializes and opens a binary data file for the multiple polygonal zones example. Sets the file format to PLT (0) and file type to 0, with debug level 1. The variables X, Y, and P are defined in order, making X variable 1, Y variable 2, and P variable 3. The scratch directory is set to ".".

```c
INTEGER4 I; /* use to check return values */
INTEGER4 Debug = 1;
INTEGER4 VIsDouble = 0;
INTEGER4 FileType = 0;
INTEGER4 FileFormat = 0; // 0 == PLT, 1 == SZPLT
I = TECINI142((char*)"Example: Multiple polygonal zones",
(char*)"X Y P", /* Defines the variables for the data
file.
* Each zone must contain each of the vars
* listed here. The order of the variables
* in the list is used to define the
* variable number (e.g. X is Variable 1).
* When referring to variables in other
* TecIO functions, you will refer to the
* variable by its number. */ (char*)"HexagonsAndOctagon.plt", (char*)".", /* scratch directory */ &FileFormat, &FileType, &Debug,
```

--------------------------------

### Run SU2_CFD in parallel with MPI

Source: https://github.com/su2code/su2/wiki/Execution

Example of running the CFD solver on 8 cores using mpirun. Depending on the MPI implementation, you may need to use a different launcher such as mpiexec.

```bash
$ mpirun -n 8 SU2_CFD default.cfg
```

--------------------------------

### Build with CMake on Linux/macOS

Source: https://github.com/su2code/su2/blob/master/externals/tecio/teciosrc/readme.txt

Run these commands in the teciosrc directory to build the library using CMake. Requires cmake and Boost installed.

```bash
cmake .
make
```

--------------------------------

### Run SU2_CFD for direct Euler simulation

Source: https://github.com/su2code/su2/wiki/Quick-Start

Run the SU2_CFD executable with the configuration file inv_NACA0012.cfg. If the $SU2_RUN environment variable is not set, use the relative path ../bin/SU2_CFD from the QuickStart directory.

```bash
SU2_CFD inv_NACA0012.cfg
```

```bash
../bin/SU2_CFD inv_NACA0012.cfg
```

--------------------------------

### Create a single polyhedral cell with TecIO (C)

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

This C example creates a single pyramidal cell with four triangular faces and one rectangular face using the TecIO library. It calls TECINI142, TECZNE142, and TECDAT142 to write the zone, then defines face node counts and face nodes, and finally sets right/left elements for each face. The example uses a static zone with block format and double precision data.

```C
#include "TECIO.h"
#include "MASTER.h" /* for defintion of NULL */
int main()
{
/* Call TECINI142 */
INTEGER4 FileType = 0; /* 0 for full file */
INTEGER4 FileFormat = 0; // 0 == PLT, 1 == SZPLT; Only PLT is
currently
// supported for polyhedral zones
INTEGER4 Debug = 0;
INTEGER4 VIsDouble = 1;
INTEGER4 I = 0; /* use to check return codes */
I = TECINI142((char*)"Pyramid", /* Data Set Title */
(char*)"X Y Z", /* Variable List */
(char*)"pyramid.plt", /* File Name */
(char*)".", /* Scratch Directory */
&FileFormat,
&(FileType),
&(Debug),
&(VIsDouble));
/* Call TECZNE142 */
INTEGER4 ZoneType = 7; /* 7 for FEPolyhedron */
INTEGER4 NumNodes = 5; /* number of unique nodes */
INTEGER4 NumElems = 1; /* number of elements */
INTEGER4 NumFaces = 5; /* number of unique faces */
INTEGER4 ICellMax = 0; /* Not Used, set to zero */
INTEGER4 JCellMax = 0; /* Not Used, set to zero */
INTEGER4 KCellMax = 0; /* Not Used, set to zero */
double SolTime = 12.65; /* solution time */
INTEGER4 StrandID = 0; /* static zone */
INTEGER4 ParentZone = 0; /* no parent zone */
INTEGER4 IsBlock = 1; /* block format */
INTEGER4 NFConns = 0; /* not used for FEPolyhedron
``` <u>INTEGER4 NumBConns = 0; /* No Boundary Connections */</u>
101

* The FaceNodes array is used to indicate which nodes define
* which face. As mentioned earlier, the number of the nodes is
```
INTEGER4 NumBItems = 0; /* No Boundary Items */
I = TECZNE142((char*)"Polyhedral Zone (Octahedron)",
&ZoneType,
&NumNodes,
&NumElems,
&NumFaces,
&ICellMax,
&JCellMax,
&KCellMax,
&SolTime,
&StrandID,
&ParentZone,
&IsBlock,
&NFConns,
&FNMode,
&NumFaceNodes,
&NumBConns,
&NumBItems,
PassiveVarArray,
ValueLocArray,
VarShareArray,
&ShrConn);
/* Initialize arrays of nodal data */
double *X = new double[NumNodes];
double *Y = new double[NumNodes];
double *Z = new double[NumNodes];
X[0] = 0;
Y[0] = 0;
Z[0] = 0;
X[1] = 1;
Y[1] = 1;
Z[1] = 2;
X[2] = 2;
Y[2] = 0;
Z[2] = 0;
X[3] = 2;
Y[3] = 2;
Z[3] = 0;
X[4] = 0;
Y[4] = 2;
Z[4] = 0;
/* Write the data (using TECDAT142) */
INTEGER4 DIsDouble = 1; /* One for double precision */
I = TECDAT142(&NumNodes, X, &DIsDouble);
I = TECDAT142(&NumNodes, Y, &DIsDouble);
I = TECDAT142(&NumNodes, Z, &DIsDouble);
delete X;
delete Y;
delete Z;
/* Define the Face Nodes.
*
```
* implicitly defined by the order in which the nodal data is
102

*Examples*

* provided. The first value of each nodal variable describes
* node 1, the second value describes node 2, and so on. *
* The face numbering is implicitly defined. Because there are
* two nodes in each face, the first two nodes provided define
* face 1, the next two define face 2 and so on. If there was
* a variable number of nodes used to define the faces, the
* array would be more complicated. */ INTEGER4 *FaceNodeCounts = new INTEGER4[NumFaces]; /* The first four faces are triangular, i.e. have three nodes.
* The fifth face is rectangular, i.e. has four nodes. */ FaceNodeCounts[0] = 3; FaceNodeCounts[1] = 3; FaceNodeCounts[2] = 3; FaceNodeCounts[3] = 3; FaceNodeCounts[4] = 4; INTEGER4 *FaceNodes = new INTEGER4[NumFaceNodes]; /* Face Nodes for Face 1 */ FaceNodes[0] = 1; FaceNodes[1] = 2; FaceNodes[2] = 3; /* Face Nodes for Face 2 */ FaceNodes[3] = 3; FaceNodes[4] = 2; FaceNodes[5] = 4; /* Face Nodes for Face 3 */ FaceNodes[6] = 5; FaceNodes[7] = 2; FaceNodes[8] = 4; /* Face Nodes for Face 4 */ FaceNodes[9] = 1; FaceNodes[10] = 2; FaceNodes[11] = 5; /* Face Nodes for Face 5 */ FaceNodes[12] = 1; FaceNodes[13] = 5; FaceNodes[14] = 4; FaceNodes[15] = 3; /* Define the right and left elements of each face. *
* The last step for writing out the polyhedral data is to
* define the right and left neighboring elements for each
* face. The neighboring elements can be determined using the
* right-hand rule. For each face, place your right-hand along
* the face which your fingers pointing the direction of
* incrementing node numbers (i.e. from node 1 to node 2).
* Your right thumb will point towards the right element; the
* element on the other side of your hand is the left element. *
* The number zero is used to indicate that there isn't an
* element on that side of the face. *
* Because of the way we numbered the nodes and faces, the
* right element for every face is the element itself
* (element 1) and the left element is "no-neighboring element"
<u>* (element 0).</u>
103

*/
```
```

--------------------------------

### Uninstall GKlib: make uninstall

Source: https://github.com/su2code/su2/blob/master/externals/metis/GKlib/BUILD.txt

Uninstalls GKlib. Removes the files that were installed by 'make install'.

```shell
$ make uninstall
```

--------------------------------

### TECLAB142 example: adding days of the week

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

C example that adds custom labels for the days of the week to be displayed along the x-axis. Labels are surrounded by double-quotes and separated by commas or spaces.

```C
char Labels[60] = "\"Mon\", \"Tues\",\"Wed\",\"Thurs\", \”Fri\”";
TECLAB142(&Labels[0]);
```

--------------------------------

### Step 2: Create Zone 1 - TECZNE142 call

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Initializes Zone 1 with the TECZNE142 call. The TotalNumFaceNodes parameter is set to 1 and is noted as not used for this example.

```C
INTEGER4 TotalNumFaceNodes = 1; /* Not used for

```

--------------------------------

### Polygonal Example: Create Zone 1 (Step 2) - TECZNE142 call

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

This snippet shows the call to TECZNE142 to create a zone for the polygonal example. It sets ZoneType to 6 (FEPolygon), NumNodes to 8, NumElems to 1, NumFaces to 8, and other parameters. The comment explains that for polygonal zones, the total number of face nodes is equal to twice the number of nodes because each face has exactly two nodes.

```C++
/* In this example, we will create a single octagonal cell in
* Tecplot 360’s polyhedral file format. */ INTEGER4 ZoneType = 6; /* FEPolygon */ INTEGER4 NumNodes = 8; /* Number of nodes in the octagon.*/ INTEGER4 NumElems = 1; /* Number of octagonal elements. */ INTEGER4 NumFaces = 8; /* Number of faces in the octagon.*/ INTEGER4 ICellMax = 0; /* Not Used */ INTEGER4 JCellMax = 0; /* Not Used */ INTEGER4 KCellMax = 0; /* Not Used */ double SolTime = 360.0; INTEGER4 StrandID = 0; /* Static Zone */ INTEGER4 ParentZn = 0; /* No Parent Zone */ INTEGER4 IsBlock = 1; /* Block */ INTEGER4 NFConns = 0; INTEGER4 FNMode = 0; /* For polygonal zones, the total number of face nodes is equal
* to twice the number of nodes. This is because, each face
* has exactly two nodes. */ INTEGER4 NumFaceNodes = 2 * NumNodes;
```

--------------------------------

### Create a new feature branch

Source: https://github.com/su2code/su2/wiki/Developing-SU2-on-GitHub-(Internal-Developers)

Create a new branch for making changes. The example uses the branch name 'fixquadvol'.

```bash
git checkout -b fixquadvol
```

--------------------------------

### Create Second Zone and Write Data (TECZNE142, TECDAT142)

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

This snippet shows how to create a second ordered zone and write its data. It uses the same pattern as the first zone but with different variable values. The code is part of a larger example that creates two zones in separate files.

```C
/* Create a second zone, using many of the values from the first
* zone, and write it to the second data file. */
I = TECZNE142((char*)"Ordered Zone2", &ZoneType, &IMax, &JMax, &KMax, &ICellMax, &JCellMax, &KCellMax, &SolTime, &StrandID, &ParentZn, &IsBlock, &NFConns, &FNMode, &TotalNumFaceNodes, &TotalNumBndryFaces, &TotalNumBndryConn, NULL, NULL, NULL, &ShrConn);
/* set the variable values for the second zone */
float X2[4];
float Y2[4];
float P2[4];
X2[0] = 0.375; Y2[0] = 0.125; P2[0] = 5;
X2[1] = 0.875; Y2[1] = 0.125; P2[1] = 7.5;
X2[2] = 0.375; Y2[2] = 0.5; P2[2] = 10;
X2[3] = 0.875; Y2[3] = 0.5; P2[3] = 7.5;
III = IMax * JMax * KMax;
I = TECDAT142(&III, X2, &DIsDouble);
I = TECDAT142(&III, Y2, &DIsDouble);
I = TECDAT142(&III, P2, &DIsDouble);
```

--------------------------------

### Push branch to remote

Source: https://github.com/su2code/su2/wiki/Developing-SU2-on-GitHub-(Internal-Developers)

Push the local branch to the remote repository. The example pushes the 'fixquadvol' branch to origin.

```bash
git push origin fixquadvol
```

--------------------------------

### Step 11: Specify Boundary Connections for Zone 2

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Defines the boundary connections for Zone 2 using arrays for connection counts, element numbers, and zone numbers. The example sets three boundary connections, each connected to elements in Zone 1. Uses TECPOLYBCONN142 to write the boundary connection data.

```C++
INTEGER4 FaceBndryConnectionCounts_Z2[3] = {1, 1, 1};
INTEGER4 FaceBndryConnectionElems_Z2[3] = {2, 3, 3};
INTEGER4 FaceBndryConnectionZones_Z2[3] = {1, 1, 1};
I = TECPOLYBCONN142(&TotalNumBndryFaces_Z2, FaceBndryConnectionCounts_Z2, FaceBndryConnectionElems_Z2, FaceBndryConnectionZones_Z2);
```

--------------------------------

### Triangle Data in BLOCK Format Example

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Example of triangle element type finite element data with two variables (X, Y) and five data points. Each column of the data section corresponds to a node and each row to a variable. The connectivity list rows correspond to triangular elements.

```text
1.0 2.0 2.5 3.5 4.0
1.0 3.0 1.0 5.0 1.0 1 2 3 3 2 4 3 5 4
```
VARIABLES = "X", "Y"
ZONE NODES=5, ELEMENTS=3, DATAPACKING=BLOCK, ZONETYPE=FETRIANGLE
```

--------------------------------

### Simple Tecplot 360 ASCII Data File Example

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

A minimal ASCII data file with a title, two variables, a single point zone, and a text record. Demonstrates the basic structure and syntax rules for ASCII data files.

```text
TITLE="Simple Data File"
VARIABLES="X" "Y"
ZONE I=4 DATAPACKING=POINT
1 1
2 1
2 2
1 2
TEXT X=10 Y=90 T="Simple Text"
```

--------------------------------

### Parallel Compilation with make -j

Source: https://github.com/su2code/su2/wiki/Simple-Build

Use the -j N option of make to compile SU2 in parallel using N cores. This example compiles with 8 cores, which can greatly reduce compilation time on multicore systems.

```bash
make -j 8 install
```

--------------------------------

### Switch Files and Add Auxiliary Data (TECFIL142, TECAUXSTR142)

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

This snippet shows how to switch between open data files using TECFIL142 and add auxiliary data with TECAUXSTR142. It is part of a larger example that creates two zones in separate files.

```C
/* Switch to the first file. */
WhichFile = 1;
I = TECFIL142(&WhichFile);
/* Create an auxiliary data value and write it to the file */
char DeformationValue[128];
strcpy(DeformationValue, "0.98");
I = TECAUXSTR142((char*)"DeformationValue",
DeformationValue);
/* Close the first file */
I = TECEND142();
/* The remaining file will become the active file. As such,
* TecFil does not need to be called again to close the second
* file. */
I = TECEND142();
return 0;
```

--------------------------------

### Polygonal-simple example: Zone header

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Header for a polygonal zone with 3 nodes, 3 faces, 1 element, and boundary connections. Tecplot Focus cannot load face-based (polygonal or polyhedral) data.

```text
Zone
ZoneType=FEPolygon
Nodes=3
Faces=3
Elements=1
NumConnectedBoundaryFaces=2
TotalNumBoundaryConnections=1
```

--------------------------------

### SU2 multi-objective optimization config with penalty function

Source: https://github.com/su2code/su2/wiki/Multi-Objective-Optimization

Shows how to add a quadratic penalty function to the objective by appending the OPT_CONSTRAINT syntax to OPT_OBJECTIVE. The example constrains DRAG to equal 0.05 with a scaling factor of 1E6. Use when you need to enforce constraints via penalty functions.

```ini
% To include quadratic penalty function: use OPT_CONSTRAINT option syntax within the OPT_OBJECTIVE list.
% ex= Objective * Scale
OPT_OBJECTIVE=AVG_TOTAL_PRESSURE*-1E-4; (DRAG = 0.05)*1E6
%
% Use combined objective within gradient evaluation: may reduce cost to compute gradients when using the adjoint formulation.
OPT_COMBINE_OBJECTIVE = YES
%
% Optimization constraint functions with scaling factors, separated by semicolons
% ex= (Objective = Value ) * Scale, use '>','<','='
OPT_CONSTRAINT= NONE
```

--------------------------------

### Configure SU2 environment variables for .bashrc

Source: https://github.com/su2code/su2/blob/master/README.md

Adds the required environment variables to the user's .bashrc file. SU2_RUN points to the installation binary directory, SU2_HOME points to the source root, and PATH and PYTHONPATH are updated to include SU2_RUN.

```bash
export SU2_RUN="your_prefix/bin"
export SU2_HOME="/path/to/SU2vX.X.X/"
export PATH=$PATH:$SU2_RUN
export PYTHONPATH=$SU2_RUN:$PYTHONPATH
```

--------------------------------

### Show configure help

Source: https://github.com/su2code/su2/wiki/Build-from-Source

Run ./configure --help to display a complete list of optional features and relevant environment variables.

```bash
$ ./configure --help
```

--------------------------------

### Create Ordered Zone and Write Data (TECZNE142, TECDAT142)

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

This snippet shows how to create an ordered zone using TECZNE142 and write variable data with TECDAT142. It sets up zone dimensions, variable arrays, and writes float data. The code is part of a larger example that creates two zones in separate files.

```C
/* Create an Ordered Zone */
I = TECZNE142((char*)"Ordered Zone", &ZoneType, &IMax, &JMax, &KMax, &ICellMax, &JCellMax, &KCellMax, &SolTime, &StrandID, &ParentZn, &IsBlock, &NFConns, &FNMode, &TotalNumFaceNodes, &TotalNumBndryFaces, &TotalNumBndryConn, NULL, NULL, NULL, &ShrConn);
/* Set the variable values for the ordered zone. */
float X1[4];
float Y1[4];
float P1[4];
X1[0] = 0.125; Y1[0] = 0.5; P1[0] = 7.5;
X1[1] = 0.625; Y1[1] = 0.5; P1[1] = 10.0;
X1[2] = 0.125; Y1[2] = 0.875; P1[2] = 5.0;
X1[3] = 0.625; Y1[3] = 0.875; P1[3] = 7.5;
INTEGER4 DIsDouble = 0; /* set DIsDouble to 0, for float
* values. */
INTEGER4 III = IMax * JMax * KMax;
I = TECDAT142(&III, X1, &DIsDouble);
I = TECDAT142(&III, Y1, &DIsDouble);
I = TECDAT142(&III, P1, &DIsDouble);
```

--------------------------------

### Run SU2 with MPI and OpenMP using PaStiX

Source: https://github.com/su2code/su2/blob/master/TestCases/pastix_support/readme.txt

Example command to run SU2_CFD with 2 MPI ranks and 8 threads each, using --map-by NUMA:PE=8 to control core/thread binding. This is needed to avoid thread binding conflicts with PaStiX/HWLOC.

```bash
mpirun -n 2 --map-by NUMA:PE=8 SU2_CFD -t 8 --thread_multiple config.cfg
```

--------------------------------

### Create Zone 1 (Step 2) - TECZNE142 call

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

This snippet shows the call to TECZNE142 to create Zone 1. It is part of a multi-zone example. The parameters include zone type, number of points, elements, faces, and other settings. The exact code is incomplete in the source, showing only the function call with a comment.

```C++
/* Call TECZNE to create Zone 1 */
I = TECZNE142((char*)”Zone 1”,
&ZoneType,
&NumPts,
&NumElems,
&NumFaces,
&ICellMax,
&JCellMax,
&KCellMax,
&SolTime,
&StrandID,
&ParentZn,
&IsBlock,
&NFConns,
&FNMode,
&TotalNumFaceNodes,
&NumConnectedBoundaryFaces,
&TotalNumBoundaryConnections,
NULL,
ValueLocation,
NULL,
&ShrConn);
```

--------------------------------

### Commit changes with descriptive message

Source: https://github.com/su2code/su2/wiki/Developing-SU2-on-GitHub-(Internal-Developers)

Commit the changes locally with a descriptive message. The example shows a multi-line commit message that explains the fix and references issue 10.

```bash
git commit -m "Fix computation of the volume for skewed quadrilateral elements.

If a 2-D quadrilateral element is sufficiently skewed, the volume approximation is not computed properly. This modifies the volume computation to use the base and height of the quadrilateral instead of the base and hypotenuse. This fixes cases where the volume was incorrectly computed to be less than zero.

Fixes issue 10."
```

--------------------------------

### Console output when reading the CGNS wedge mesh

Source: https://github.com/su2code/su2/wiki/Inviscid-Supersonic-Wedge

Example console output from SU2 when reading the supplied CGNS mesh. It shows the mesh filename, number of zones, vertices, cells, connectivity sections, and boundary markers, which can be used to verify the mesh is read correctly.

```plaintext
---------------------- Read Grid File Information -----------------------
Reading the CGNS file: mesh_wedge_inv.cgns.
CGNS file contains 1 database(s).
Database 1, Base: 1 zone(s), cell dimension of 2, physical dimension of 3.
Zone 1, dom-1: 3750 vertices, 3626 cells, 0 boundary vertices.
Reading grid coordinates.
Number of coordinate dimensions is 3.
Loading CoordinateX values into linear partitions.
Loading CoordinateY values into linear partitions.
Loading CoordinateZ values into linear partitions.
Number of connectivity sections is 5.
Loading section QuadElements of element type Quadrilateral.
Loading section inlet of element type Line.
Loading section lower of element type Line.
Loading section outlet of element type Line.
Loading section upper of element type Line.
Successfully closed the CGNS file.

Loading CGNS data into SU2 data structures.
Two dimensional problem.
3626 interior elements.
3750 grid points.
4 surface markers.
49 boundary elements in index 0 (Marker = inlet).
74 boundary elements in index 1 (Marker = lower).
49 boundary elements in index 2 (Marker = outlet).
74 boundary elements in index 3 (Marker = upper).
3626 quadrilaterals.
```

--------------------------------

### Build GKlib with OpenMP: make config openmp=ON then make

Source: https://github.com/su2code/su2/blob/master/externals/metis/GKlib/BUILD.txt

Configures GKlib with OpenMP support enabled if available, then builds it. Use 'make config' to tweak build options.

```shell
$ make config openmp=ON
$ make
```

--------------------------------

### Configure SU2 with AD using preconfigure.py

Source: https://github.com/su2code/su2/wiki/AD-Build

Command to enable AD support. Requires exporting CXXFLAGS first and running preconfigure.py instead of configure. If configure was run previously, run 'make distclean' first.

```bash
export CXXFLAGS="-O3 -Wall" && ./preconfigure.py --enable-autodiff --enable-mpi --prefix=$SU2_INSTALLPATH
```

--------------------------------

### SU2 configuration: optimization objective, constraints, and design variables

Source: https://github.com/su2code/su2/wiki/Constrained-Optimal-Shape-Design-of-a-Fixed-Wing

Defines the optimization problem: minimize drag with lift and thickness constraints. OPT_OBJECTIVE sets the objective with scaling, OPT_CONSTRAINT lists constraints with scaling factors, and DEFINITION_DV specifies FFD control point design variables. The example shows a partial list of design variables; the full list can be generated with the set_ffd_design_var.py script.

```plaintext
% --------------------- OPTIMAL SHAPE DESIGN DEFINITION -----------------------%
%
% Optimization objective function with scaling factor
% ex= Objective * Scale
OPT_OBJECTIVE= DRAG * 0.1
%
% Optimization constraint functions with scaling factors, separated by semicolons
% ex= (Objective = Value ) * Scale, use '>','<','='
OPT_CONSTRAINT= (LIFT > 0.2864) * 0.1; (MAX_THICKNESS_SEC1 > 0.0570) * 0.1; (MAX_THICKNESS_SEC2 > 0.0513) * 0.1; (MAX_THICKNESS_SEC3 > 0.0457) * 0.1; (MAX_THICKNESS_SEC4 > 0.0399) * 0.1; (MAX_THICKNESS_SEC5 > 0.0343) * 0.1
%
% Maximum number of iterations
OPT_ITERATIONS= 100
%
% Requested accuracy
OPT_ACCURACY= 1E-10
%
% Upper bound for each design variable
OPT_BOUND_UPPER= 0.3
%
% Lower bound for each design variable
OPT_BOUND_LOWER= -0.3
%
% Optimization design variables, separated by semicolons
% ex= FFD_CONTROL_POINT ( 7, Scale | Mark. List | FFD_BoxTag, i_Ind, j_Ind, k_Ind, x_Mov, y_Mov, z_Mov )
DEFINITION_DV= ( 7, 1.0 | UPPER_SIDE, LOWER_SIDE, TIP | WING, 0, 1, 0, 0.0, 0.0, 1.0 ); ( 7, 1.0 | UPPER_SIDE, LOWER_SIDE, TIP | WING, 1, 1, 0, 0.0, 0.0, 1.0 ); ...
```

--------------------------------

### Preplot command syntax

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Basic Preplot command syntax: preplot infile [outfile] [options]. If outfile is omitted, the binary file gets the same base name as infile with a .plt extension. Use '-' for standard input or output.

```text
preplot infile [outfile] [options]
```

--------------------------------

### Build with make on Linux/macOS using Makefile.linux

Source: https://github.com/su2code/su2/blob/master/externals/tecio/teciosrc/readme.txt

Use this command if cmake is not available. Replace 'iii' with the path to the Boost include directory.

```bash
make BOOST_ROOT=iii -f Makefile.linux
```

--------------------------------

### Run discrete-adjoint SU2_CFD_AD and SU2_DOT_AD

Source: https://github.com/su2code/su2/blob/master/TestCases/incomp_navierstokes/streamwise_periodic/chtPinArray_2d/README.md

After renaming/copying/symlinking restart_*.dat to solution_*.dat, run the discrete-adjoint solver and then the dot product tool with the DA config.

```bash
mpirun -n <#cores> SU2_CFD_AD DA_configMaster.cfg
```

```bash
SU2_DOT_AD DA_configMaster.cfg
```

--------------------------------

### Polygonal-simple example: Data blocks

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Data blocks for the polygonal zone: face nodes, left elements, right elements (negative indicates boundary connections), boundary connection counts, boundary connection elements, and boundary connection zones.

```text
#face nodes
1 2
2 3
3 1
#left elements
1 1 1
#right elements (negative indicates boundary connections)
0 -1 0
#boundary connection counts
1
#boundary connection elements
1
#boundary connection zones
2
```

--------------------------------

### Boundary markers section (NMARK) in .su2 format

Source: https://github.com/su2code/su2/wiki/Mesh-File

Specifies the number of markers with 'NMARK='. For each marker, a tag is given with 'MARKER_TAG=', the number of elements with 'MARKER_ELEMS=', and then the connectivity list. Each line starts with the VTK element identifier (3 for line) followed by node indices. No index is given for boundary elements.

```su2
NMARK= 4
MARKER_TAG= lower
MARKER_ELEMS= 2
3 0 1
3 1 2
MARKER_TAG= right
MARKER_ELEMS= 2
3 2 5
3 5 8
MARKER_TAG= upper
MARKER_ELEMS= 2
3 8 7
3 7 6
MARKER_TAG= left
MARKER_ELEMS= 2
3 6 3
3 3 0
```

--------------------------------

### Configure SU2 build with meson.py

Source: https://github.com/su2code/su2/blob/master/README.md

Sets up the SU2 build configuration using the meson.py script located in the root source code folder. This is the first step in building SU2 from source; it requires a C/C++ compiler and Python 3.

```bash
./meson.py setup build
```

--------------------------------

### TECZAUXSTR142 example for adding zone auxiliary data

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

Example code that adds auxiliary data to a zone. Must be called immediately after TECZNE142 for the desired zone.

```c
char CreatedByName[16] = "CreatedBy";
char CreatedByValue[16] = "My Company";
TECZAUXSTR142(&CreatedByName[0],
&CreatedByValue[0]);
```

--------------------------------

### Preplot: Equivalent commands using default extensions

Source: https://github.com/su2code/su2/blob/master/externals/tecio/360_data_format_guide.pdf

These commands are equivalent to 'preplot dset.dat dset.plt' because Preplot defaults to .dat for input and .plt for output.

```text
preplot dset
```

```text
preplot dset.dat
```
Tokens:
Raw