Merge pull request #96 from su2code/master

pcarruscag · web-flow · commit 5f62cb017b87 · 2022-10-24T08:19:59.000-07:00
update develop
diff --git a/_docs_v7/Custom-Output.md b/_docs_v7/Custom-Output.md
@@ -16,6 +16,7 @@ It is now possible to individually define what you want to have in your output.
   - [Screen Output](#screen-output)
   - [History Output](#history-output)
   - [Example](#example-1)
+  - [User Defined Functions ](#user-defined-functions)
   
 ---
 
@@ -29,7 +30,7 @@ Let's define some terminology first.
 - **Output group**: A collection of output fields.
 
 
-**Note**: You can print all available output fields and groups available for the current solver (set with the `SOLVER` option) by calling `SU2_CFD` with the `-d` flag, i.e.
+**Note**: You can print all available output fields and groups available for the current solver (set with the `SOLVER` option) by calling `SU2_CFD` with the `-d` flag (dry-run mode), i.e.
 ```
 SU2_CFD -d <your_config_file.cfg>
 ```
@@ -165,7 +166,6 @@ Fields available depend on the solver you are using. Fields available for **all
 - `WALL_TIME`:  Current average wall-clock time for one iteration
 
 
-
 If you run a multizone problem, the convergence history of the individual zones (i.e. the convergence of the inner iteration) is disabled by default and only the convergence of the outer iteration is shown. That means `SCREEN_OUTPUT` in the sub-config files is ignored. You can still print fields from individual zones by using the field name and the zone index. For example in an Fluid-Structure interaction problem the drag in zone 0 and the von-Mises stress in zone 1 can be used as fields by adding `DRAG[0]` and/or `VMS[1]` to the screen output in the main config file. It is possible to force the output of the full inner convergence history per zone by setting `WRT_ZONE_CONV` to `YES`. 
 
 You can also customize the frequency when the convergence history should be written to screen by using `SCREEN_WRT_FREQ_INNER`, `SCREEN_WRT_FREQ_OUTER` and `SCREEN_WRT_FREQ_TIME`.
@@ -183,7 +183,7 @@ You can also customize the frequency when the convergence history should be writ
 
 For the compressible Navier-Stokes solver (i.e. `SOLVER=NAVIER_STOKES`), a **non-exhaustive list** of possible fields/groups is the following:
 
-| Field Name (for screen output)  | Description  | Group Name (for history output)  |  
+| Field Name  | Description  | Group Name  |  
 |---|---|---|
 | `TIME_ITER` | Time iteration index | `ITER`   |
 | `OUTER_ITER` | Outer (coupling) iteration index. | `ITER`   |
@@ -207,3 +207,34 @@ For the compressible Navier-Stokes solver (i.e. `SOLVER=NAVIER_STOKES`), a **non
 | `FORCE_Z` | Total Force in z direction.|  `AERO_COEFF`  |
 | `EFFICIENCY` | Total Lift-to-drag ratio. |  `AERO_COEFF`  |
 
+### User Defined Functions ###
+
+From version 7.4.0 it is possible for users to create custom outputs via math expressions of solver variables and built-in outputs.
+All custom outputs are specified via the config option `CUSTOM_OUTPUTS`, in general the syntax to define a custom output is `name : type{expression}[markers];` (note the use of ; to separate different outputs).
+Where 'name' is the identifier that can be used to request output to screen or history file, and also to reference the output in other custom outputs (he group name for all custom outputs is `CUSTOM`).
+
+The available types are:
+- `Macro`: Introduces a new field that can only be used in other expressions, it is not an output by itself (note the "$" symbol to reference macros in the example below).
+- `Function`: Introduces a new scalar output that is a function of other scalar outputs, it cannot reference fields (e.g. velocity).
+- `AreaAvg` and `AreaInt`: Computes an area average or integral of a field (the expression) over the list of markers.
+- `MassFlowAvg` and `MassFlowInt`: Computes a mass flow average or integral.
+
+**Note:** Each custom output can only use one type, e.g. it is not possible to write `p_drop : AreaAvg{PRESSURE}[inlet] - AreaAvg{PRESSURE}[outlet]`. This would need to be separated into two `AreaAvg` outputs and one `Function` to compute their difference.
+
+**Example:**
+```
+CUSTOM_OUTPUTS= 'velocity : Macro{sqrt(pow(VELOCITY_X, 2) + pow(VELOCITY_Y, 2) + pow(VELOCITY_Z, 2))};\
+                 avg_vel : AreaAvg{$velocity}[z_minus, z_plus];\
+                 var_vel : AreaAvg{pow($velocity - avg_vel, 2)}[z_minus, z_plus];\
+                 dev_vel : Function{sqrt(var_vel) / avg_vel}'
+```
+
+To obtain the list of solver variables that can be used, write an invalid expression (e.g. 'x : AreaAvg{INVALID}[]') and run SU2.
+
+To use a custom output as the objective function of the discrete adjoint solver, use `OBJECTIVE_FUNCTION= CUSTOM_OBJFUNC` and set `CUSTOM_OBJFUNC` appropriately, for example:
+```
+CUSTOM_OBJFUNC= 'LIFT + dev_vel'
+```
+
+For more details see the [example test case](https://github.com/su2code/SU2/blob/master/TestCases/user_defined_functions/lam_flatplate.cfg).
+
diff --git a/_docs_v7/Markers-and-BC.md b/_docs_v7/Markers-and-BC.md
@@ -13,6 +13,8 @@ The term *Marker* refers to a named entity in your mesh file. Boundary condition
 - [Heat Transfer or Convection (no-slip) Wall](#heat-transfer-or-convection-no-slip-wall)
 - [Isothermal (no-slip) Wall](#isothermal-no-slip-wall)
 - [Farfield Boundary Condition](#farfield-boundary-condition)
+- [Turbulence Boundary Condition](#turbulence-boundary-condition)
+  - [Wall functions](#wall-functions) 
 - [Inlet Boundary Condition](#inlet-boundary-condition)
   - [Total Conditions](#total-conditions)
   - [Mass Flow Inlet](#mass-flow-inlet)
@@ -121,6 +123,40 @@ A marker can be defined as a Farfield boundary by addings its name to the `MARKE
 MARKER_FAR= (farfield)
 ```
 
+## Turbulence Boundary Condition ##
+
+| Solver | Version | 
+| --- | --- |
+| `RANS`, `INC_RANS`, | 7.3.0 |
+
+The turbulence boundary conditions do not have a `MARKER_` keyword but can instead be set for inlet and freestream boundaries using the keywords: 
+
+For the SA turbulence model:
+```
+FREESTREAM_NU_FACTOR= 3
+```
+
+For the SST turbulence model:
+```
+FREESTREAM_TURBULENCEINTENSITY= 0.05
+FREESTREAM_TURB2LAMVISCRATIO= 10
+```
+
+### Wall functions ###
+Accurately resolving the turbulence close to walls requires very fine meshes and can be quite expensive. When the vertices of the first cell neighboring the wall have on average a normalized distance $$y^+ >1$$, wall functions can be used. For example to activate wall functions on the markers `wall1` and `wall2`, we write:
+```
+MARKER_WALL_FUNCTIONS=(wall1,STANDARD_WALL_FUNCTION,wall2,STANDARD_WALL_FUNCTION)
+```
+The wall functions will now be used automatically. all functions have 5 additional expert parameters:
+```
+WALLMODEL_KAPPA= 0.41
+WALLMODEL_B= 5.5
+WALLMODEL_MINYPLUS= 5.0
+WALLMODEL_MAXITER= 200
+WALLMODEL_RELFAC= 0.5
+```
+The constant `WALLMODEL_KAPPA` is the von Karman constant, and `WALLMODEL_B` is an additional constant describing the universal 'law of the wall'. The constants are supposed to be universal, and do not change. The setting `WALLMODEL_MINYPLUS= 5` will activate the wall model only when the local value of $$y^+$$ is higher than the value given (default: 5). Note that in principle, this implementation is valid for any $$y^+ < 100-500$$ and will also work correctly for very small values of $$y^+$$. the upper limit that can be used depends on (and increases with) the Reynolds number. The universal law of the wall is an implicit function and a Newton iterator is used to determine $$u^+(y^+)$$. The maximum number of iterations can be set by `WALLMODEL_MAXITER` and the relaxation factor can be set with `WALLMODEL_RELFAC`. When the Newton solver does not converge within the maximum number of iterations given, a warning message will appear during the computation. When these warning messages do not disappear, you might consider increasing `WALLMODEL_MAXITER` or decreasing `WALLMODEL_RELFAC`.  
+
 ## Inlet Boundary Condition ##
 Inlet boundary conditions are set using the option `MARKER_INLET`.
 
diff --git a/_docs_v7/Theory.md b/_docs_v7/Theory.md
@@ -173,6 +173,12 @@ For information on how to use turbulence models in SU2 see the [users guide](htt
 
 The edge-based finite volume discretization of flow solvers is also used in turbulence solvers. Convective fluxes are evaluated using a scalar upwind scheme (1st or 2nd order).
 
+## Wall functions
+
+Available for `RANS`, `INC_RANS`.
+
+The wall function model of Nichols and Nelson (2004) has been implemented in the compressible and the incompressible solver, for the SA as well as the SST models. For the compressible solver, the wall function model takes into account the frictional heating of the wall according to the Crocco-Busemann relation when the wall boundary conditions is not isothermal. When the wall model is active, the value of the dimensional distance of the first node from the wall can be $$ y^+ > 5$$. When the wall model is not active, $$y^+ < 5 $$ and in addition a fine mesh is necessary close to the wall to resolve the near wall boundary layer.
+
 ---
 
 # Species Transport #
diff --git a/_tutorials/incompressible_flow/Inc_Species_Transport/Inc_Species_Transport.md b/_tutorials/incompressible_flow/Inc_Species_Transport/Inc_Species_Transport.md
@@ -55,7 +55,7 @@ The material properties specific to the species transport equations are:
 
 All available options concerning species transport are listed below as they occur in the [config_template.cfg](https://github.com/su2code/SU2/blob/master/config_template.cfg).
 
-The options as of now are fairly limited. Species transport is switched on by setting `KIND_SCALAR_MODEL= PASSIVE_SCALAR`. The `DIFFUSIVITY_MODEL= CONSTANT_DIFFUSIVITY` is currently the only available therefore the only additional choice the value of `DIFFUSIVITY_CONSTANT`. For the `SCHMIDT_NUMBER_TURBULENT` please consult [the respective theory](/docs_v7/Theory/#species-transport).
+The options as of now are fairly limited. Species transport is switched on by setting `KIND_SCALAR_MODEL= SPECIES_TRANSPORT`. The `DIFFUSIVITY_MODEL= CONSTANT_DIFFUSIVITY` is currently the only available therefore the only additional choice the value of `DIFFUSIVITY_CONSTANT`. For the `SCHMIDT_NUMBER_TURBULENT` please consult [the respective theory](/docs_v7/Theory/#species-transport).
 
 The number of species transport equations is not set individually but deduced from the number of values given in the respective lists for species options. SU2 checks whether the same amount of values is given in each option and solves the appropriate amount of equations. `MARKER_INLET_SPECIES` is one of these options and has to be used alongside a usual `MARKER_INLET`. For outlets, symmetries or walls this is not necessary. 
 
@@ -72,8 +72,8 @@ The inital species mass fractions are given by the list `SPECIES_INIT= 1.0, ...`
 ```
 % --------------------- SPECIES TRANSPORT SIMULATION --------------------------%
 %
-% Specify scalar transport model (NONE, PASSIVE_SCALAR)
-KIND_SCALAR_MODEL= NONE
+% Specify scalar transport model (NONE, SPECIES_TRANSPORT)
+KIND_SCALAR_MODEL= SPECIES_TRANSPORT
 %
 % Mass diffusivity model (CONSTANT_DIFFUSIVITY)
 DIFFUSIVITY_MODEL= CONSTANT_DIFFUSIVITY
@@ -166,4 +166,4 @@ Figure (4): Velocity Magnitude in the domain.
 
 ## Additional remarks
 
-An in depth optimization of this case with addition of the FFD-box, gradient validation and some more steps can found [here](/tutorials/Species_Transport/).
+An in depth optimization of this case with addition of the FFD-box, gradient validation and some more steps can found [here](/tutorials/Species_Transport/).
diff --git a/index.html b/index.html
@@ -39,10 +39,7 @@ <h2 style="font-weight:700">Powerful. Fast. Free.</h2>
       <hr>
       <center>
       <h1>3rd Annual SU2 Conference</h1>
-      <h3><a href="https://www.eventbrite.com/e/3rd-annual-su2-conference-tickets-375147244507?aff=ebdsoporgprofile">Registration</a> and <a href="https://su2foundation.org/su2conference2022/">Abstract Submission</a> Open!</h3>
-      <h3>Combined In-Person (<a href="https://www.google.com/maps/search/villa+monastero/@46.0084623,9.284619,17z/data=!3m1!4b1">Varenna/Italy</a>) and Virtual Event,
-        September 5 - 7, 2022</h3>
-       <h3>More information on abstract submission, registration etc. are posted on the <a href="https://su2foundation.org/su2conference2022/">conference website</a> and will always contain the latest updates.</h3>
+       <h3>Presentation slides and recordings will be available on the <a href="https://su2foundation.org/su2conference2022/">conference website</a>.</h3>
       </center>
       <hr>
       </div>
