Merge pull request #78 from su2code/master

update develop

Author: pcarruscag

_data/vandv.yml

@@ -8,3 +8,4 @@
   - MMS_FVM_Navier_Stokes
   - Flat_Plate
   - Bump_Channel
+  - 30p30n

_docs_v7/Custom-Output.md

@@ -42,8 +42,12 @@ SU2 can output the solution in several file formats. You can specify what files
 | Option value | Description |
 |---|---|
 | `RESTART` | Native SU2 binary restart format |
-| `RESTART_ASCII` | ASCII CSV restart format |
+| `RESTART_ASCII` | Native SU2 ASCII CSV restart format |
+| `STL_BINARY` | binary mesh in .stl format |
+| `STL_ASCII` | ASCII mesh in .stl format |
+| `MESH` | Native SU2 mesh in .su2 format |
 | `CSV` | ASCII CSV restart format (identical to `RESTART_ASCII`) |
+| `PARAVIEW_MULTIBLOCK` | Binary Paraview .vtm format |
 | `PARAVIEW` | Binary Paraview .vtk format |
 | `PARAVIEW_ASCII` | ASCII Paraview .vtk format |
 | `TECPLOT` | Binary Tecplot .szplt format |
@@ -54,44 +58,103 @@ SU2 can output the solution in several file formats. You can specify what files
 | `SURFACE_TECPLOT` | Surface values in binary Tecplot .szplt format (includes all markers set with `MARKER_PLOTTING`)|
 | `SURFACE_TECPLOT_ASCII` | Surface values in ASCII Tecplot .dat format (includes all markers set with `MARKER_PLOTTING`)|
 
-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.
+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.
 
-**Note:** If run SU2 in parallel you should always use binary output files to get the best performance.
+**Note:** If you run SU2 in parallel you should always use binary output files to get the best performance.
 
 ### Setting Output Fields ###
 
 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.
 
+| Option value | Default value | Description | Data type |
+|---|---|---|---|
+| VOLUME_OUTPUT| COORDINATES,SOLUTION,PRIMITIVE| fields or groups that will be saved to file| list of keywords|
+
+
 ### Example ###
 
+Groups and fields can be combined, e.g.:
+
+`VOLUME_OUTPUT= SOLUTION, PRESSURE, DENSITY `
+
+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. 
+
 For the compressible Navier-Stokes solver (i.e. `SOLVER=NAVIER_STOKES`), a **non-exhaustive list** of possible fields/groups is the following:
 
-| Field Name | Description  | Group Name  |  
+| Field Name | Description  | Group Name  |  Remarks |
+|---|---|---|
+|  `COORD-X` | x coordinate | `COORDINATES`   | - |
+|  `COORD-Y` | y coordinate   | `COORDINATES`   | - |
+|  `COORD-Z` | z coordinate   |  `COORDINATES`  | 3D only |
+|  `DENSITY` | Density | `SOLUTION`   | - |
+|  `MOMENTUM-X` | Momentum x-component | `SOLUTION`   | - |
+|  `MOMENTUM-Y` | Momentum y-component  | `SOLUTION`   | - |
+|  `MOMENTUM-Z` | Momentum z-component |  `SOLUTION`  | 3D only |
+|  `ENERGY` | Energy  |  `SOLUTION`  | - |
+|  `PRESSURE` | Pressure|  `PRIMITIVE`  | - |
+|  `TEMPERATURE` | Temperature |  `PRIMITIVE`  | - |
+|  `MACH` | Mach Number |  `PRIMITIVE`  | - |
+|  `PRESSURE_COEFF` | Pressure Coefficient  |  `PRIMITIVE`  | - |
+|  `LAMINAR_VISCOSITY` | Laminar viscosity  |  `PRIMITIVE`  | - |
+|  `SKIN_FRICTION-X` | Skin friction coefficient x-component |  `PRIMITIVE`  | - |
+|  `SKIN_FRICTION-Y` | Skin friction coefficient y-component  |  `PRIMITIVE`  | - |
+|  `SKIN_FRICTION-Z` | Skin friction coefficient z-component |  `PRIMITIVE`  | 3D only |
+|  `HEAT_FLUX` | Heat flux |  `PRIMITIVE`  | - |
+|  `Y_PLUS` | Y-Plus |  `PRIMITIVE`  | - |
+
+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. 
+
+
+For the incompressible Navier-Stokes solver (i.e. `SOLVER=INC_NAVIER_STOKES`), the solution group is different:
+
+| Field Name | Description  | Group Name  |  Remarks |
+|---|---|---|
+|  `PRESSURE` | Pressure | `SOLUTION`   | - |
+|  `VELOCITY-X` | Velocity x-component | `SOLUTION`   | - |
+|  `VELOCITY-Y` | Velocity y-component  | `SOLUTION`   | - |
+|  `VELOCITY-Z` | Velocity z-component |  `SOLUTION`  | 3D only |
+|  `TEMPERATURE` | Static Temperature  |  `SOLUTION`  | `INC_ENERGY_EQUATION= YES` |
+|  `DENSITY` | Density  |  `PRIMITIVE`  | - |
+
+
+Turbulence quantities:
+
+| Field Name | Description  | Group Name  |  Remarks |
 |---|---|---|
