list of parameters code

hopr-framework · Mar 12, 2024 · a4948bb · a4948bb
1 parent ffd0d42
commit a4948bb
Show file tree

Hide file tree

Showing 29 changed files with 5 additions and 5 deletions.
diff --git a/docs/documentation/tutorials/figures/0_curved.png b/docs/documentation/tutorials/figures/0_curved.png
diff --git a/docs/documentation/tutorials/figures/1_curved.png b/docs/documentation/tutorials/figures/1_curved.png
diff --git a/docs/documentation/tutorials/figures/3_curved.png b/docs/documentation/tutorials/figures/3_curved.png
diff --git a/docs/documentation/tutorials/figures/All_curved.png b/docs/documentation/tutorials/figures/All_curved.png
diff --git a/docs/documentation/tutorials/figures/CGNSviewer_spheremesh04.png b/docs/documentation/tutorials/figures/CGNSviewer_spheremesh04.png
diff --git a/docs/documentation/tutorials/figures/Cartbox_multiple_stretch_mesh.png b/docs/documentation/tutorials/figures/Cartbox_multiple_stretch_mesh.png
diff --git a/docs/documentation/tutorials/figures/Cartbox_multiple_stretch_side.png b/docs/documentation/tutorials/figures/Cartbox_multiple_stretch_side.png
diff --git a/docs/documentation/tutorials/figures/Cylinder_gmsh.png b/docs/documentation/tutorials/figures/Cylinder_gmsh.png
diff --git a/docs/documentation/tutorials/figures/DLRF6_bOrd5_innersplines.png b/docs/documentation/tutorials/figures/DLRF6_bOrd5_innersplines.png
diff --git a/docs/documentation/tutorials/figures/Hopr_nfine1.png b/docs/documentation/tutorials/figures/Hopr_nfine1.png
diff --git a/docs/documentation/tutorials/figures/Hopr_nfine2.png b/docs/documentation/tutorials/figures/Hopr_nfine2.png
diff --git a/docs/documentation/tutorials/figures/Paraview-logo.png b/docs/documentation/tutorials/figures/Paraview-logo.png
diff --git a/docs/documentation/tutorials/figures/Periodichill_3Dview.png b/docs/documentation/tutorials/figures/Periodichill_3Dview.png
diff --git a/docs/documentation/tutorials/figures/Splittohex0.png b/docs/documentation/tutorials/figures/Splittohex0.png
diff --git a/docs/documentation/tutorials/figures/Splittohex1.png b/docs/documentation/tutorials/figures/Splittohex1.png
diff --git a/docs/documentation/tutorials/figures/Stretch_example.png b/docs/documentation/tutorials/figures/Stretch_example.png
diff --git a/docs/documentation/tutorials/figures/Stretch_example_f.png b/docs/documentation/tutorials/figures/Stretch_example_f.png
diff --git a/docs/documentation/tutorials/figures/Stretch_example_fl0.png b/docs/documentation/tutorials/figures/Stretch_example_fl0.png
diff --git a/docs/documentation/tutorials/figures/Stretch_example_l0.png b/docs/documentation/tutorials/figures/Stretch_example_l0.png
diff --git a/docs/documentation/userguide/figures/algorithms/algorithm1.png b/docs/documentation/userguide/figures/algorithms/algorithm1.png
diff --git a/docs/documentation/userguide/figures/algorithms/algorithm2.png b/docs/documentation/userguide/figures/algorithms/algorithm2.png
diff --git a/docs/documentation/userguide/figures/algorithms/algorithm3.png b/docs/documentation/userguide/figures/algorithms/algorithm3.png
diff --git a/docs/documentation/userguide/figures/algorithms/algorithm4.png b/docs/documentation/userguide/figures/algorithms/algorithm4.png
diff --git a/docs/documentation/userguide/figures/algorithms/algorithm5.png b/docs/documentation/userguide/figures/algorithms/algorithm5.png
diff --git a/docs/documentation/userguide/figures/algorithms/algorithm6.png b/docs/documentation/userguide/figures/algorithms/algorithm6.png
diff --git a/docs/documentation/userguide/figures/algorithms/algorithm7.png b/docs/documentation/userguide/figures/algorithms/algorithm7.png
diff --git a/docs/documentation/userguide/figures/algorithms/algorithm8.png b/docs/documentation/userguide/figures/algorithms/algorithm8.png
diff --git a/docs/documentation/userguide/figures/algorithms/algorithm9.png b/docs/documentation/userguide/figures/algorithms/algorithm9.png
diff --git a/docs/documentation/userguide/parameters.md b/docs/documentation/userguide/parameters.md
@@ -7,10 +7,10 @@ width: 50px
 ---
 | Parameters         | Example      | Data Type    | Array Dim.   | Default Value | Description |
 | :--------------   | :--------| :---------- | :---------- | :----------  | :--------- |
