Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 054aa0e

Browse files
bigfootedbigfooted
authored
Update Custom-Output.md
small update for volume_output and history_output
1 parent f39ff51 commit 054aa0e

File tree

1 file changed

+101
-38
lines changed

1 file changed

+101
-38
lines changed

‎_docs_v7/Custom-Output.md

Lines changed: 101 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,12 @@ SU2 can output the solution in several file formats. You can specify what files
4242
| Option value | Description |
4343
|---|---|
4444
| `RESTART` | Native SU2 binary restart format |
45-
| `RESTART_ASCII` | ASCII CSV restart format |
45+
| `RESTART_ASCII` | Native SU2 ASCII CSV restart format |
46+
| `STL_BINARY` | binary mesh in .stl format |
47+
| `STL_ASCII` | ASCII mesh in .stl format |
48+
| `MESH` | Native SU2 mesh in .su2 format |
4649
| `CSV` | ASCII CSV restart format (identical to `RESTART_ASCII`) |
50+
| `PARAVIEW_MULTIBLOCK` | Binary Paraview .vtm format |
4751
| `PARAVIEW` | Binary Paraview .vtk format |
4852
| `PARAVIEW_ASCII` | ASCII Paraview .vtk format |
4953
| `TECPLOT` | Binary Tecplot .szplt format |
@@ -54,44 +58,103 @@ SU2 can output the solution in several file formats. You can specify what files
5458
| `SURFACE_TECPLOT` | Surface values in binary Tecplot .szplt format (includes all markers set with `MARKER_PLOTTING`)|
5559
| `SURFACE_TECPLOT_ASCII` | Surface values in ASCII Tecplot .dat format (includes all markers set with `MARKER_PLOTTING`)|
5660

57-
The default value of `OUTPUT_FILES` is `(RESTART, PARAVIEW, SURFACE_PARAVIEW)`. The output frequency can be set by using the `OUTPUT_WRT_FREQ` option. If it is a time-dependent problem, the frequency is based on the time iterations, while for steady-state problems it is based on the outer or inner iterations, depending on whether it is a multi-zone or single-zone problem, respectively.
61+
The default value of `OUTPUT_FILES` is `(RESTART, PARAVIEW, SURFACE_PARAVIEW)`. The output frequencies can be set by using the `OUTPUT_WRT_FREQ` option. OUTPUT_WRT_FREQ accepts a list of integer values for each of the file types in `OUTPUT_FILES`. If a single value is given, this value will be used as the writing frequency for all output files. If 2 values are used, the first value is used for the first file type in OUTPUT_FILES, and the second value is used for the other file types in the list. For time-dependent problems, the frequency is based on the time iterations, while for steady-state problems it is based on the outer or inner iterations, depending on whether it is a multi-zone or single-zone problem, respectively.
5862

59-
**Note:** If run SU2 in parallel you should always use binary output files to get the best performance.
63+
**Note:** If you run SU2 in parallel you should always use binary output files to get the best performance.
6064

6165
### Setting Output Fields ###
6266

6367
The `VOLUME_OUTPUT` option can be used to set fields for the restart and visualization files. Here you have the option to specify either single fields and/or groups.
6468

69+
| Option value | Default value | Description | Data type |
70+
|---|---|---|---|
71+
| VOLUME_OUTPUT| COORDINATES,SOLUTION,PRIMITIVE| fields or groups that will be saved to file| list of keywords|
72+
73+
6574
### Example ###
6675

