Skip to content

Commit 519d615

Browse files
authored
Doc update : rename BC-XXX to Case-XXX and update the list of configurations (#380)
1 parent ffbc596 commit 519d615

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/pages/user_guide/parameters.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,23 @@ BasicParam
1414

1515
* ``xlx``, ``yly`` & ``zlz`` are the domain size, normalised with the reference length for the simulation (as an example, for a cylinder case, ``xlx=20D`` where ``D`` is the diameter of the cylinder). You can also decide to run simulations with non-normalised quantities, you just need to be consistent!
1616

17-
* ``itype`` sets the flow configuration, each one is specified in a different ``BC-<flow-configuration>.f90`` file. They are:
17+
* ``itype`` sets the flow configuration, each one is specified in a different ``Case-<flow-configuration>.f90`` file. They are:
1818

1919
- 0 - User Custom Configuration;
2020
- 1 - Turbidity Current in Lock-Release;
2121
- 2 - Taylor-Green Vortices;
22-
- 3 - Periodic Turbulent Channe`;
22+
- 3 - Periodic Turbulent Channel;
2323
- 4 - Periodic Hill;
2424
- 5 - Flow over a Cylinder;
25-
- 6 - Debug Schemes (for developers);
2625
- 7 - Mixing Layer;
27-
- 8 - Turbulent Jet (work in progress, currently unsupported);
2826
- 9 - Turbulent Boundary Layer;
2927
- 10 - Atmospheric Boundary Layer;
30-
- 11 - Uniform flow.
31-
You can modify the ``BC-<flow-configuration>.f90`` file to change the inlet and/or initial conditions. Except for the Atmospheric Boundary Layer, quantities are normalised with a reference velocity, a reference length and a constant density, all equal to 1 (as an example, for the cylinder, the reference velocity is the freestream velocity equal to 1, the diameter equal to 1 and a constant density equal to 1; as a results the Reynolds number is equal to 1/nu).
28+
- 11 - Uniform flow;
29+
- 12 - Sandbox configuration;
30+
- 13 - Differentilly heated cavity;
31+
- 14 - Pipe flow;
32+
- 15 - Periodic turbulent boundary layer.
33+
You can modify the ``Case-<flow-configuration>.f90`` file to change the inlet and/or initial conditions. Except for the Atmospheric Boundary Layer, quantities are normalised with a reference velocity, a reference length and a constant density, all equal to 1 (as an example, for the cylinder, the reference velocity is the freestream velocity equal to 1, the diameter equal to 1 and a constant density equal to 1; as a results the Reynolds number is equal to 1/nu).
3234

3335

3436
* ``istret`` controls mesh refinement in y direction only (it is not possible to refine the mesh in more than one direction):

0 commit comments

Comments
 (0)