-|  `COORD-X` | x coordinate | `COORDINATES`   |
-|  `COORD-Y` | y coordinate   | `COORDINATES`   |
-|  `COORD-Z` | z coordinate   |  `COORDINATES`  |
-| `DENSITY` | Density | `SOLUTION`   |
-|  `MOMENTUM-X` | Momentum x-component | `SOLUTION`   |
-|  `MOMENTUM-Y` | Momentum y-component  | `SOLUTION`   |
-|  `MOMENTUM-Z` | Momentum z-component |  `SOLUTION`  |
-|  `ENERGY` | Energy  |  `SOLUTION`  |
-|  `PRESSURE` | Pressure|  `PRIMITIVE`  |
-|  `TEMPERATURE` | Temperature |  `PRIMITIVE`  |
-|  `MACH` | Mach Number |  `PRIMITIVE`  |
-|  `PRESSURE_COEFF` | Pressure Coefficient  |  `PRIMITIVE`  |
-|  `LAMINAR_VISCOSITY` | Laminar viscosity  |  `PRIMITIVE`  |
-|  `SKIN_FRICTION-X` | Skin friction coefficient x-component |  `PRIMITIVE`  |
-|  `SKIN_FRICTION-Y` | Skin friction coefficient y-component  |  `PRIMITIVE`  |
-|  `SKIN_FRICTION-Z` | Skin friction coefficient z-component |  `PRIMITIVE`  |
-|  `HEAT_FLUX` | Heat flux |  `PRIMITIVE`  |
-|  `Y_PLUS` | Y-Plus |  `PRIMITIVE`  |
+|  `NU_TILDE` | Spalart Allmaras variable | `SOLUTION`   | SA models |
+|  `TKE` | Turbulent kinetic energy k | `SOLUTION`   | SST models |
+|  `DISSIPATION` | Turbulent dissipation rate omega   | `SOLUTION`   | SST models |
+|  `EDDY_VISCOSITY` | Turbulent eddy viscosity  |  `PRIMITIVE`  | - |
+
+
+To inspect the mesh quality we additionaly have:
+
+| Field Name | Description  | Group Name  |  Remarks |
+|---|---|---|
+|  `ORTHOGONALITY` | Orthogonality angle |  `MESH_QUALITY`  | - |
+|  `ASPECT_RATIO` | CV Aspect ratio |  `MESH_QUALITY`  | - |
+|  `VOLUME_RATIO` | CV sub-volume ratio |  `MESH_QUALITY`  | - |
+
+For moving grids:
+
+| Field Name | Description  | Group Name  |  Remarks |
+|---|---|---|
+|  `GRID_VELOCITY-X` | X-component of grid velocity vector |  `GRID_VELOCITY`  | - |
+|  `GRID_VELOCITY-Y` | Y-component of grid velocity vector |  `GRID_VELOCITY`  | - |
+|  `GRID_VELOCITY-Z` | Z-component of grid velocity vector |  `GRID_VELOCITY`  | 3D only |
 
 
 ## Customizing the Screen and History Output ##
 
 ### Screen Output ###
-You can define the output fields you want to have on screen by using the config option `SCREEN_OUTPUT`. 
+You can define the output fields you want to have printed on screen by using the config option `SCREEN_OUTPUT`. 
+
+| Option value | Default value | Description | Data type | Remark |
+|---|---|---|---|---|
+| 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 |
+| SCREEN_OUTPUT| INNER_ITER, RMS_PRESSURE, VELOCITY-X,VELOCITY-Y| field or group that will be printed to screen | list of keywords| incompressible |
+
+
 Fields available depend on the solver you are using. Fields available for **all solvers** are the following:
 
 - `TIME_ITER`:  Time iteration index
@@ -110,7 +173,7 @@ You can also customize the frequency when the convergence history should be writ
 
 ### History Output ###
 
-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.
+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. 
 
 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.
 