76+
Groups and fields can be combined, e.g.:
77+
78+
`VOLUME_OUTPUT= SOLUTION, PRESSURE, DENSITY `
79+
80+
will save all field that are in the `SOLUTION` group. Pressure is in the `PRIMITIVE` group for the compressible solver and in the `SOLUTION` group for the incompressible solver. Density on the other hand is in the `SOLUTION group for the compressible solver and in the `PRIMITIVE` group for the incompressible solver. They can be added individually as in the example above, or by simply adding the entire `PRIMITIVE` group to the list if file size is no issue. Note that keywords that are not valid for the current setup will simply be ignored.
81+
6782
For the compressible Navier-Stokes solver (i.e. `SOLVER=NAVIER_STOKES`), a **non-exhaustive list** of possible fields/groups is the following:
6883

69-
| Field Name | Description | Group Name |
84+
| Field Name | Description | Group Name | Remarks |
85+
|---|---|---|
86+
| `COORD-X` | x coordinate | `COORDINATES` | - |
87+
| `COORD-Y` | y coordinate | `COORDINATES` | - |
88+
| `COORD-Z` | z coordinate | `COORDINATES` | 3D only |
89+
| `DENSITY` | Density | `SOLUTION` | - |
90+
| `MOMENTUM-X` | Momentum x-component | `SOLUTION` | - |
91+
| `MOMENTUM-Y` | Momentum y-component | `SOLUTION` | - |
92+
| `MOMENTUM-Z` | Momentum z-component | `SOLUTION` | 3D only |
93+
| `ENERGY` | Energy | `SOLUTION` | - |
94+
| `PRESSURE` | Pressure| `PRIMITIVE` | - |
95+
| `TEMPERATURE` | Temperature | `PRIMITIVE` | - |
96+
| `MACH` | Mach Number | `PRIMITIVE` | - |
97+
| `PRESSURE_COEFF` | Pressure Coefficient | `PRIMITIVE` | - |
98+
| `LAMINAR_VISCOSITY` | Laminar viscosity | `PRIMITIVE` | - |
99+
| `SKIN_FRICTION-X` | Skin friction coefficient x-component | `PRIMITIVE` | - |
100+
| `SKIN_FRICTION-Y` | Skin friction coefficient y-component | `PRIMITIVE` | - |
101+
| `SKIN_FRICTION-Z` | Skin friction coefficient z-component | `PRIMITIVE` | 3D only |
102+
| `HEAT_FLUX` | Heat flux | `PRIMITIVE` | - |
103+
| `Y_PLUS` | Y-Plus | `PRIMITIVE` | - |
104+
105+
Additionally, for every field in the SOLUTION group, the limiters (group name `LIMITER`) and residuals (group name RESIDUAL) can be saved by adding `RES_` or `LIMITER_` in front of the field name.
106+
107+
108+
For the incompressible Navier-Stokes solver (i.e. `SOLVER=INC_NAVIER_STOKES`), the solution group is different:
109+
110+
| Field Name | Description | Group Name | Remarks |
111+
|---|---|---|
112+
| `PRESSURE` | Pressure | `SOLUTION` | - |
113+
| `VELOCITY-X` | Velocity x-component | `SOLUTION` | - |
114+
| `VELOCITY-Y` | Velocity y-component | `SOLUTION` | - |
115+
| `VELOCITY-Z` | Velocity z-component | `SOLUTION` | 3D only |
116+
| `TEMPERATURE` | Static Temperature | `SOLUTION` | `INC_ENERGY_EQUATION= YES` |
117+
| `DENSITY` | Density | `PRIMITIVE` | - |
118+
119+
120+
Turbulence quantities:
121+
122+
| Field Name | Description | Group Name | Remarks |
70123
|---|---|---|
71-
| `COORD-X` | x coordinate | `COORDINATES` |
72-
| `COORD-Y` | y coordinate | `COORDINATES` |
73-
| `COORD-Z` | z coordinate | `COORDINATES` |
74-
| `DENSITY` | Density | `SOLUTION` |
75-
| `MOMENTUM-X` | Momentum x-component | `SOLUTION` |
76-
| `MOMENTUM-Y` | Momentum y-component | `SOLUTION` |
77-
| `MOMENTUM-Z` | Momentum z-component | `SOLUTION` |
78-
| `ENERGY` | Energy | `SOLUTION` |
79-
| `PRESSURE` | Pressure| `PRIMITIVE` |
80-
| `TEMPERATURE` | Temperature | `PRIMITIVE` |
81-
| `MACH` | Mach Number | `PRIMITIVE` |
82-
| `PRESSURE_COEFF` | Pressure Coefficient | `PRIMITIVE` |
83-
| `LAMINAR_VISCOSITY` | Laminar viscosity | `PRIMITIVE` |
84-
| `SKIN_FRICTION-X` | Skin friction coefficient x-component | `PRIMITIVE` |
85-
| `SKIN_FRICTION-Y` | Skin friction coefficient y-component | `PRIMITIVE` |
86-
| `SKIN_FRICTION-Z` | Skin friction coefficient z-component | `PRIMITIVE` |
87-
| `HEAT_FLUX` | Heat flux | `PRIMITIVE` |
88-
| `Y_PLUS` | Y-Plus | `PRIMITIVE` |
124+
| `NU_TILDE` | Spalart Allmaras variable | `SOLUTION` | SA models |
125+
| `TKE` | Turbulent kinetic energy k | `SOLUTION` | SST models |
126+
| `DISSIPATION` | Turbulent dissipation rate omega | `SOLUTION` | SST models |
127+
| `EDDY_VISCOSITY` | Turbulent eddy viscosity | `PRIMITIVE` | - |
128+
129+
130+
To inspect the mesh quality we additionaly have:
131+
132+
| Field Name | Description | Group Name | Remarks |
133+
|---|---|---|
134+
| `ORTHOGONALITY` | Orthogonality angle | `MESH_QUALITY` | - |
135+
| `ASPECT_RATIO` | CV Aspect ratio | `MESH_QUALITY` | - |
136+
| `VOLUME_RATIO` | CV sub-volume ratio | `MESH_QUALITY` | - |
137+
138+
For moving grids:
139+
140+
| Field Name | Description | Group Name | Remarks |
141+
|---|---|---|
142+
| `GRID_VELOCITY-X` | X-component of grid velocity vector | `GRID_VELOCITY` | - |
143+
| `GRID_VELOCITY-Y` | Y-component of grid velocity vector | `GRID_VELOCITY` | - |
144+
| `GRID_VELOCITY-Z` | Z-component of grid velocity vector | `GRID_VELOCITY` | 3D only |
89145

90146

91147
## Customizing the Screen and History Output ##
92148

93149
### Screen Output ###
94-
You can define the output fields you want to have on screen by using the config option `SCREEN_OUTPUT`.
150+
You can define the output fields you want to have printed on screen by using the config option `SCREEN_OUTPUT`.
151+
152+
| Option value | Default value | Description | Data type | Remark |
153+
|---|---|---|---|---|
154+
| SCREEN_OUTPUT| INNER_ITER, RMS_DENSITY, RMS_MOMENTUM-X,RMS_MOMENTUM-Y, RMS_ENERGY| field or group that will be printed to screen | list of keywords| compressible |
155+
| SCREEN_OUTPUT| INNER_ITER, RMS_PRESSURE, VELOCITY-X,VELOCITY-Y| field or group that will be printed to screen | list of keywords| incompressible |
156+
157+
95158
Fields available depend on the solver you are using. Fields available for **all solvers** are the following:
96159

97160
- `TIME_ITER`: Time iteration index
@@ -110,7 +173,7 @@ You can also customize the frequency when the convergence history should be writ
110173

111174
### History Output ###
112175

113-
The history output can be customized in a similar fashion to the screen output by using the `HISTORY_OUTPUT` option. In fact, screen and history outputs share all fields which means that everything that can written to screen can be written also to the history file and vice versa. However, instead of specifying single output fields, for the history output it is **only possible** to specify output groups by using the group name.
176+
The history output can be customized in a similar fashion as the screen output by using the `HISTORY_OUTPUT` option. In fact, screen and history outputs share all fields which means that everything that can written to screen can be written also to the history file and vice versa.
114177

115178
If you run a multizone problem, in addition to the history files per zone, a file (default: `history_multizone.dat`) will be created where the convergence history of the outer iteration is stored. Groups for this output can be set by using the `HISTORY_OUTPUT` option in the main config file.
116179

@@ -129,18 +192,18 @@ For the compressible Navier-Stokes solver (i.e. `SOLVER=NAVIER_STOKES`), a **non
129192
| `TIME_STEP` | Current time step. | `TIME_DOMAIN` |
130193
| `WALL_TIME` | Current average wall-clock time for one iteration. | `WALL_TIME` |
131194
| `RMS_DENSITY` | Root-mean square residual of the density. | `RMS_RES` |
132-
| `RMS_MOMENTUM-X` | Root-mean square residual of the momentum x-component. | `RMS_RES` |
133-
| `RMS_MOMENTUM-Y` | Root-mean square residual of the momentum y-component. | `RMS_RES` |
134-
| `RMS_MOMENTUM-Z` | Root-mean square residual of the momentum z-component. | `RMS_RES` |
135-
| `RMS_ENERGY` | Root-mean square residual of the energy. | `RMS_RES` |
136-
| `DRAG` | Total Drag coefficient. | `AERO_COEFF` |
137-
| `LIFT` | Total Lift coefficient | `AERO_COEFF` |
138-
| `SIDEFORCE` | Total Sideforce coefficient. | `AERO_COEFF` |
139-
| `MOMENT_X` | Total Moment around the x-axis. | `AERO_COEFF` |
140-
| `MOMENT_Y` | Total Moment around the y-axis. | `AERO_COEFF` |
141-
| `MOMENT_Z` | Total Moment around the z-axis. | `AERO_COEFF` |
142-
| `FORCE_X` | Total Force in x direction. | `AERO_COEFF` |
143-
| `FORCE_Y` | Total Force in y direction. | `AERO_COEFF` |
144-
| `FORCE_Z` | Total Force in z direction.| `AERO_COEFF` |
145-
| `EFFICIENCY` | Total Lift-to-drag ratio. | `AERO_COEFF` |
195+
| `RMS_MOMENTUM-X` | Root-mean square residual of the momentum x-component. | `RMS_RES` |
196+
| `RMS_MOMENTUM-Y` | Root-mean square residual of the momentum y-component. | `RMS_RES` |
197+
| `RMS_MOMENTUM-Z` | Root-mean square residual of the momentum z-component. | `RMS_RES` |
198+
| `RMS_ENERGY` | Root-mean square residual of the energy. | `RMS_RES` |
199+
| `DRAG` | Total Drag coefficient. | `AERO_COEFF` |
200+
| `LIFT` | Total Lift coefficient | `AERO_COEFF` |
201+
| `SIDEFORCE` | Total Sideforce coefficient. | `AERO_COEFF` |
202+
| `MOMENT_X` | Total Moment around the x-axis. | `AERO_COEFF` |
203+
| `MOMENT_Y` | Total Moment around the y-axis. | `AERO_COEFF` |
204+
| `MOMENT_Z` | Total Moment around the z-axis. | `AERO_COEFF` |
205+
| `FORCE_X` | Total Force in x direction. | `AERO_COEFF` |
206+
| `FORCE_Y` | Total Force in y direction. | `AERO_COEFF` |
207+
| `FORCE_Z` | Total Force in z direction.| `AERO_COEFF` |
208+
| `EFFICIENCY` | Total Lift-to-drag ratio. | `AERO_COEFF` |
146209

0 commit comments

Comments
 (0)