Skip to content

Commit a3c2fd5

Browse files
pcarruscagpcarruscag
authored
Merge pull request #132 from su2code/update_convective_scheme_docs
Update convective scheme docs
2 parents 4c6ed26 + 6112401 commit a3c2fd5

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

‎_docs_v7/Convective-Schemes.md

+15-19
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ To achieve second-order in space, upwind schemes need to be used with MUSCL reco
3232

3333
| Solver | Version |
3434
| --- | --- |
35-
| `EULER`, `NAVIER_STOKES`, `RANS` | 7.0.0 |
35+
| `EULER`, `NAVIER_STOKES`, `RANS` | 8.0.0 |
3636

3737
### Central Schemes ###
3838

@@ -46,9 +46,7 @@ In implicit time marching it improves the numerical properties of the Jacobian m
4646
To maintain CFL at lower-than-default values of dissipation coefficients, a higher factor should be used.
4747
`JST_MAT` benefits from higher values (~8.0).
4848

49-
All compressible central schemes support vectorization (`USE_VECTORIZATION= YES`) with no robustness downsides, see the build instructions for how to tune the compilation for maximum vectorization performance.
50-
51-
**Note:** The Lax-Friedrich scheme is always used on coarse multigrid levels when any central scheme is selected.
49+
**Note:** The Lax-Friedrich scheme is always used on coarse multigrid levels when any central scheme is selected. All compressible central schemes use vectorization, see the build instructions for how to tune the compilation for maximum performance.
5250

5351
### Upwind Schemes ###
5452

@@ -62,28 +60,25 @@ All compressible central schemes support vectorization (`USE_VECTORIZATION= YES`
6260
- `SLAU` - Simple Low dissipation AUSM scheme;
6361
- `SLAU2` - SLAU with the alternative pressure flux formulation;
6462
- `HLLC` - Harten-Lax-van Leer-Contact;
65-
- `CUSP` - Convective Upwind Split Pressure;
6663
- `MSW` - Modified Steger-Warming.
6764

6865
Some of the schemes above have tunning parameters or accept extra options, the following table lists those options and indicates to which schemes they apply (if a scheme does not appear on the table, no options apply to it).
6966

70-
| Option \ Scheme | `ROE` | `L2ROE` | `TURKEL_PREC` | `AUSMPLUSUP[2]` | `SLAU[2]` | `HLLC` | `CUSP` |
71-
| --------------------------------- | ----- | ------- | ------------- | --------------- | --------- | ------ | ------ |
72-
| **`ROE_KAPPA`** | X | X | X | | | X | |
73-
| **`ENTROPY_FIX_COEFF`** | X | X | X | | | | X |
74-
| **`ROE_LOW_DISSIPATION`** | X | | | | X | | |
75-
| **`USE_ACCURATE_FLUX_JACOBIANS`** | | | | X | X | | |
76-
| **`MIN/MAX_ROE_TURKEL_PREC`** | | | X | | | | |
77-
| **`USE_VECTORIZATION`** | X | | | | | | |
67+
| Option \ Scheme | `ROE` | `L2ROE` | `TURKEL_PREC` | `AUSMPLUSUP[2]` | `SLAU[2]` | `HLLC` |
68+
| --------------------------------- | ----- | ------- | ------------- | --------------- | --------- | ------ |
69+
| **`ROE_KAPPA`** | X | X | X | | | X |
70+
| **`ENTROPY_FIX_COEFF`** | X | X | X | | | |
71+
| **`ROE_LOW_DISSIPATION`** | X | | | | X | |
72+
| **`USE_ACCURATE_FLUX_JACOBIANS`** | | | | X | X | |
73+
| **`MIN/MAX_ROE_TURKEL_PREC`** | | | X | | | |
7874

7975
- `ROE_KAPPA`, default 0.5, constant that multiplies the left and right state sum;
8076
- `ENTROPY_FIX_COEFF`, default 0.001, puts a lower bound on dissipation by limiting the minimum convective Eigenvalue to a fraction of the speed of sound. Increasing it may help overcome convergence issues, at the expense of making the solution sensitive to this parameter.
8177
- `ROE_LOW_DISSIPATION`, default `NONE`, methods to reduce dissipation in regions where certain conditions are verified, `FD` (wall distance based), `NTS` (Travin and Shur), `FD_DUCROS` and `NTS_DUCROS` as before plus Ducros' shock sensor;
8278
- `USE_ACCURATE_FLUX_JACOBIANS`, default `NO`, if set to `YES` accurate flux Jacobians are used instead of Roe approximates, slower on a per iteration basis but in some cases allows much higher CFL values to be used and therefore faster overall convergence;
8379
- `MIN_ROE_TURKEL_PREC` and `MAX_ROE_TURKEL_PREC`, defaults 0.01 and 0.2 respectively, reference Mach numbers for Turkel preconditioning;
84-
- `USE_VECTORIZATION`, default `NO`, if `YES` use the vectorized (SSE, AVX, or AVX512) implementation which is faster but may be less robust against initial solution transients.
8580

86-
**Note:** Some schemes are not compatible with all other features of SU2, the AUSM family and CUSP are not compatible with unsteady simulations of moving grids, non-ideal gases are only compatible with the standard Roe and HLLC schemes.
81+
**Note:** Some schemes are not compatible with all other features of SU2, the AUSM family is not compatible with unsteady simulations of moving grids, non-ideal gases are only compatible with the standard Roe and HLLC schemes. The only upwind scheme that uses vectorization is the Roe scheme (ideal gas only), see the build instructions for how to tune the compilation for maximum performance.
8782

8883
## Incompressible Flow ##
8984

@@ -99,12 +94,13 @@ Some of the schemes above have tunning parameters or accept extra options, the f
9994

10095
`FDS` - Flux Difference Splitting with low speed preconditioning, this scheme does not have tuning parameters.
10196

102-
## Turbulence Equations ##
97+
## Turbulence and Scalar/Species Equations ##
10398

10499
| Solver | Version |
105100
| --- | --- |
106-
| `RANS`, `INC_RANS` | 7.0.0 |
101+
| `RANS`, `INC_RANS` | 8.0.0 |
107102

108-
Only one method is currently available: `SCALAR_UPWIND` which must be selected via option `CONV_NUM_METHOD_TURB`.
109-
This method does not have any special parameters.
103+
For compressible flows the only method available is `SCALAR_UPWIND` which must be selected via option `CONV_NUM_METHOD_TURB`.
104+
For incompressible flows the `BOUNDED_SCALAR` method is also available, this includes a divergence correction to prevent spurious production/destruction of the transported scalar while convergence is not reached.
105+
These methods do not have any special parameters.
110106

0 commit comments

Comments
 (0)