-| `BCIndex`          | `BCIndex=(/1,2,3,4,5,6/)` | Int          |  6           |  MANDATORY                   |  The `BCIndex` parameter assigns a bondary condition to each surface of the cartesian box in order of the <br>surfaces. The number of a vector's component represents the nth boundary condition in order of its position <br>in the file. Hence, each position refers to the six box sides (/z-,y-,x+,y+,x-,z+/). In this example six different <br>boundary conditions were assigned to the box surfaces. In case of a boundary condition defined on several <br>faces, the components belonging to these faces will be equal in the `BCIndex` vector. In case of multiple <br>cartesian boxes there are surfaces which coincide with other ones. To such surfaces no boundary condition <br>can assigned. Therefore, The number of the corresponding vector's component is set to 0. For example, if all <br>components of the parameter `BCIndex` are set to 0 ("(/0,0,0,0,0,0/)") the box will be surrounded completely <br>by six other boxes so that no boundary condition can assigned to a single surface.             |
+| `BCIndex`          | `BCIndex=(/1,2,3,4,5,6/)` | Int          |  6           |  MANDATORY                   |  The `BCIndex` parameter assigns a bondary condition to each surface of the cartesian box in order of the <br>surfaces. The number of a vector's component represents the nth boundary condition in order of its position <br>in the file. Hence, each position refers to the six box sides `(/z-,y-,x+,y+,x-,z+/)`. In this example six different <br>boundary conditions were assigned to the box surfaces. In case of a boundary condition defined on several <br>faces, the components belonging to these faces will be equal in the `BCIndex` vector. In case of multiple <br>cartesian boxes there are surfaces which coincide with other ones. To such surfaces no boundary condition <br>can assigned. Therefore, The number of the corresponding vector's component is set to 0. For example, if all <br>components of the parameter `BCIndex` are set to 0 `(/0,0,0,0,0,0/)` the box will be surrounded completely <br>by six other boxes so that no boundary condition can assigned to a single surface.             |
 | `BoundaryName`       | `BoundaryName=BC_zminus`    | Str          |  1           |  MANDATORY                   |  Name of the boundary condition |
 | `BoundaryOrder`      | `BoundaryOrder=5`           | Int          |  1           |  2                           |  Order of spline-reconstruction for curved surfaces  |
