You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs_v7/Quick-Start.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,15 +62,15 @@ SU2 is capable of running the direct and adjoint problems for several sets of eq
62
62
The user can also set the format for the solution files:
63
63
```
64
64
% Output file format
65
-
OUTPUT_FORMAT= TECPLOT
65
+
OUTPUT_FILES= (RESTART, TECPLOT, SURFACE_TECPLOT)
66
66
```
67
-
SU2 can output solution files in the .vtk (ParaView), .dat (Tecplot ASCII), and .plt (Tecplot binary) formats which can be opened in the ParaView and Tecplot visualization software packages, respectively. We have set the file type to TECPLOT in this tutorial by default, but users without access to Tecplot are encouraged to download and use the freely available [ParaView](http://www.paraview.org) package. To output solution files for ParaView, set the OUTPUT_FORMAT option to PARAVIEW.
67
+
SU2 can output solution files in the .vtk (ParaView), .dat (Tecplot ASCII), and .szplt (Tecplot binary) formats which can be opened in the ParaView and Tecplot visualization software packages, respectively. We have set the file type to TECPLOT in this tutorial by, but users without access to Tecplot are encouraged to download and use the freely available [ParaView](http://www.paraview.org) package. To output solution files for ParaView, set the `OUTPUT_FILES` option to `(RESTART, PARAVIEW, SURFACE_PARAVIEW)` which is the default value if the option is not present.
68
68
69
69
### Running SU2
70
70
71
71
The first step in this tutorial is to solve the Euler equations:
72
72
1. Either navigate to the QuickStart/ directory or create a directory in which to run the tutorial. If you have created a new directory, copy the config file (inv_NACA0012.cfg) and the mesh file (mesh_NACA0012_inv.su2) to this directory.
73
-
2. Run the executable by entering "SU2_CFD inv_NACA0012.cfg" at the command line. If you have not set the $SU2_RUN environment variable you will need to run "../bin/SU2_CFD inv_NACA0012.cfg" (from the QuickStart directory) or use the appropriate path to your SU2_CFD executable at the command line.
73
+
2. Run the executable by entering `SU2_CFD inv_NACA0012.cfg` at the command line. If you have not set the $SU2_RUN environment variable you will need to run `../bin/SU2_CFD inv_NACA0012.cfg` (from the QuickStart directory) or use the appropriate path to your SU2_CFD executable at the command line.
74
74
3. SU2 will print residual updates with each iteration of the flow solver, and the simulation will finish after reaching the specified convergence criteria.
75
75
4. Files containing the flow results (with "flow" in the file name) will be written upon exiting SU2. The flow solution can be visualized in ParaView (.vtk) or Tecplot (.dat or .plt). More specifically, these files are:
76
76
-**flow.dat** or **flow.vtk** - full volume flow solution.
@@ -80,9 +80,9 @@ The first step in this tutorial is to solve the Euler equations:
80
80
-**history.dat** or **history.csv** - file containing the convergence history information.
81
81
82
82
Next, we want to run the adjoint solution to get the sensitivity of the objective function (the drag over the airfoil) to conditions within the flow:
83
-
1. Open the config file and change the parameter MATH_PROBLEM from DIRECT to CONTINUOUS_ADJOINT, and save this file.
83
+
1. Open the config file and change the parameter `MATH_PROBLEM` from `DIRECT` to `CONTINUOUS_ADJOINT`, and save this file.
84
84
2. Rename the restart file (restart_flow.dat) to "solution_flow.dat" so that the adjoint code has access to the direct flow solution.
85
-
3. Run the executable again by entering "SU2_CFD inv_NACA0012.cfg" at the command line.
85
+
3. Run the executable again by entering `SU2_CFD inv_NACA0012.cfg` at the command line.
86
86
4. SU2 will print residual updates with each iteration of the adjoint solver, and the simulation will finish after reaching the specified convergence criteria.
87
87
5. Files containing the adjoint results (with "adjoint" in the file name) will be written upon exiting SU2. The flow solution can be visualized in ParaView (.vtk) or Tecplot (.dat or .plt). More specifically, these files are:
88
88
-**adjoint.dat** or **adjoint.vtk** - full volume adjoint solution.
@@ -91,10 +91,10 @@ Next, we want to run the adjoint solution to get the sensitivity of the objectiv
91
91
-**restart_adj_cd.dat** - restart file in an internal format for restarting this simulation in SU2. Note that the name of the objective appears in the file name.
92
92
-**history.dat** or **history.csv** - file containing the convergence history information.
93
93
94
-
Note that as of SU2 v4.1, you can also compute a discrete adjoint for the Euler equations. Assuming that you have built the code with [algorithmic differentiation support](/docs_v7/AD-Build), you can run the discrete adjoint with the following steps instead:
95
-
1. Open the config file and change the parameter MATH_PROBLEM from DIRECT to DISCRETE_ADJOINT, and save this file.
94
+
Note that as of SU2 v4.1, you can also compute a discrete adjoint for the Euler equations. Assuming that you have built the code with [algorithmic differentiation support](/docs_v7/Build-SU2-From-Source/#basic-configuration), you can run the discrete adjoint with the following steps instead:
95
+
1. Open the config file and change the parameter `MATH_PROBLEM` from `DIRECT` to `DISCRETE_ADJOINT`, and save this file.
96
96
2. Rename the restart file (restart_flow.dat) to "solution_flow.dat" so that the adjoint code has access to the direct flow solution.
97
-
3. Run the executable again by entering "SU2_CFD_AD inv_NACA0012.cfg" at the command line. Note that the SU2_CFD_AD executable will only be available when the source has been compiled with AD support.
97
+
3. Run the executable again by entering `SU2_CFD_AD inv_NACA0012.cfg` at the command line. Note that the `SU2_CFD_AD` executable will only be available when the source has been compiled with AD support.
0 commit comments