@@ -129,18 +192,18 @@ For the compressible Navier-Stokes solver (i.e. `SOLVER=NAVIER_STOKES`), a **non
 | `TIME_STEP` |  Current time step. | `TIME_DOMAIN`   |
 | `WALL_TIME` | Current average wall-clock time for one iteration. | `WALL_TIME`   |
 | `RMS_DENSITY` | Root-mean square residual of the density. | `RMS_RES`   |
-|  `RMS_MOMENTUM-X` | Root-mean square residual of the momentum x-component. | `RMS_RES`   |
-|  `RMS_MOMENTUM-Y` | Root-mean square residual of the momentum y-component.  | `RMS_RES`   |
-|  `RMS_MOMENTUM-Z` | Root-mean square residual of the momentum z-component.  |  `RMS_RES`  |
-|  `RMS_ENERGY` | Root-mean square residual of the energy.  |  `RMS_RES`  |
-|  `DRAG` | Total Drag coefficient. |  `AERO_COEFF`  |
-|  `LIFT` | Total Lift coefficient |  `AERO_COEFF`  |
-|  `SIDEFORCE` | Total Sideforce coefficient.  |  `AERO_COEFF`  |
-|  `MOMENT_X` | Total Moment around the x-axis.  |  `AERO_COEFF`  |
-|  `MOMENT_Y` | Total Moment around the y-axis.  |  `AERO_COEFF`  |
-|  `MOMENT_Z` | Total Moment around the z-axis. |  `AERO_COEFF`  |
-|  `FORCE_X` | Total Force in x direction. |  `AERO_COEFF`  |
-|  `FORCE_Y` | Total Force in y direction. |  `AERO_COEFF`  |
-|  `FORCE_Z` | Total Force in z direction.|  `AERO_COEFF`  |
-|  `EFFICIENCY` | Total Lift-to-drag ratio. |  `AERO_COEFF`  |
+| `RMS_MOMENTUM-X` | Root-mean square residual of the momentum x-component. | `RMS_RES`   |
+| `RMS_MOMENTUM-Y` | Root-mean square residual of the momentum y-component.  | `RMS_RES`   |
+| `RMS_MOMENTUM-Z` | Root-mean square residual of the momentum z-component.  |  `RMS_RES`  |
+| `RMS_ENERGY` | Root-mean square residual of the energy.  |  `RMS_RES`  |
+| `DRAG` | Total Drag coefficient. |  `AERO_COEFF`  |
+| `LIFT` | Total Lift coefficient |  `AERO_COEFF`  |
+| `SIDEFORCE` | Total Sideforce coefficient.  |  `AERO_COEFF`  |
+| `MOMENT_X` | Total Moment around the x-axis.  |  `AERO_COEFF`  |
+| `MOMENT_Y` | Total Moment around the y-axis.  |  `AERO_COEFF`  |
+| `MOMENT_Z` | Total Moment around the z-axis. |  `AERO_COEFF`  |
+| `FORCE_X` | Total Force in x direction. |  `AERO_COEFF`  |
+| `FORCE_Y` | Total Force in y direction. |  `AERO_COEFF`  |
+| `FORCE_Z` | Total Force in z direction.|  `AERO_COEFF`  |
+| `EFFICIENCY` | Total Lift-to-drag ratio. |  `AERO_COEFF`  |
 

_docs_v7/Markers-and-BC.md

@@ -155,11 +155,11 @@ MARKER_INLET = (inlet1, 1.13 , 20, 1.0, 0.0, 0.0, inlet2, 1.15, 10, 0.0, 1.0, 0.
 | --- | --- |
 | `INC_EULER`, `INC_NAVIER_STOKES`, `INC_RANS` | 7.0.0 |
 
-To describe the **Velocity** at the inlet, set the option `INC_INLET_TYPE= VELOCITY_INLET`. The format for `MARKER_INLET` then is the marker name, followed by the Temperature (in Kelvin `[K`]), the Velocity magnitude (in meter per second `[m/s]`) and the flow direction unity vector (in meter per second `[m/s]`). 
+To describe the **Velocity** as well as the **Temperature** at the inlet, set the option `INC_INLET_TYPE= VELOCITY_INLET`. The format for `MARKER_INLET` then is the marker name, followed by the Temperature (in Kelvin `[K`]), the Velocity magnitude (in meter per second `[m/s]`) and the flow direction vector (the direction vector does not need to be normalized). Note that the temperature has to be provided even when `INC_ENERGY_EQUATION= NO`, but it will be ignored in the calculations.
 
 ```
 INC_INLET_TYPE= VELOCITY_INLET, VELOCITY_INLET
-MARKER_INLET = (inlet1, 300 , 20, 1.0, 0.0, 0.0, inlet2, 200, 10, 0.0, 1.0, 0.0)
+MARKER_INLET = (inlet1, 300, 20, 1.0, 0.0, 0.0, inlet2, 200, 10, 0.0, 1.0, 0.0)
 ```
 
 ### Pressure Inlet ###