-| `BoundaryType`       | `BoundaryType=(/4,0,0,-1/)` | Int          |  4           |  MANDATORY                   | The Type parameter consists of four components to set: (/ Type, curveIndex, State, alpha /). For a single <br>cartesian box only the component Type has to be set to a arbitrary number > 1. <br>The other components have to be set 0;<br>For a periodic boundary condition the component Type has always to set to "1". The fourth component alpha <br>assigns a displacement vector `vv` and its direction (-/+) to the periodic boundary. An alpha of "-1" means that <br>the first ("1") defined displacement vector is assigned to this surface in the opposite direction ("-1") as he was <br>defined.For curved-structured meshes the component curveIndex has to set to "1".  |
+| `BoundaryType`       | `BoundaryType=(/4,0,0,-1/)` | Int          |  4           |  MANDATORY                   | The Type parameter consists of four components to set: `(/ Type, curveIndex, State, alpha /)`. For a single <br>cartesian box only the component Type has to be set to a arbitrary number > 1. <br>The other components have to be set 0;<br>For a periodic boundary condition the component Type has always to set to "1". The fourth component alpha <br>assigns a displacement vector `vv` and its direction (-/+) to the periodic boundary. An alpha of "-1" means that <br>the first ("1") defined displacement vector is assigned to this surface in the opposite direction ("-1") as he was <br>defined.For curved-structured meshes the component curveIndex has to set to "1".  |
 | `checkElemJacobians` | `checkElemJacobians=T`      | Logical      |  1           |  MANDATORY<br>if useCurveds=T   | T (True): The Jacobian matrices are checked and scaled for each element <br> F (False): The Jacobian matrices are not checked and scaled for each element  |
 | `conformConnect` | `conformConnect=T`      | Logical      |  1           |  T   | T (True): Fast connect for conforming meshes (coarse geometry-adapted search mesh) <br> F (False): Finer search mesh for non-conforming meshes   |
 | `Corner` | `Corner=(/0.,0.,0. ,,1.,0.,0. ,,1.,1.,0. ,,0.,1.,0. ,,0.,0.,1. ,,1.,0.,1. ,,1.,1.,1. ,,0.,1.,1. /)`       | Real      |  24           |  MANDATORY<br>if Mode=1   | Coordinates of the box's corner nodes in the three-dimensional cartesian coordinate system. For proper <br>operation the nodes have to be in the order as illustrated in Figure {numref}`fig:CartmeshZone_3d` at the right and each node with <br>x,y,z coordinates. Furthermore the corner nodes define the six surfaces of the cartesian box, see {numref}`tab:Corner` below.|
@@ -22,8 +22,8 @@ width: 50px
 | `DXmaxToDXmin` | `DXmaxToDXmin=(/6.,100.,1./)` | Real      |  3           | (/0.,0.,0./)   | This parameter specify the frame ratio of the maximum element size to the minimum element size for the <br>stretched element arrangement for curved-structured meshes. The value 1 is used typically for a deactivated stretching.    |
 | `DZ` | `DZ=2` | Real      |  1           | MANDATORY<br>if Mode=11   | Dimension in z-direction: [-DZ,DZ]     |
 | `elemtype` | `elemtype=108` | Int      |  1           | MANDATORY   | Type of cells/elements used for discretization:<br>104: Tetrahedron<br>105: Pyramid<br>106: Prism with triangular base<br>108: Hexahedron     |
