|
3 | 3 | Options |
4 | 4 | ======= |
5 | 5 |
|
6 | | -Here are the options currently available in pyHyp. |
7 | | - |
8 | | -.. list-table:: |
9 | | - :widths: 5 5 90 |
10 | | - :header-rows: 1 |
11 | | - |
12 | | - * - Parameter |
13 | | - - Type |
14 | | - - Description |
15 | | - |
16 | | - * - ``inputFile`` |
17 | | - - ``str`` |
18 | | - - Name of the file that contains the surface mesh. |
19 | | - This is a file that has been generated in an external meshing program, typically ICEMCFD. |
20 | | - |
21 | | - * - ``fileType`` |
22 | | - - ``str`` |
23 | | - - Type of the input file. |
24 | | - Use either ``Plot3d`` or ``CGNS``. |
25 | | - |
26 | | - * - ``unattachedEdgesAreSymmetry`` |
27 | | - - ``bool`` |
28 | | - - Automatically applies symmetry boundary conditions to any edges that do not interface with another block. |
29 | | - This option works in many cases but does not work for all surface meshes. |
30 | | - If you encounter negative volumes near the symmetry plane, try explicitly setting the symmetry boundary conditions using the ``BC`` option. |
31 | | - |
32 | | - * - ``outerFaceBC`` |
33 | | - - ``str`` |
34 | | - - Specifies the boundary condition at the outermost face of the extruded mesh. |
35 | | - Use either ``farfield`` or ``overset``. |
36 | | - |
37 | | - * - ``BC`` |
38 | | - - ``dict`` |
39 | | - - Specifies boundary condition information for specific block edges. See :ref:`here<pyhyp_BC>` for details. |
40 | | - |
41 | | - * - ``families`` |
42 | | - - ``str`` / ``dict`` |
43 | | - - Name given to wall surfaces. |
44 | | - If a dictionary is submitted, each wall patch can be named separately. |
45 | | - This can help with applying operations to specific wall patches. |
46 | | - |
47 | | - * - ``N`` |
48 | | - - ``int`` |
49 | | - - Number of grid levels to march. |
50 | | - This determines the grid dimension in the off-wall direction. |
51 | | - Typically this should be a "multi-grid" friendly number. |
52 | | - |
53 | | - * - ``s0`` |
54 | | - - ``float`` |
55 | | - - Initial off-wall (normal) spacing of grid. |
56 | | - This is taken to be constant across the entire geometry. |
57 | | - The units are consistent with the rest of the geometry. |
58 | | - |
59 | | - * - ``rMin`` |
60 | | - - ``float`` |
61 | | - - Relative distance in the normal direction to march. |
62 | | - It is specified as a multiple of the radius of the sphere enclosing the initial surface geometry. |
63 | | - If symmetry is specified, the full mirrored geometry is used to compute the sphere's radius. |
64 | | - Most wing geometries will have ``rMin`` between 10 and 20, that is the farfield boundary is 20 spans away from the geometry. |
65 | | - |
66 | | - * - ``cMax`` |
67 | | - - ``float`` |
68 | | - - The maximum permissible ratio of marching direction length to the any other in-plane edge. |
69 | | - This parameter effectively operates as a CFL-type limit. |
70 | | - If a step would require a step which would result in a ratio ``c`` greater than ``cMax``, the step is automatically split internally to respect this user-supplied limit. |
71 | | - Typical values of ``cMax`` are around 6-8. |
72 | | - Increased robustness can be achieved at the expense of computational cost by lowering ``cMax``. |
73 | | - |
74 | | - * - ``nonLinear`` |
75 | | - - ``float`` |
76 | | - - Use the nonlinear formulation. |
77 | | - This is experimental and not currently recommended and may not work at all. |
78 | | - |
79 | | - * - ``slExp`` |
80 | | - - ``float`` |
81 | | - - Exponent for the :math:`S_l` computation. |
82 | | - The :math:`S_l` value serves the same purpose as found in Chan et al. but the computation is different. |
83 | | - The :math:`S_l` computation in Chan is given as :math:`\sqrt{\frac{N-1}{l-1}}` for :math:`l > 2`. |
84 | | - |
85 | | - * - ``ps0`` |
86 | | - - ``float`` |
87 | | - - Initial pseudo offwall spacing. |
88 | | - This spacing **must** be less than or equal to ``s0``. |
89 | | - This is actual spacing the hyperbolic scheme uses. |
90 | | - The solver may take many pseudo steps before the first real grid level at ``s0``. |
91 | | - |
92 | | - * - ``pGridRatio`` |
93 | | - - ``float`` |
94 | | - - The ratio between successive levels in the pseudo grid. |
95 | | - This will be typically somewhere between ~1.05 for large grids to 1.2 for small grids. |
96 | | - This number is **not** the actual grid spacing of the final grid; that spacing ratio is computed and displayed at the beginning of a calculation. |
97 | | - The ``pGridRatio`` **must** be smaller than that number. |
98 | | - |
99 | | - * - ``epsE`` |
100 | | - - ``float`` |
101 | | - - The explict smoothing parameter. |
102 | | - See the :ref:`Theory<pyhyp_theory>` section for more information. |
103 | | - Typical values are approximately 1.0. Increasing the explicit smoothing may result in a smoother grid, at the expense of orhtogonality. |
104 | | - If the geometry is very sharp corners, too much explicit smoothing will cause the solver to rapidly "soften" the corner and the grid will fold back on itself. |
105 | | - In concave corners, additional smoothing will prevent lines from crossing (avoiding negative cells). |
106 | | - |
107 | | - * - ``epsI`` |
108 | | - - ``float`` |
109 | | - - Implicit smoothing parameter. |
110 | | - See the :ref:`Theory<pyhyp_theory>` section for more information. |
111 | | - Typical values are from 2.0 to 6.0. |
112 | | - Generally increasing the implicit coefficient results in a more stable solution procedure. |
113 | | - Usually this value should be twice the explicit smoothing parameter. |
114 | | - |
115 | | - * - ``theta`` |
116 | | - - ``float`` |
117 | | - - Kinsley-Barth coefficient See the :ref:`Theory<pyhyp_theory>` section for more information. |
118 | | - Only a single theta value is used for both directions. |
119 | | - Typical values are ~2.0 to ~4.0. |
120 | | - |
121 | | - * - ``volCoef`` |
122 | | - - ``float`` |
123 | | - - Coefficient used in point-Jacobi local volume smoothing algorithm. |
124 | | - Typically this value is 0.16 and need not be modified. |
125 | | - Use more ``volSmoothIter`` for stronger local smoothing. |
126 | | - |
127 | | - * - ``volBlend`` |
128 | | - - ``float`` |
129 | | - - The global volume blending coefficient. |
130 | | - See the :ref:`Theory<pyhyp_theory>` section for more information. |
131 | | - This value will typically be very small, especially if you widely varying cell sizes. |
132 | | - Typically values are from ~0 to 0.001. |
133 | | - Default is 0.0001. |
134 | | - |
135 | | - * - ``volSmoothIter`` |
136 | | - - ``int`` |
137 | | - - The number of point-Jacobi local volume smoothing iterations to perform. |
138 | | - Typical values are ~5 to ~25. |
139 | | - Default is 10. |
140 | | - |
141 | | - * - ``kspRelTol`` |
142 | | - - ``float`` |
143 | | - - Tolerance for the solution of the linear system at each iteration. |
144 | | - Typically :math:`1\times 10^{-8}` is sufficient. |
145 | | - Very difficult cases may benefit from a tighter convergence tolerance. |
146 | | - |
147 | | - * - ``kspMaxIts`` |
148 | | - - ``int`` |
149 | | - - Maximum number of iterations to perform for each step. |
150 | | - Default is 500 which should be sufficient for most cases. |
151 | | - |
152 | | - * - ``preConLag`` |
153 | | - - ``int`` |
154 | | - - Lag the update of the preconditioner by this number of iterations. |
155 | | - The default value of 10 will typically not need to be changed. |
156 | | - |
157 | | - * - ``kspSubspaceSize`` |
158 | | - - ``int`` |
159 | | - - Size of the ksp subspace. |
160 | | - Default is 50. |
161 | | - Very large and difficult problems may befefit from a larger subspace size. |
162 | | - |
163 | | - * - ``writeMetrics`` |
164 | | - - ``bool`` |
165 | | - - Flag to write the mesh gradients to the solution file. |
166 | | - This option should only be used for debugging purposes. |
| 6 | +.. optionstable:: pyhyp.pyHyp |
0 commit comments