_docs_v7/Restart-File.md

@@ -6,23 +6,23 @@ permalink: /docs_v7/Restart-File/
 
 ## Saving files for restarts or adjoint runs
 
-The SU2 binary restart format has the extension `.dat`, but it is also possible to write out restart files in a simple ASCII file format with extension `.csv`. Have a look at the [Output section](/docs_v7/Custom-Output/) to learn how to change output file formats.
-
-The restart files are used to restart the code from a previous solution and also to run the adjoint simulations, which require a flow solution as input. To save a restart file, the user needs to add the option `RESTART` to the keyword `OUTPUT_FILES`:
+The restart files are used to restart the code from a previous solution and also to run the adjoint simulations, which require a flow solution as input. To save a restart file, the user needs to add the option `RESTART` to the keyword `OUTPUT_FILES` in the configuration file:
 
 `OUTPUT_FILES= RESTART`
 
+The SU2 binary restart format has the extension `.dat`, but it is also possible to write out restart files in a simple ASCII file format with extension `.csv`. Have a look at the [Output section](/docs_v7/Custom-Output/) to learn how to change output file formats.
+
 A restart file with the name given by the keyword `RESTART_FILENAME` is then saved at the end of the simulation, or after every number of iterations given by the keyword `OUTPUT_WRT_FREQ`. For instance,
 
 `RESTART_FILENAME= restart_flow` \
 `OUTPUT_WRT_FREQ= 100`
 
-will write the the file restart_flow.dat every 100 iterations when then the total number of iterations is larger than 100, or only once at the end of the simulation when the total number of iterations is smaller than 100. Note that the file extension (the suffix) is automatic and can be left out.
+will write the file restart_flow.dat every 100 iterations when the total number of iterations is larger than 100, or only once at the end of the simulation when the total number of iterations is smaller than 100. Note that the file extension (the suffix) is automatic and can be left out.
 If you would like to keep copies of previously saved restart files, this is possible by setting
 
 `WRT_RESTART_OVERWRITE= NO`
 
-This option is available only for steady simulations. In unsteady simulations, the number of timesteps is appended to the filename automatically. Additional to the regular restart file, a restart file with the current iteration appended to the filename will be written every `OUTPUT_WRT_FREQ` iterations.
+Additional to the regular restart file, a restart file with the current iteration appended to the filename will then be written every `OUTPUT_WRT_FREQ` iterations. Note that this option is available only for steady simulations. In unsteady simulations, the number of timesteps is appended to the filename automatically. 
 
 ## Starting a simulation from a saved solution
 
@@ -37,8 +37,9 @@ If performing an unsteady restart the `RESTART_ITER` needs to be set to the iter
 
 | Option value | Default value | Description | Data type |
 |---|---|---|---|
+| `OUTPUT_FILES` | RESTART,PARAVIEW,SURFACE_PARAVIEW | files types to write | list of keywords |
 | `RESTART_FILENAME` | restart.dat | filename under which the restart file will be saved | string |
-| `OUTPUT_WRT_FREQ` | 250 | the frequency with which the output files will be saved | integer |
+| `OUTPUT_WRT_FREQ` | 10,250,42 | the list of frequencies with which the output files will be saved | list of integers |
 | `WRT_RESTART_OVERWRITE` | YES | overwrite the restart file or (additionally) append the iteration number to the filename | boolean |
 | `RESTART_SOL` | solution | restart from file or from initial conditions | boolean |
 | `SOLUTION_FILENAME` | solution.dat | filename that will be used to restart the primal or start the adjoint computation | string |

_docs_v7/SU2-Windows.md

@@ -19,7 +19,7 @@ SU2 supports Windows platforms from Windows 7 and Windows 10 for x86 (64-bit). Y
 ## Installation 
 
 ### Download and unpack the archive
-[Download](/download/) the .zip for your operating system and unzip it where you want it to be installed. 
+[Download](/docs_v7/Download/) the .zip for your operating system and unzip it where you want it to be installed. 
 
 ### Add SU2 environment variables
 This is done through the Environment Variables control panel.  You can access these by typing "environ" in the search/run box of the start menu.  Start a New System variable.  Assign the Variable Name `SU2_RUN`, and assign the Variable Value to be the path to your SU2 Executables (the folder that contains `SU2_CFD.exe` for example). This variable will allow you to quickly navigate to the SU2 directory using `cd %SU2_RUN%`, and run the executables using `%SU2_RUN%\<executable>`.