-| `ExactNormals` | `ExactNormals=(/1,1/)` | Int/Real      |  2           | (/0,0/)    | (/ BC curveIndex, number of analytical formula/). Build in formulas (see src/mesh/curved.f90):<br>1: Sphere with origin (0,0,0)<br>2: Cylinder around z-axis      |
-| `ExactSurfFunc` | `ExactSurfFunc=(/1,1/)` | Int      |  2           | (/0,0/)    | (/curv index, surface function index/). Surface function:<br>1: Sphere with origin (0,0,0) and radius 0.5<br>2: Cylinder around zaxis and radius 0.5<br>3: NACA 0012 profile in xy plane with length 1 and origin in leading edge      |
+| `ExactNormals` | `ExactNormals=(/1,1/)` | Int/Real      |  2           | (/0,0/)    | `(/ BC curveIndex, number of analytical formula/)`. Build in formulas (see src/mesh/curved.f90):<br>1: Sphere with origin (0,0,0)<br>2: Cylinder around z-axis      |
+| `ExactSurfFunc` | `ExactSurfFunc=(/1,1/)` | Int      |  2           | (/0,0/)    | `(/curv index, surface function index/)`. Surface function:<br>1: Sphere with origin (0,0,0) and radius 0.5<br>2: Cylinder around zaxis and radius 0.5<br>3: NACA 0012 profile in xy plane with length 1 and origin in leading edge      |
 | `fac` | `fac=(/1.5,2.2,10/)` | Real      |  3           | (/0,0,0/)    | Stretching factor of the elements in the direction of the turned local cylindrical coordinate axis. The value 0 <br>is only allowed if the stretching function for this axis is deactivated (`stretchType` vector component for this <br>axis is 0). A value of the intervall (0,1) means a decrease. The value 1 does not affect the element sizes and <br>means an deactivation of the stretching function for this axis. A value >1 means an increase of the element <br>size in the direction of the coordinate axis. Furthermore the stretching behaviour can be mirrored by adding <br>a negative sign to the values. If the `stretchType` vector component for an axis is 3, the factor will be multiplied <br>by -1 if the half distance is reached. In addition, fac has not the significant influence on the element arrangement <br>anymore but the parameter `DXmaxToDXmin`.      |
 | `factor` | `factor=(/-1.75,1,-1.5/)` | Real      |  3           | (/0,0,0/)    | Stretching factor of the elements in the direction of the cartesian coordinate axes. The value 0 is only allowed <br>if the stretching function for this axis is deactivated (`stretchType` vector component for this axis is 0). A value <br>of the intervall (0,1) means a decrease. The value 1 does not affect the element sizes and means an deactivation <br>of the stretching function for this axis. A value >1 means an increase of the element size in the direction of <br>the coordinate axis. Furthermore the stretching behaviour can be mirrored by adding a negative sign to the <br>values. A combination with the parameter l0 ignores the element number of the defined box.      |
 | `filename` | `filename=spheremesh` | Str      |  1           | MANDATORY<br>if Mode=3/4    | The name of the external mesh file. The belonging files have to be available in the directory of the executed <br>parameter file as *.cngs files.     |
@@ -37,7 +37,7 @@ width: 50px
 | `Mode` | `Mode=1` | Int      |  1           | MANDATORY    |  Mode of mesh generation:<br>1: Cartmesh (intern)<br>3: CFD General Notation System (CGNS, extern)<br>4: STAR-CD (extern)<br>11: Curved-structured mesh       |
 | `nAnalyze` |  `nAnalyze=5` | Int      |  1           | BoundaryOrder+2    |  Number of points used for mesh analysis, e.g. defines the number of points to sample an elements' Jacobian <br>if `checkElemJabians` is active.       |
 | `nCurvedBoundaryLayers` |  `nAnalyze=3` | Int      |  1           | -1    |  If domain is curved, try to uncurve it and leave only the sides with BCs speciefied (i.e. `curveIndex >0`) curved<br>-1: deactivated,<br>0: only boundary is curved,<br>1: only first element is curved,<br>2-n: first n layers from the boundary are curved       |
-| `nElems` |  `nElems=(/2,3,4/)` | Int      |  3           | MANDATORY<br>if Mode=1    |  Number of elements per box in the direction of the coordinate axes; (/nElemX,nElemY,nElemZ/)       |
+| `nElems` |  `nElems=(/2,3,4/)` | Int      |  3           | MANDATORY<br>if Mode=1    |  Number of elements per box in the direction of the coordinate axes; `(/nElemX,nElemY,nElemZ/)`       |
 | `nElemsZ` |  `nElems=1` | Int      |  1           | MANDATORY<br>if MeshIsAl.=T    | The number of curved elements        |
 | `nExactNormals` |  `nExactNormals=1` | Int      |  1           | MANDATORY<br>if NormalsType=3    |Number of association between BC `CurveIndex` and analytical normal        |
 | `nFineHexa` |  `nFineHexa=2` | Int      |  1           | 1    | Split all hexahedra in each direction by this factor, no refinement if `nFineHexa=1`         |