ansys-fluent-core 0.30.dev2__py3-none-any.whl → 0.30.dev4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of ansys-fluent-core might be problematic. Click here for more details.

Files changed (78) hide show
  1. ansys/fluent/core/__init__.py +14 -3
  2. ansys/fluent/core/codegen/datamodelgen.py +17 -3
  3. ansys/fluent/core/codegen/settingsgen.py +26 -4
  4. ansys/fluent/core/codegen/walk_api.py +11 -1
  5. ansys/fluent/core/exceptions.py +7 -4
  6. ansys/fluent/core/generated/api_tree/api_objects.json +1 -1
  7. ansys/fluent/core/generated/datamodel_242/meshing_utilities.pyi +990 -0
  8. ansys/fluent/core/generated/datamodel_251/meshing_utilities.pyi +1002 -0
  9. ansys/fluent/core/generated/datamodel_252/meshing.py +7 -0
  10. ansys/fluent/core/generated/datamodel_252/meshing_utilities.pyi +1007 -0
  11. ansys/fluent/core/generated/datamodel_252/preferences.py +132 -3
  12. ansys/fluent/core/generated/fluent_version_252.py +3 -3
  13. ansys/fluent/core/generated/meshing/tui_252.py +111 -12
  14. ansys/fluent/core/generated/solver/settings_222.py +166 -170
  15. ansys/fluent/core/generated/solver/settings_222.pyi +10 -8
  16. ansys/fluent/core/generated/solver/settings_231.py +551 -598
  17. ansys/fluent/core/generated/solver/settings_231.pyi +40 -38
  18. ansys/fluent/core/generated/solver/settings_232.py +689 -736
  19. ansys/fluent/core/generated/solver/settings_232.pyi +39 -37
  20. ansys/fluent/core/generated/solver/settings_241.py +1365 -1439
  21. ansys/fluent/core/generated/solver/settings_241.pyi +1071 -1074
  22. ansys/fluent/core/generated/solver/settings_242.py +2852 -3098
  23. ansys/fluent/core/generated/solver/settings_242.pyi +2059 -2151
  24. ansys/fluent/core/generated/solver/settings_251.py +3656 -3914
  25. ansys/fluent/core/generated/solver/settings_251.pyi +2915 -3008
  26. ansys/fluent/core/generated/solver/settings_252.py +5894 -5707
  27. ansys/fluent/core/generated/solver/settings_252.pyi +4411 -4297
  28. ansys/fluent/core/generated/solver/tui_252.py +205 -25
  29. ansys/fluent/core/get_build_details.py +2 -2
  30. ansys/fluent/core/launcher/container_launcher.py +7 -1
  31. ansys/fluent/core/launcher/fluent_container.py +3 -2
  32. ansys/fluent/core/launcher/pim_launcher.py +7 -1
  33. ansys/fluent/core/launcher/slurm_launcher.py +7 -1
  34. ansys/fluent/core/launcher/standalone_launcher.py +7 -1
  35. ansys/fluent/core/services/datamodel_se.py +28 -23
  36. ansys/fluent/core/services/datamodel_tui.py +1 -1
  37. ansys/fluent/core/services/field_data.py +17 -5
  38. ansys/fluent/core/session_base_meshing.py +3 -3
  39. ansys/fluent/core/session_meshing.py +4 -4
  40. ansys/fluent/core/session_meshing.pyi +9 -9
  41. ansys/fluent/core/session_pure_meshing.pyi +9 -9
  42. ansys/fluent/core/session_solver.py +1 -1
  43. ansys/fluent/core/session_solver.pyi +5 -5
  44. ansys/fluent/core/solver/_docstrings.py +244 -0
  45. ansys/fluent/core/solver/error_message.py +7 -12
  46. ansys/fluent/core/solver/flobject.py +86 -27
  47. ansys/fluent/core/utils/fluent_version.py +2 -3
  48. ansys/fluent/core/utils/test_grpc_connection.py +139 -0
  49. ansys/fluent/core/workflow.py +1 -0
  50. {ansys_fluent_core-0.30.dev2.dist-info → ansys_fluent_core-0.30.dev4.dist-info}/METADATA +12 -12
  51. {ansys_fluent_core-0.30.dev2.dist-info → ansys_fluent_core-0.30.dev4.dist-info}/RECORD +77 -73
  52. ansys/fluent/core/_version.py +0 -40
  53. /ansys/fluent/core/generated/datamodel_222/{PartManagement.py → part_management.py} +0 -0
  54. /ansys/fluent/core/generated/datamodel_222/{PMFileManagement.py → pm_file_management.py} +0 -0
  55. /ansys/fluent/core/generated/datamodel_231/{PartManagement.py → part_management.py} +0 -0
  56. /ansys/fluent/core/generated/datamodel_231/{PMFileManagement.py → pm_file_management.py} +0 -0
  57. /ansys/fluent/core/generated/datamodel_231/{solverworkflow.py → solver_workflow.py} +0 -0
  58. /ansys/fluent/core/generated/datamodel_232/{PartManagement.py → part_management.py} +0 -0
  59. /ansys/fluent/core/generated/datamodel_232/{PMFileManagement.py → pm_file_management.py} +0 -0
  60. /ansys/fluent/core/generated/datamodel_232/{solverworkflow.py → solver_workflow.py} +0 -0
  61. /ansys/fluent/core/generated/datamodel_241/{PartManagement.py → part_management.py} +0 -0
  62. /ansys/fluent/core/generated/datamodel_241/{PMFileManagement.py → pm_file_management.py} +0 -0
  63. /ansys/fluent/core/generated/datamodel_241/{solverworkflow.py → solver_workflow.py} +0 -0
  64. /ansys/fluent/core/generated/datamodel_242/{MeshingUtilities.py → meshing_utilities.py} +0 -0
  65. /ansys/fluent/core/generated/datamodel_242/{PartManagement.py → part_management.py} +0 -0
  66. /ansys/fluent/core/generated/datamodel_242/{PMFileManagement.py → pm_file_management.py} +0 -0
  67. /ansys/fluent/core/generated/datamodel_242/{solverworkflow.py → solver_workflow.py} +0 -0
  68. /ansys/fluent/core/generated/datamodel_251/{MeshingUtilities.py → meshing_utilities.py} +0 -0
  69. /ansys/fluent/core/generated/datamodel_251/{PartManagement.py → part_management.py} +0 -0
  70. /ansys/fluent/core/generated/datamodel_251/{PMFileManagement.py → pm_file_management.py} +0 -0
  71. /ansys/fluent/core/generated/datamodel_251/{solverworkflow.py → solver_workflow.py} +0 -0
  72. /ansys/fluent/core/generated/datamodel_252/{MeshingUtilities.py → meshing_utilities.py} +0 -0
  73. /ansys/fluent/core/generated/datamodel_252/{PartManagement.py → part_management.py} +0 -0
  74. /ansys/fluent/core/generated/datamodel_252/{PMFileManagement.py → pm_file_management.py} +0 -0
  75. /ansys/fluent/core/generated/datamodel_252/{solverworkflow.py → solver_workflow.py} +0 -0
  76. /ansys/fluent/core/{systemcoupling.py → system_coupling.py} +0 -0
  77. {ansys_fluent_core-0.30.dev2.dist-info → ansys_fluent_core-0.30.dev4.dist-info}/LICENSE +0 -0
  78. {ansys_fluent_core-0.30.dev2.dist-info → ansys_fluent_core-0.30.dev4.dist-info}/WHEEL +0 -0
@@ -16,7 +16,7 @@ SHASH = "765e2322465ad0dce0f3a485fecd7758579360f595e5794ec0bbd90ed82ae94e"
16
16
 
17
17
  class single_precision_coordinates(Boolean):
18
18
  """
19
- Indicate whether to write nodal coordinates in single precision.
19
+ Specifies whether to write nodal coordinates in single precision.
20
20
  """
21
21
  version = '231'
22
22
  fluent_name = 'single-precision-coordinates?'
@@ -25,7 +25,7 @@ class single_precision_coordinates(Boolean):
25
25
 
26
26
  class binary_legacy_files(Boolean):
27
27
  """
28
- Indicate whether to write binary or text format case and data files.
28
+ Specifies whether to write binary or text format case and data files.
29
29
  """
30
30
  version = '231'
31
31
  fluent_name = 'binary-legacy-files?'
@@ -34,7 +34,7 @@ class binary_legacy_files(Boolean):
34
34
 
35
35
  class cff_files(Boolean):
36
36
  """
37
- Indicate whether to write ANSYS common fluids format (CFF) files or legacy case and data files.
37
+ Specifies whether to write ANSYS common fluids format (CFF) files or legacy case and data files.
38
38
  """
39
39
  version = '231'
40
40
  fluent_name = 'cff-files?'
@@ -43,7 +43,7 @@ class cff_files(Boolean):
43
43
 
44
44
  class async_optimize(Boolean):
45
45
  """
46
- Choose whether to optimize file IO using scratch disks and asynchronous operations.
46
+ Specifies whether to optimize file IO using scratch disks and asynchronous operations.
47
47
  """
48
48
  version = '231'
49
49
  fluent_name = 'async-optimize?'
@@ -52,7 +52,7 @@ class async_optimize(Boolean):
52
52
 
53
53
  class write_pdat(Boolean):
54
54
  """
55
- Indicate whether to attempt to save pdat files.
55
+ Specifies whether to attempt to save pdat files.
56
56
  """
57
57
  version = '231'
58
58
  fluent_name = 'write-pdat?'
@@ -61,7 +61,7 @@ class write_pdat(Boolean):
61
61
 
62
62
  class confirm_overwrite(Boolean):
63
63
  """
64
- Indicate whether or not to confirm attempts to overwrite existing files.
64
+ Specifies whether to confirm attempts to overwrite existing files.
65
65
  """
66
66
  version = '231'
67
67
  fluent_name = 'confirm-overwrite?'
@@ -118,7 +118,7 @@ class write_sc_file(Command):
118
118
 
119
119
  class sc_def_file_settings(Group):
120
120
  """
121
- File menu.
121
+ File object.
122
122
  """
123
123
  version = '231'
124
124
  fluent_name = 'sc-def-file-settings'
@@ -160,7 +160,7 @@ class set_cgns_export_filetype(Command):
160
160
 
161
161
  class settings(Group):
162
162
  """
163
- Enter the export settings menu.
163
+ The export settings object.
164
164
  """
165
165
  version = '231'
166
166
  fluent_name = 'settings'
@@ -730,7 +730,7 @@ class parametric_project(Group):
730
730
 
731
731
  class case_frequency(String, AllowedValuesMixin):
732
732
  """
733
- Set the preference for saving case files.
733
+ The preference for saving case files.
734
734
  """
735
735
  version = '231'
736
736
  fluent_name = 'case-frequency'
@@ -739,7 +739,7 @@ class case_frequency(String, AllowedValuesMixin):
739
739
 
740
740
  class data_frequency(Real):
741
741
  """
742
- Set the iteration or time step increment for saving data files.
742
+ The iteration or time step increment for saving data files.
743
743
  """
744
744
  version = '231'
745
745
  fluent_name = 'data-frequency'
@@ -748,7 +748,7 @@ class data_frequency(Real):
748
748
 
749
749
  class root_name(String):
750
750
  """
751
- Set the root name for auto-saved files. The number of iterations or time steps will be appended to this root name.
751
+ The root name for auto-saved files. The number of iterations or time steps will be appended to this root name.
752
752
  """
753
753
  version = '231'
754
754
  fluent_name = 'root-name'
@@ -766,7 +766,7 @@ class retain_most_recent_files(Boolean):
766
766
 
767
767
  class max_files(Integer):
768
768
  """
769
- Set the maximum number of data files to save. After the maximum is reached, a file will be deleted for each file saved.
769
+ The maximum number of data files to save. After the maximum is reached, a file will be deleted for each file saved.
770
770
  """
771
771
  version = '231'
772
772
  fluent_name = 'max-files'
@@ -793,7 +793,7 @@ class file_decimal_digit(Integer):
793
793
 
794
794
  class append_file_name_with(Group):
795
795
  """
796
- Set the suffix for auto-saved files. The file name can be appended by flow-time, time-step value or by user specified flags in file name.
796
+ The suffix for auto-saved files. The file name can be appended by flow-time, time-step value or by user specified flags in file name.
797
797
  """
798
798
  version = '231'
799
799
  fluent_name = 'append-file-name-with'
@@ -807,7 +807,7 @@ class append_file_name_with(Group):
807
807
 
808
808
  class frequency_type(String, AllowedValuesMixin):
809
809
  """
810
- Set the auto save frequency type to either time-step or crank-angle and set the corresponding frequency.
810
+ The auto save frequency type to either time-step or crank-angle and set the corresponding frequency.
811
811
  """
812
812
  version = '231'
813
813
  fluent_name = 'frequency-type'
@@ -825,7 +825,7 @@ class save_frequency(Real):
825
825
 
826
826
  class save_data_file_every(Group):
827
827
  """
828
- Set the auto save frequency type to either time-step or crank-angle and set the corresponding frequency.
828
+ The auto save frequency type to either time-step or crank-angle and set the corresponding frequency.
829
829
  """
830
830
  version = '231'
831
831
  fluent_name = 'save-data-file-every'
@@ -1124,7 +1124,7 @@ class refinement_criteria(String):
1124
1124
 
1125
1125
  class coarsening_criteria(String):
1126
1126
  """
1127
- Set expression for coarsening criterion.
1127
+ Expression for coarsening criterion.
1128
1128
  """
1129
1129
  version = '231'
1130
1130
  fluent_name = 'coarsening-criteria'
@@ -1133,7 +1133,7 @@ class coarsening_criteria(String):
1133
1133
 
1134
1134
  class manual_refinement_criteria(String):
1135
1135
  """
1136
- Set expression for manual refinement criterion.
1136
+ Expression for manual refinement criterion.
1137
1137
  """
1138
1138
  version = '231'
1139
1139
  fluent_name = 'manual-refinement-criteria'
@@ -1142,7 +1142,7 @@ class manual_refinement_criteria(String):
1142
1142
 
1143
1143
  class manual_coarsening_criteria(String):
1144
1144
  """
1145
- Set expression for manual coarsening criterion.
1145
+ Expression for manual coarsening criterion.
1146
1146
  """
1147
1147
  version = '231'
1148
1148
  fluent_name = 'manual-coarsening-criteria'
@@ -1151,7 +1151,7 @@ class manual_coarsening_criteria(String):
1151
1151
 
1152
1152
  class anisotropic_boundary_zones(StringList):
1153
1153
  """
1154
- Set the boundary zones to specify directions for anisotropic refinement.
1154
+ The boundary zones to specify directions for anisotropic refinement.
1155
1155
  """
1156
1156
  version = '231'
1157
1157
  fluent_name = 'anisotropic-boundary-zones'
@@ -1160,7 +1160,7 @@ class anisotropic_boundary_zones(StringList):
1160
1160
 
1161
1161
  class cell_zones(StringList):
1162
1162
  """
1163
- Set cell zones to be used for marking adaption. An empty list implies that all zones are considered for adaption.
1163
+ Cell zones to be used for marking adaption. An empty list implies that all zones are considered for adaption.
1164
1164
  """
1165
1165
  version = '231'
1166
1166
  fluent_name = 'cell-zones'
@@ -1169,7 +1169,7 @@ class cell_zones(StringList):
1169
1169
 
1170
1170
  class dynamic_adaption_frequency(Integer):
1171
1171
  """
1172
- Set frequency for dynamic adaption.
1172
+ Frequency for dynamic adaption.
1173
1173
  """
1174
1174
  version = '231'
1175
1175
  fluent_name = 'dynamic-adaption-frequency'
@@ -1178,7 +1178,7 @@ class dynamic_adaption_frequency(Integer):
1178
1178
 
1179
1179
  class verbosity(Integer):
1180
1180
  """
1181
- Set the adaption verbosity.
1181
+ The adaption verbosity.
1182
1182
  """
1183
1183
  version = '231'
1184
1184
  fluent_name = 'verbosity'
@@ -1196,7 +1196,7 @@ class encapsulate_children(Boolean):
1196
1196
 
1197
1197
  class maximum_refinement_level(Integer):
1198
1198
  """
1199
- Set maximum level of refinement in the mesh.
1199
+ Maximum level of refinement in the mesh.
1200
1200
  """
1201
1201
  version = '231'
1202
1202
  fluent_name = 'maximum-refinement-level'
@@ -1205,7 +1205,7 @@ class maximum_refinement_level(Integer):
1205
1205
 
1206
1206
  class minimum_cell_quality(Real):
1207
1207
  """
1208
- Set limit on the minimum cell orthogonal quality during adaption.
1208
+ Limit on the minimum cell orthogonal quality during adaption.
1209
1209
  """
1210
1210
  version = '231'
1211
1211
  fluent_name = 'minimum-cell-quality'
@@ -1214,7 +1214,7 @@ class minimum_cell_quality(Real):
1214
1214
 
1215
1215
  class maximum_cell_count(Integer):
1216
1216
  """
1217
- Set limit on the maximum number of cells during adaption.
1217
+ Limit on the maximum number of cells during adaption.
1218
1218
  """
1219
1219
  version = '231'
1220
1220
  fluent_name = 'maximum-cell-count'
@@ -1223,7 +1223,7 @@ class maximum_cell_count(Integer):
1223
1223
 
1224
1224
  class additional_refinement_layers(Integer):
1225
1225
  """
1226
- Set the number of additional cell layers for refinement.
1226
+ The number of additional cell layers for refinement.
1227
1227
  """
1228
1228
  version = '231'
1229
1229
  fluent_name = 'additional-refinement-layers'
@@ -1250,7 +1250,7 @@ class minimum_edge_length(Real):
1250
1250
 
1251
1251
  class anisotropic_split_ratio(Real):
1252
1252
  """
1253
- Set the split ratio for anisotropic refinement of prismatic cells.
1253
+ The split ratio for anisotropic refinement of prismatic cells.
1254
1254
  """
1255
1255
  version = '231'
1256
1256
  fluent_name = 'anisotropic-split-ratio'
@@ -1295,7 +1295,7 @@ class dynamic_adaption(Command):
1295
1295
 
1296
1296
  class set(Group):
1297
1297
  """
1298
- Enter the adaption set menu.
1298
+ The adaption set object.
1299
1299
  """
1300
1300
  version = '231'
1301
1301
  fluent_name = 'set'
@@ -1358,7 +1358,7 @@ class clear(Command):
1358
1358
 
1359
1359
  class profile(Group):
1360
1360
  """
1361
- Enter the adaption profile menu.
1361
+ The adaption profile object.
1362
1362
  """
1363
1363
  version = '231'
1364
1364
  fluent_name = 'profile'
@@ -1419,7 +1419,7 @@ class parameters(Command):
1419
1419
 
1420
1420
  class multi_layer_refinement(Group):
1421
1421
  """
1422
- Enter the multiple boundary layer refinement menu.
1422
+ The multiple boundary layer refinement object.
1423
1423
  """
1424
1424
  version = '231'
1425
1425
  fluent_name = 'multi-layer-refinement'
@@ -1444,7 +1444,7 @@ class reconstruct_geometry(Boolean):
1444
1444
 
1445
1445
  class geometry(Group):
1446
1446
  """
1447
- Enter the adaption geometry menu.
1447
+ The adaption geometry object.
1448
1448
  """
1449
1449
  version = '231'
1450
1450
  fluent_name = 'geometry'
@@ -1509,7 +1509,7 @@ class adapt(Group):
1509
1509
 
1510
1510
  class check_before_solve(Boolean):
1511
1511
  """
1512
- Perform various mesh consistency checks before solve.
1512
+ Specifies whether to perform various mesh consistency checks before solve.
1513
1513
  """
1514
1514
  version = '231'
1515
1515
  fluent_name = 'check-before-solve?'
@@ -1518,7 +1518,7 @@ class check_before_solve(Boolean):
1518
1518
 
1519
1519
  class check_verbosity(Integer):
1520
1520
  """
1521
- Set verbosity output of mesh check and mesh quality. Higher verbosity corresponds to more detailed information.
1521
+ Verbosity output of mesh check and mesh quality. Higher verbosity corresponds to more detailed information.
1522
1522
  """
1523
1523
  version = '231'
1524
1524
  fluent_name = 'check-verbosity'
@@ -1536,7 +1536,7 @@ class enhanced_orthogonal_quality(Boolean):
1536
1536
 
1537
1537
  class matching_tolerance(Real):
1538
1538
  """
1539
- Set the normalized tolerance used for finding coincident nodes.
1539
+ The normalized tolerance used for finding coincident nodes.
1540
1540
  """
1541
1541
  version = '231'
1542
1542
  fluent_name = 'matching-tolerance'
@@ -1581,7 +1581,7 @@ class reorder_zones(Command):
1581
1581
 
1582
1582
  class reorder(Group):
1583
1583
  """
1584
- Enter the reorder domain menu.
1584
+ The reorder domain object.
1585
1585
  """
1586
1586
  version = '231'
1587
1587
  fluent_name = 'reorder'
@@ -1707,7 +1707,7 @@ class repair_wall_distance(Command):
1707
1707
 
1708
1708
  class repair_improve(Group):
1709
1709
  """
1710
- Enter the repair and improve quality menu.
1710
+ The repair and improve quality object.
1711
1711
  """
1712
1712
  version = '231'
1713
1713
  fluent_name = 'repair-improve'
@@ -1794,7 +1794,7 @@ class read_2(Command):
1794
1794
 
1795
1795
  class surface_mesh(Group):
1796
1796
  """
1797
- Enter the surface mesh menu.
1797
+ The surface mesh object.
1798
1798
  """
1799
1799
  version = '231'
1800
1800
  fluent_name = 'surface-mesh'
@@ -1809,7 +1809,7 @@ class surface_mesh(Group):
1809
1809
 
1810
1810
  class migrate_and_reorder(Boolean):
1811
1811
  """
1812
- Perform migration and reordering at the end of the polyhedra conversion.
1812
+ Specifies whether to perform migration and reordering at the end of the polyhedra conversion.
1813
1813
  """
1814
1814
  version = '231'
1815
1815
  fluent_name = 'migrate-and-reorder?'
@@ -1838,7 +1838,7 @@ class preserve_interior_zones(String):
1838
1838
 
1839
1839
  class options(Group):
1840
1840
  """
1841
- Enter options menu.
1841
+ Options object.
1842
1842
  """
1843
1843
  version = '231'
1844
1844
  fluent_name = 'options'
@@ -1881,7 +1881,7 @@ class convert_hanging_node_zones(Command):
1881
1881
 
1882
1882
  class cell_thread_list(StringList):
1883
1883
  """
1884
- Set zones where cells should be converted.
1884
+ Zones where cells should be converted.
1885
1885
  """
1886
1886
  version = '231'
1887
1887
  fluent_name = 'cell-thread-list'
@@ -1890,7 +1890,7 @@ class cell_thread_list(StringList):
1890
1890
 
1891
1891
  class max_cell_skewness(Real):
1892
1892
  """
1893
- Set target maximum cell skewness.
1893
+ Target maximum cell skewness.
1894
1894
  """
1895
1895
  version = '231'
1896
1896
  fluent_name = 'max-cell-skewness'
@@ -1923,7 +1923,7 @@ class convert_skewed_cells(Command):
1923
1923
 
1924
1924
  class polyhedra(Group):
1925
1925
  """
1926
- Enter the polyhedra menu.
1926
+ The polyhedra object.
1927
1927
  """
1928
1928
  version = '231'
1929
1929
  fluent_name = 'polyhedra'
@@ -2385,7 +2385,7 @@ class server(Group):
2385
2385
 
2386
2386
  class type(String, AllowedValuesMixin):
2387
2387
  """
2388
- Select solver type.
2388
+ Solver type.
2389
2389
  """
2390
2390
  version = '231'
2391
2391
  fluent_name = 'type'
@@ -2403,7 +2403,7 @@ class two_dim_space(String, AllowedValuesMixin):
2403
2403
 
2404
2404
  class velocity_formulation(String, AllowedValuesMixin):
2405
2405
  """
2406
- Set velocity formulation.
2406
+ Velocity formulation.
2407
2407
  """
2408
2408
  version = '231'
2409
2409
  fluent_name = 'velocity-formulation'
@@ -2446,7 +2446,7 @@ class adjust_solver_defaults_based_on_setup(Boolean):
2446
2446
 
2447
2447
  class enable_2(Boolean):
2448
2448
  """
2449
- Set gravitational acceleration.
2449
+ Gravitational acceleration.
2450
2450
  """
2451
2451
  version = '231'
2452
2452
  fluent_name = 'enable?'
@@ -2511,7 +2511,7 @@ class contour_plotting_option(String, AllowedValuesMixin):
2511
2511
 
2512
2512
  class option(String, AllowedValuesMixin):
2513
2513
  """
2514
- Select the interphase coupling option.
2514
+ The interphase coupling option.
2515
2515
  """
2516
2516
  version = '231'
2517
2517
  fluent_name = 'option'
@@ -2553,7 +2553,7 @@ class interaction(Group):
2553
2553
 
2554
2554
  class option_1(String, AllowedValuesMixin):
2555
2555
  """
2556
- Select the unsteady particle tracking option.
2556
+ The unsteady particle tracking option.
2557
2557
  """
2558
2558
  version = '231'
2559
2559
  fluent_name = 'option'
@@ -2571,7 +2571,7 @@ class create_particles_every_particle_step(Boolean):
2571
2571
 
2572
2572
  class dpm_time_step(Real):
2573
2573
  """
2574
- Set the particle time step.
2574
+ The particle time step.
2575
2575
  """
2576
2576
  version = '231'
2577
2577
  fluent_name = 'dpm-time-step'
@@ -2580,7 +2580,7 @@ class dpm_time_step(Real):
2580
2580
 
2581
2581
  class n_time_steps(Integer):
2582
2582
  """
2583
- Set number of steps particles are advanced in time.
2583
+ Number of steps particles are advanced in time.
2584
2584
  """
2585
2585
  version = '231'
2586
2586
  fluent_name = 'n-time-steps'
@@ -2615,13 +2615,7 @@ class unsteady_tracking(Group):
2615
2615
 
2616
2616
  class general_settings(Group):
2617
2617
  """
2618
- Main menu to allow users to set options controlling:
2619
-
2620
- - the optional generation of averaged dpm variables on the fluid mesh to be used for post-processing,
2621
- - the interaction between the discrete particles and their carrier phase,
2622
- - the handling of unsteady particles.
2623
-
2624
- For more details please consult the help option of the corresponding menu or TUI command.
2618
+ Main object.
2625
2619
  """
2626
2620
  version = '231'
2627
2621
  fluent_name = 'general-settings'
@@ -4031,7 +4025,7 @@ class average_every_step(Boolean):
4031
4025
 
4032
4026
  class kernel(String, AllowedValuesMixin):
4033
4027
  """
4034
- Specify a kernel for the averaging.
4028
+ A kernel for the averaging.
4035
4029
  """
4036
4030
  version = '231'
4037
4031
  fluent_name = 'kernel'
@@ -4040,7 +4034,7 @@ class kernel(String, AllowedValuesMixin):
4040
4034
 
4041
4035
  class gaussian_factor(Real):
4042
4036
  """
4043
- Set a factor for the gaussian kernel for node-based averaging.~%Large values give small size, small values give large size of kernel.
4037
+ A factor for the gaussian kernel for node-based averaging.~%Large values give small size, small values give large size of kernel.
4044
4038
  """
4045
4039
  version = '231'
4046
4040
  fluent_name = 'gaussian-factor'
@@ -4176,7 +4170,7 @@ class source_terms(Group):
4176
4170
 
4177
4171
  class scheme(String, AllowedValuesMixin):
4178
4172
  """
4179
- Select a tracking scheme used for DPM.
4173
+ A tracking scheme used for DPM.
4180
4174
  """
4181
4175
  version = '231'
4182
4176
  fluent_name = 'scheme'
@@ -4185,7 +4179,7 @@ class scheme(String, AllowedValuesMixin):
4185
4179
 
4186
4180
  class low_order_scheme(String, AllowedValuesMixin):
4187
4181
  """
4188
- Select a low-order tracking scheme used for automated tracking scheme selection.
4182
+ A low-order tracking scheme used for automated tracking scheme selection.
4189
4183
  """
4190
4184
  version = '231'
4191
4185
  fluent_name = 'low-order-scheme'
@@ -4194,7 +4188,7 @@ class low_order_scheme(String, AllowedValuesMixin):
4194
4188
 
4195
4189
  class high_order_scheme(String, AllowedValuesMixin):
4196
4190
  """
4197
- Select a high-order tracking scheme used for automated tracking scheme selection.
4191
+ A high-order tracking scheme used for automated tracking scheme selection.
4198
4192
  """
4199
4193
  version = '231'
4200
4194
  fluent_name = 'high-order-scheme'
@@ -4212,7 +4206,7 @@ class option_4(Boolean):
4212
4206
 
4213
4207
  class max_number_of_refinements(Integer):
4214
4208
  """
4215
- Set the maximum number of step size refinements if error control is active.
4209
+ The maximum number of step size refinements if error control is active.
4216
4210
  """
4217
4211
  version = '231'
4218
4212
  fluent_name = 'max-number-of-refinements'
@@ -4221,7 +4215,7 @@ class max_number_of_refinements(Integer):
4221
4215
 
4222
4216
  class tolerance(Real):
4223
4217
  """
4224
- Set the maximum number of step size refinements if error control is active.
4218
+ The maximum number of step size refinements if error control is active.
4225
4219
  """
4226
4220
  version = '231'
4227
4221
  fluent_name = 'tolerance'
@@ -4261,9 +4255,7 @@ class tracking_1(Group):
4261
4255
 
4262
4256
  class numerics(Group):
4263
4257
  """
4264
- Main menu to allow users to set options controlling the solution of ordinary differential equations describing
4265
- the underlying physics of the Discrete Phase Model.
4266
- For more details consult the help option of the corresponding menu or TUI command.
4258
+ Main object.
4267
4259
  """
4268
4260
  version = '231'
4269
4261
  fluent_name = 'numerics'
@@ -4278,7 +4270,7 @@ class numerics(Group):
4278
4270
 
4279
4271
  class option_5(String, AllowedValuesMixin):
4280
4272
  """
4281
- Select a parallel scheme used for DPM.
4273
+ A parallel scheme used for DPM.
4282
4274
  """
4283
4275
  version = '231'
4284
4276
  fluent_name = 'option'
@@ -4287,7 +4279,7 @@ class option_5(String, AllowedValuesMixin):
4287
4279
 
4288
4280
  class parallel_verbosity_level(Integer):
4289
4281
  """
4290
- Set the parallel verbosity level [0]: none.
4282
+ The parallel verbosity level [0]: none.
4291
4283
  """
4292
4284
  version = '231'
4293
4285
  fluent_name = 'parallel-verbosity-level'
@@ -4296,7 +4288,7 @@ class parallel_verbosity_level(Integer):
4296
4288
 
4297
4289
  class crossover_tolerance(Real):
4298
4290
  """
4299
- Set the fraction a particle is moved towards the cell center (0: not moved, 1: moved to cell center).
4291
+ The fraction a particle is moved towards the cell center (0: not moved, 1: moved to cell center).
4300
4292
  """
4301
4293
  version = '231'
4302
4294
  fluent_name = 'crossover-tolerance'
@@ -4328,7 +4320,7 @@ class option_6(Boolean):
4328
4320
 
4329
4321
  class partitioning_method_for_dpm_domain(String, AllowedValuesMixin):
4330
4322
  """
4331
- Set the DPM domain partitioning method.
4323
+ The DPM domain partitioning method.
4332
4324
  """
4333
4325
  version = '231'
4334
4326
  fluent_name = 'partitioning-method-for-dpm-domain'
@@ -4374,8 +4366,7 @@ class hybrid_options(Group):
4374
4366
 
4375
4367
  class parallel_1(Group):
4376
4368
  """
4377
- Main menu to allow users to set options controlling the parallel scheme used when tracking particles.
4378
- For more details please consult the help option of the corresponding menu or TUI command.
4369
+ Main object.
4379
4370
  """
4380
4371
  version = '231'
4381
4372
  fluent_name = 'parallel'
@@ -4421,7 +4412,7 @@ class option_8(Boolean):
4421
4412
 
4422
4413
  class virtual_mass_factor(Real):
4423
4414
  """
4424
- Set the virtual mass factor.
4415
+ The virtual mass factor.
4425
4416
  """
4426
4417
  version = '231'
4427
4418
  fluent_name = 'virtual-mass-factor'
@@ -4453,8 +4444,7 @@ class option_9(Boolean):
4453
4444
 
4454
4445
  class max_vf_allowed_for_blocking(Real):
4455
4446
  """
4456
- Set the maximum value for the DPM volume fraction used in the continuous flow when the volume displacement option is active.
4457
- A default of 0.95 is recommendend.
4447
+ The maximum value for the DPM volume fraction used in the continuous flow when the volume displacement option is active.
4458
4448
  """
4459
4449
  version = '231'
4460
4450
  fluent_name = 'max-vf-allowed-for-blocking'
@@ -4535,7 +4525,7 @@ class report_leidenfrost_temperature(Boolean):
4535
4525
 
4536
4526
  class set_offset_above_film_boiling_temperature(Real):
4537
4527
  """
4538
- Set the temperature difference above the film boiling point.
4528
+ The temperature difference above the film boiling point.
4539
4529
  """
4540
4530
  version = '231'
4541
4531
  fluent_name = 'set-offset-above-film-boiling-temperature'
@@ -4574,7 +4564,7 @@ class wall_film(Group):
4574
4564
 
4575
4565
  class physical_models(Group):
4576
4566
  """
4577
- Main menu to enable the required physical submodels for the discrete phase model.
4567
+ Main object.
4578
4568
  """
4579
4569
  version = '231'
4580
4570
  fluent_name = 'physical-models'
@@ -4626,7 +4616,7 @@ class tracking_statistics_format(Integer):
4626
4616
 
4627
4617
  class verbosity_1(Integer):
4628
4618
  """
4629
- Set the DPM tracker's verbosity level.
4619
+ The DPM tracker's verbosity level.
4630
4620
  """
4631
4621
  version = '231'
4632
4622
  fluent_name = 'verbosity'
@@ -4714,7 +4704,7 @@ class zero_nodal_velocities_on_walls(Boolean):
4714
4704
 
4715
4705
  class interpolation(Group):
4716
4706
  """
4717
- Main menu holding options to enable/disable interpolation of flow data to the particle position.
4707
+ Main object.
4718
4708
  """
4719
4709
  version = '231'
4720
4710
  fluent_name = 'interpolation'
@@ -4786,7 +4776,7 @@ class load_legacy_particles(Boolean):
4786
4776
 
4787
4777
  class overset_relocation_robustness_level(Integer):
4788
4778
  """
4789
- Set the robustness level for particle relocation in overset meshes.
4779
+ The robustness level for particle relocation in overset meshes.
4790
4780
  """
4791
4781
  version = '231'
4792
4782
  fluent_name = 'overset-relocation-robustness-level'
@@ -4804,7 +4794,7 @@ class use_legacy_particle_location_method(Boolean):
4804
4794
 
4805
4795
  class particle_relocation(Group):
4806
4796
  """
4807
- Main menu holding information options to control relocating particles during case file reading or remeshing/adaption.
4797
+ Main object.
4808
4798
  """
4809
4799
  version = '231'
4810
4800
  fluent_name = 'particle-relocation'
@@ -4847,12 +4837,7 @@ class use_quad_face_centroid(Boolean):
4847
4837
 
4848
4838
  class high_res_tracking_options(Group):
4849
4839
  """
4850
- Main menu containing settings that control the High-Res Tracking scheme.
4851
- When the High-Res Tracking option is enabled (default), the computational cells are decomposed into tetrahedrons
4852
- (subtets) and the particles tracked through the subtets. This option provides a more robust tracking
4853
- algorithm and improved variable interpolation. If High-Res Tracking is not enabled, particles are tracked through
4854
- the computational cells directly. Flow variables that appear in particle equations either use cell-center values
4855
- or a truncated Taylor series approximation for interpolation to the particle position.
4840
+ Main object.
4856
4841
  """
4857
4842
  version = '231'
4858
4843
  fluent_name = 'high-res-tracking-options'
@@ -4874,7 +4859,7 @@ class high_res_tracking_options(Group):
4874
4859
 
4875
4860
  class control_by(String, AllowedValuesMixin):
4876
4861
  """
4877
- Select the option to determine the initial tracking step length.
4862
+ The option to determine the initial tracking step length.
4878
4863
  """
4879
4864
  version = '231'
4880
4865
  fluent_name = 'control-by'
@@ -4883,7 +4868,7 @@ class control_by(String, AllowedValuesMixin):
4883
4868
 
4884
4869
  class max_number_of_steps(Integer):
4885
4870
  """
4886
- Set the maximum number of integration steps per particle.
4871
+ The maximum number of integration steps per particle.
4887
4872
  """
4888
4873
  version = '231'
4889
4874
  fluent_name = 'max-number-of-steps'
@@ -4892,7 +4877,7 @@ class max_number_of_steps(Integer):
4892
4877
 
4893
4878
  class length_scale(Real):
4894
4879
  """
4895
- Set the tracking step length scale.
4880
+ The tracking step length scale.
4896
4881
  """
4897
4882
  version = '231'
4898
4883
  fluent_name = 'length-scale'
@@ -4901,7 +4886,7 @@ class length_scale(Real):
4901
4886
 
4902
4887
  class step_length_factor(Integer):
4903
4888
  """
4904
- Set the tracking step length factor.
4889
+ The tracking step length factor.
4905
4890
  """
4906
4891
  version = '231'
4907
4892
  fluent_name = 'step-length-factor'
@@ -4910,10 +4895,7 @@ class step_length_factor(Integer):
4910
4895
 
4911
4896
  class tracking_parameters(Group):
4912
4897
  """
4913
- Main menu to control the time integration of the particle trajectory equations:
4914
-
4915
- - the maximum number of steps; the trajectory calculation is stopped and the particle aborted when the particle reaches this limit.
4916
- - the length scale/step length factor; this factor is used to set the time step size for integration within a cell.
4898
+ Main object.
4917
4899
  """
4918
4900
  version = '231'
4919
4901
  fluent_name = 'tracking-parameters'
@@ -4938,7 +4920,7 @@ class track_in_absolute_frame(Boolean):
4938
4920
 
4939
4921
  class tracking(Group):
4940
4922
  """
4941
- Main menu to control the time integration of the particle trajectory equations.
4923
+ Main object.
4942
4924
  """
4943
4925
  version = '231'
4944
4926
  fluent_name = 'tracking'
@@ -4955,7 +4937,7 @@ class tracking(Group):
4955
4937
 
4956
4938
  class body_force_function(String, AllowedValuesMixin):
4957
4939
  """
4958
- Specify the name of the DPM body force function.
4940
+ The name of the DPM body force function.
4959
4941
  """
4960
4942
  version = '231'
4961
4943
  fluent_name = 'body-force-function'
@@ -4964,7 +4946,7 @@ class body_force_function(String, AllowedValuesMixin):
4964
4946
 
4965
4947
  class collision_function(String, AllowedValuesMixin):
4966
4948
  """
4967
- Specify the name of the DPM collision function.
4949
+ The name of the DPM collision function.
4968
4950
  """
4969
4951
  version = '231'
4970
4952
  fluent_name = 'collision-function'
@@ -4973,7 +4955,7 @@ class collision_function(String, AllowedValuesMixin):
4973
4955
 
4974
4956
  class dpm_time_step_function(String, AllowedValuesMixin):
4975
4957
  """
4976
- Specify the name of the DPM timestep function.
4958
+ The name of the DPM timestep function.
4977
4959
  """
4978
4960
  version = '231'
4979
4961
  fluent_name = 'dpm-time-step-function'
@@ -4982,7 +4964,7 @@ class dpm_time_step_function(String, AllowedValuesMixin):
4982
4964
 
4983
4965
  class erosion_accretion_function(String, AllowedValuesMixin):
4984
4966
  """
4985
- Specify the name of the DPM erosion/accretion function.
4967
+ The name of the DPM erosion/accretion function.
4986
4968
  """
4987
4969
  version = '231'
4988
4970
  fluent_name = 'erosion-accretion-function'
@@ -4991,7 +4973,7 @@ class erosion_accretion_function(String, AllowedValuesMixin):
4991
4973
 
4992
4974
  class film_regime_function(String, AllowedValuesMixin):
4993
4975
  """
4994
- Specify the name of the film regime function.
4976
+ The name of the film regime function.
4995
4977
  """
4996
4978
  version = '231'
4997
4979
  fluent_name = 'film-regime-function'
@@ -5000,7 +4982,7 @@ class film_regime_function(String, AllowedValuesMixin):
5000
4982
 
5001
4983
  class interpolation_function(String, AllowedValuesMixin):
5002
4984
  """
5003
- Specify the name of the interpolation function.
4985
+ The name of the interpolation function.
5004
4986
  """
5005
4987
  version = '231'
5006
4988
  fluent_name = 'interpolation-function'
@@ -5009,7 +4991,7 @@ class interpolation_function(String, AllowedValuesMixin):
5009
4991
 
5010
4992
  class impingement_model_function(String, AllowedValuesMixin):
5011
4993
  """
5012
- Specify the name of the impingement model function.
4994
+ The name of the impingement model function.
5013
4995
  """
5014
4996
  version = '231'
5015
4997
  fluent_name = 'impingement-model-function'
@@ -5018,7 +5000,7 @@ class impingement_model_function(String, AllowedValuesMixin):
5018
5000
 
5019
5001
  class output_function(String, AllowedValuesMixin):
5020
5002
  """
5021
- Specify the name of the DPM output function.
5003
+ The name of the DPM output function.
5022
5004
  """
5023
5005
  version = '231'
5024
5006
  fluent_name = 'output-function'
@@ -5027,7 +5009,7 @@ class output_function(String, AllowedValuesMixin):
5027
5009
 
5028
5010
  class scalar_update_function(String, AllowedValuesMixin):
5029
5011
  """
5030
- Specify the name of the DPM scalar update function.
5012
+ The name of the DPM scalar update function.
5031
5013
  """
5032
5014
  version = '231'
5033
5015
  fluent_name = 'scalar-update-function'
@@ -5036,7 +5018,7 @@ class scalar_update_function(String, AllowedValuesMixin):
5036
5018
 
5037
5019
  class source_function(String, AllowedValuesMixin):
5038
5020
  """
5039
- Specify the name of the DPM source function.
5021
+ The name of the DPM source function.
5040
5022
  """
5041
5023
  version = '231'
5042
5024
  fluent_name = 'source-function'
@@ -5045,7 +5027,7 @@ class source_function(String, AllowedValuesMixin):
5045
5027
 
5046
5028
  class splashing_distribution_function(String, AllowedValuesMixin):
5047
5029
  """
5048
- Specify the name of the splashing distribution function.
5030
+ The name of the splashing distribution function.
5049
5031
  """
5050
5032
  version = '231'
5051
5033
  fluent_name = 'splashing-distribution-function'
@@ -5054,7 +5036,7 @@ class splashing_distribution_function(String, AllowedValuesMixin):
5054
5036
 
5055
5037
  class number_of_scalars(Integer):
5056
5038
  """
5057
- Specify the number of user reals stored on a particle.
5039
+ The number of user reals stored on a particle.
5058
5040
  """
5059
5041
  version = '231'
5060
5042
  fluent_name = 'number-of-scalars'
@@ -5063,7 +5045,7 @@ class number_of_scalars(Integer):
5063
5045
 
5064
5046
  class maximum_udf_species(Integer):
5065
5047
  """
5066
- Specify the maximum number of species that can be used in DPM UDFs.
5048
+ The maximum number of species that can be used in DPM UDFs.
5067
5049
  """
5068
5050
  version = '231'
5069
5051
  fluent_name = 'maximum-udf-species'
@@ -5072,9 +5054,7 @@ class maximum_udf_species(Integer):
5072
5054
 
5073
5055
  class user_defined_functions(Group):
5074
5056
  """
5075
- Main menu to set DPM user-defined functions. User-defined functions can be used to customize the discrete phase model
5076
- to include additional body forces, modify interphase exchange terms (sources), calculate or integrate scalar values
5077
- along the particle trajectory, and more.
5057
+ Main object.
5078
5058
  """
5079
5059
  version = '231'
5080
5060
  fluent_name = 'user-defined-functions'
@@ -5099,7 +5079,7 @@ class user_defined_functions(Group):
5099
5079
 
5100
5080
  class discrete_phase(Group):
5101
5081
  """
5102
- Toplevel menu of the Discrete Phase multiphase model. A discrete phase model (DPM) is used when the aim is to investigate the behavior of the particles from a Lagrangian view and a discrete perspective.
5082
+ Toplevel object.
5103
5083
  """
5104
5084
  version = '231'
5105
5085
  fluent_name = 'discrete-phase'
@@ -5181,7 +5161,7 @@ class energy(Group):
5181
5161
 
5182
5162
  class models_1(String, AllowedValuesMixin):
5183
5163
  """
5184
- Specify multiphase model.
5164
+ Multiphase model.
5185
5165
  """
5186
5166
  version = '231'
5187
5167
  fluent_name = 'models'
@@ -5190,7 +5170,7 @@ class models_1(String, AllowedValuesMixin):
5190
5170
 
5191
5171
  class vaporization_pressure(Real):
5192
5172
  """
5193
- Set vaporization pressure.
5173
+ Vaporization pressure.
5194
5174
  """
5195
5175
  version = '231'
5196
5176
  fluent_name = 'vaporization-pressure'
@@ -5199,7 +5179,7 @@ class vaporization_pressure(Real):
5199
5179
 
5200
5180
  class non_condensable_gas(Real):
5201
5181
  """
5202
- Set non condensable gas.
5182
+ Non condensable gas.
5203
5183
  """
5204
5184
  version = '231'
5205
5185
  fluent_name = 'non-condensable-gas'
@@ -5208,7 +5188,7 @@ class non_condensable_gas(Real):
5208
5188
 
5209
5189
  class liquid_surface_tension(Real):
5210
5190
  """
5211
- Set liquid surface tension.
5191
+ Liquid surface tension.
5212
5192
  """
5213
5193
  version = '231'
5214
5194
  fluent_name = 'liquid-surface-tension'
@@ -5217,7 +5197,7 @@ class liquid_surface_tension(Real):
5217
5197
 
5218
5198
  class bubble_number_density(Real):
5219
5199
  """
5220
- Set bubble number density.
5200
+ Bubble number density.
5221
5201
  """
5222
5202
  version = '231'
5223
5203
  fluent_name = 'bubble-number-density'
@@ -5318,7 +5298,7 @@ class production_kato_launder(Boolean):
5318
5298
 
5319
5299
  class turb_buoyancy_effects(String, AllowedValuesMixin):
5320
5300
  """
5321
- Select buoyancy effects on turbulence.
5301
+ Buoyancy effects on turbulence.
5322
5302
  """
5323
5303
  version = '231'
5324
5304
  fluent_name = 'turb-buoyancy-effects'
@@ -5516,7 +5496,7 @@ class enhanced_wall_treatment_options(Group):
5516
5496
 
5517
5497
  class wall_omega_treatment(String, AllowedValuesMixin):
5518
5498
  """
5519
- Specify a wall omega treatment.
5499
+ A wall omega treatment.
5520
5500
  """
5521
5501
  version = '231'
5522
5502
  fluent_name = 'wall-omega-treatment'
@@ -5661,7 +5641,7 @@ class all_len_modified(Boolean):
5661
5641
 
5662
5642
  class des_limiter_option(String, AllowedValuesMixin):
5663
5643
  """
5664
- Select DES limiter option.
5644
+ DES limiter option.
5665
5645
  """
5666
5646
  version = '231'
5667
5647
  fluent_name = 'des-limiter-option'
@@ -5693,7 +5673,7 @@ class transition_module(String, AllowedValuesMixin):
5693
5673
 
5694
5674
  class f_length(String):
5695
5675
  """
5696
- Set user-defined transition correlations.
5676
+ User-defined transition correlations.
5697
5677
  """
5698
5678
  version = '231'
5699
5679
  fluent_name = 'f_length'
@@ -5702,7 +5682,7 @@ class f_length(String):
5702
5682
 
5703
5683
  class re_theta_c(String):
5704
5684
  """
5705
- Set user-defined transition correlations.
5685
+ User-defined transition correlations.
5706
5686
  """
5707
5687
  version = '231'
5708
5688
  fluent_name = 're_theta_c'
@@ -5711,7 +5691,7 @@ class re_theta_c(String):
5711
5691
 
5712
5692
  class re_theta_t(String):
5713
5693
  """
5714
- Set user-defined transition correlations.
5694
+ User-defined transition correlations.
5715
5695
  """
5716
5696
  version = '231'
5717
5697
  fluent_name = 're_theta_t'
@@ -5720,7 +5700,7 @@ class re_theta_t(String):
5720
5700
 
5721
5701
  class user_defined_transition(Group):
5722
5702
  """
5723
- Set user-defined transition correlations.
5703
+ User-defined transition correlations.
5724
5704
  """
5725
5705
  version = '231'
5726
5706
  fluent_name = 'user-defined-transition'
@@ -5846,7 +5826,7 @@ class enable_prod_limiter(Boolean):
5846
5826
 
5847
5827
  class clip_factor(Real):
5848
5828
  """
5849
- Enter Clip Factor for Production Limiter.
5829
+ Clip Factor for Production Limiter.
5850
5830
  """
5851
5831
  version = '231'
5852
5832
  fluent_name = 'clip-factor'
@@ -5905,7 +5885,7 @@ class turb_add_sbes_sdes(Boolean):
5905
5885
 
5906
5886
  class sbes_sdes_hybrid_model_optn(String, AllowedValuesMixin):
5907
5887
  """
5908
- Select the SBES / SDES hybrid model.
5888
+ The SBES / SDES hybrid model.
5909
5889
  """
5910
5890
  version = '231'
5911
5891
  fluent_name = 'sbes-sdes-hybrid-model-optn'
@@ -5914,7 +5894,7 @@ class sbes_sdes_hybrid_model_optn(String, AllowedValuesMixin):
5914
5894
 
5915
5895
  class user_defined_fcn_for_sbes(String, AllowedValuesMixin):
5916
5896
  """
5917
- Enter User-Defined Function for SBES.
5897
+ User-Defined Function for SBES.
5918
5898
  """
5919
5899
  version = '231'
5920
5900
  fluent_name = 'user-defined-fcn-for-sbes'
@@ -5937,7 +5917,7 @@ class sbes_sdes_hybrid_model(Group):
5937
5917
 
5938
5918
  class sbes_update_interval_k_omega(Integer):
5939
5919
  """
5940
- Set an integer value how often the k and omega equations are updated in a transient SBES run.
5920
+ An integer value how often the k and omega equations are updated in a transient SBES run.
5941
5921
  """
5942
5922
  version = '231'
5943
5923
  fluent_name = 'sbes-update-interval-k-omega'
@@ -5946,7 +5926,7 @@ class sbes_update_interval_k_omega(Integer):
5946
5926
 
5947
5927
  class sbes_sgs_option(String, AllowedValuesMixin):
5948
5928
  """
5949
- Select SBES subgrid-scale model.
5929
+ SBES subgrid-scale model.
5950
5930
  """
5951
5931
  version = '231'
5952
5932
  fluent_name = 'sbes-sgs-option'
@@ -5973,7 +5953,7 @@ class enable_turb_damping(Boolean):
5973
5953
 
5974
5954
  class turb_damping_factor(Real):
5975
5955
  """
5976
- Enter Damping Factor.
5956
+ Damping Factor.
5977
5957
  """
5978
5958
  version = '231'
5979
5959
  fluent_name = 'turb-damping-factor'
@@ -6090,7 +6070,7 @@ class wall_distance_free(Boolean):
6090
6070
 
6091
6071
  class cjet(Real):
6092
6072
  """
6093
- Set the GEKO model coefficient CJET.
6073
+ The GEKO model coefficient CJET.
6094
6074
  """
6095
6075
  version = '231'
6096
6076
  fluent_name = 'cjet'
@@ -6099,7 +6079,7 @@ class cjet(Real):
6099
6079
 
6100
6080
  class creal(Real):
6101
6081
  """
6102
- Set the GEKO model coefficient CREAL.
6082
+ The GEKO model coefficient CREAL.
6103
6083
  """
6104
6084
  version = '231'
6105
6085
  fluent_name = 'creal'
@@ -6108,7 +6088,7 @@ class creal(Real):
6108
6088
 
6109
6089
  class cnw_sub(Real):
6110
6090
  """
6111
- Set the GEKO model coefficient CNW-SUB.
6091
+ The GEKO model coefficient CNW-SUB.
6112
6092
  """
6113
6093
  version = '231'
6114
6094
  fluent_name = 'cnw-sub'
@@ -6117,7 +6097,7 @@ class cnw_sub(Real):
6117
6097
 
6118
6098
  class cjet_aux(Real):
6119
6099
  """
6120
- Set the GEKO model coefficient CJET_AUX.
6100
+ The GEKO model coefficient CJET_AUX.
6121
6101
  """
6122
6102
  version = '231'
6123
6103
  fluent_name = 'cjet-aux'
@@ -6126,7 +6106,7 @@ class cjet_aux(Real):
6126
6106
 
6127
6107
  class cbf_lam(Real):
6128
6108
  """
6129
- Set the GEKO model coefficient CBF_LAM.
6109
+ The GEKO model coefficient CBF_LAM.
6130
6110
  """
6131
6111
  version = '231'
6132
6112
  fluent_name = 'cbf-lam'
@@ -6135,7 +6115,7 @@ class cbf_lam(Real):
6135
6115
 
6136
6116
  class cbf_tur(Real):
6137
6117
  """
6138
- Set the GEKO model coefficient CBF_TUR.
6118
+ The GEKO model coefficient CBF_TUR.
6139
6119
  """
6140
6120
  version = '231'
6141
6121
  fluent_name = 'cbf-tur'
@@ -6183,7 +6163,7 @@ class crossflow_transition(Boolean):
6183
6163
 
6184
6164
  class critical_reynolds_number_correlation(String):
6185
6165
  """
6186
- Set the critical Reynolds number correlation.
6166
+ The critical Reynolds number correlation.
6187
6167
  """
6188
6168
  version = '231'
6189
6169
  fluent_name = 'critical-reynolds-number-correlation'
@@ -6192,7 +6172,7 @@ class critical_reynolds_number_correlation(String):
6192
6172
 
6193
6173
  class clambda_scale(Real):
6194
6174
  """
6195
- Set the algebraic transition model coefficient CLAMBDA_SCALE.
6175
+ The algebraic transition model coefficient CLAMBDA_SCALE.
6196
6176
  """
6197
6177
  version = '231'
6198
6178
  fluent_name = 'clambda-scale'
@@ -6201,7 +6181,7 @@ class clambda_scale(Real):
6201
6181
 
6202
6182
  class capg_hightu(Real):
6203
6183
  """
6204
- Set the algebraic transition model coefficient CAPG_HIGHTU.
6184
+ The algebraic transition model coefficient CAPG_HIGHTU.
6205
6185
  """
6206
6186
  version = '231'
6207
6187
  fluent_name = 'capg-hightu'
@@ -6210,7 +6190,7 @@ class capg_hightu(Real):
6210
6190
 
6211
6191
  class cfpg_hightu(Real):
6212
6192
  """
6213
- Set the algebraic transition model coefficient CFPG_HIGHTU.
6193
+ The algebraic transition model coefficient CFPG_HIGHTU.
6214
6194
  """
6215
6195
  version = '231'
6216
6196
  fluent_name = 'cfpg-hightu'
@@ -6219,7 +6199,7 @@ class cfpg_hightu(Real):
6219
6199
 
6220
6200
  class capg_lowtu(Real):
6221
6201
  """
6222
- Set the algebraic transition model coefficient CAPG_LOWTU.
6202
+ The algebraic transition model coefficient CAPG_LOWTU.
6223
6203
  """
6224
6204
  version = '231'
6225
6205
  fluent_name = 'capg-lowtu'
@@ -6228,7 +6208,7 @@ class capg_lowtu(Real):
6228
6208
 
6229
6209
  class cfpg_lowtu(Real):
6230
6210
  """
6231
- Set the algebraic transition model coefficient CFPG_LOWTU.
6211
+ The algebraic transition model coefficient CFPG_LOWTU.
6232
6212
  """
6233
6213
  version = '231'
6234
6214
  fluent_name = 'cfpg-lowtu'
@@ -6237,7 +6217,7 @@ class cfpg_lowtu(Real):
6237
6217
 
6238
6218
  class ctu_hightu(Real):
6239
6219
  """
6240
- Set the algebraic transition model coefficient CTU_HIGHTU.
6220
+ The algebraic transition model coefficient CTU_HIGHTU.
6241
6221
  """
6242
6222
  version = '231'
6243
6223
  fluent_name = 'ctu-hightu'
@@ -6246,7 +6226,7 @@ class ctu_hightu(Real):
6246
6226
 
6247
6227
  class ctu_lowtu(Real):
6248
6228
  """
6249
- Set the algebraic transition model coefficient CTU_LOWTU.
6229
+ The algebraic transition model coefficient CTU_LOWTU.
6250
6230
  """
6251
6231
  version = '231'
6252
6232
  fluent_name = 'ctu-lowtu'
@@ -6255,7 +6235,7 @@ class ctu_lowtu(Real):
6255
6235
 
6256
6236
  class rec_max(Real):
6257
6237
  """
6258
- Set the algebraic transition model coefficient REC_MAX.
6238
+ The algebraic transition model coefficient REC_MAX.
6259
6239
  """
6260
6240
  version = '231'
6261
6241
  fluent_name = 'rec-max'
@@ -6264,7 +6244,7 @@ class rec_max(Real):
6264
6244
 
6265
6245
  class rec_c1(Real):
6266
6246
  """
6267
- Set the algebraic transition model coefficient REC_C1.
6247
+ The algebraic transition model coefficient REC_C1.
6268
6248
  """
6269
6249
  version = '231'
6270
6250
  fluent_name = 'rec-c1'
@@ -6273,7 +6253,7 @@ class rec_c1(Real):
6273
6253
 
6274
6254
  class rec_c2(Real):
6275
6255
  """
6276
- Set the algebraic transition model coefficient REC_C2.
6256
+ The algebraic transition model coefficient REC_C2.
6277
6257
  """
6278
6258
  version = '231'
6279
6259
  fluent_name = 'rec-c2'
@@ -6282,7 +6262,7 @@ class rec_c2(Real):
6282
6262
 
6283
6263
  class cbubble_c1(Real):
6284
6264
  """
6285
- Set the algebraic transition model coefficient CBUBBLE_C1.
6265
+ The algebraic transition model coefficient CBUBBLE_C1.
6286
6266
  """
6287
6267
  version = '231'
6288
6268
  fluent_name = 'cbubble-c1'
@@ -6291,7 +6271,7 @@ class cbubble_c1(Real):
6291
6271
 
6292
6272
  class cbubble_c2(Real):
6293
6273
  """
6294
- Set the algebraic transition model coefficient CBUBBLE_C2.
6274
+ The algebraic transition model coefficient CBUBBLE_C2.
6295
6275
  """
6296
6276
  version = '231'
6297
6277
  fluent_name = 'cbubble-c2'
@@ -6300,7 +6280,7 @@ class cbubble_c2(Real):
6300
6280
 
6301
6281
  class rv1_switch(Real):
6302
6282
  """
6303
- Set the algebraic transition model coefficient RV1_SWITCH.
6283
+ The algebraic transition model coefficient RV1_SWITCH.
6304
6284
  """
6305
6285
  version = '231'
6306
6286
  fluent_name = 'rv1-switch'
@@ -6354,7 +6334,7 @@ class roughness_correlation_fcn(String, AllowedValuesMixin):
6354
6334
 
6355
6335
  class geometric_roughness_ht_val(Real):
6356
6336
  """
6357
- Enter Geometric Roughness Height.
6337
+ Geometric Roughness Height.
6358
6338
  """
6359
6339
  version = '231'
6360
6340
  fluent_name = 'geometric-roughness-ht-val'
@@ -6415,7 +6395,7 @@ class turb_visc_func(String, AllowedValuesMixin):
6415
6395
 
6416
6396
  class tke_prandtl(String, AllowedValuesMixin):
6417
6397
  """
6418
- Enter TKE prandtl number function.
6398
+ TKE prandtl number function.
6419
6399
  """
6420
6400
  version = '231'
6421
6401
  fluent_name = 'tke-prandtl'
@@ -6424,7 +6404,7 @@ class tke_prandtl(String, AllowedValuesMixin):
6424
6404
 
6425
6405
  class tdr_prandtl(String, AllowedValuesMixin):
6426
6406
  """
6427
- Enter TDR prandtl number function.
6407
+ TDR prandtl number function.
6428
6408
  """
6429
6409
  version = '231'
6430
6410
  fluent_name = 'tdr-prandtl'
@@ -6433,7 +6413,7 @@ class tdr_prandtl(String, AllowedValuesMixin):
6433
6413
 
6434
6414
  class sdr_prandtl(String, AllowedValuesMixin):
6435
6415
  """
6436
- Enter SDR prandtl number function.
6416
+ SDR prandtl number function.
6437
6417
  """
6438
6418
  version = '231'
6439
6419
  fluent_name = 'sdr-prandtl'
@@ -6442,7 +6422,7 @@ class sdr_prandtl(String, AllowedValuesMixin):
6442
6422
 
6443
6423
  class energy_prandtl(String, AllowedValuesMixin):
6444
6424
  """
6445
- Enter Energy Prandtl number function.
6425
+ Energy Prandtl number function.
6446
6426
  """
6447
6427
  version = '231'
6448
6428
  fluent_name = 'energy-prandtl'
@@ -6451,7 +6431,7 @@ class energy_prandtl(String, AllowedValuesMixin):
6451
6431
 
6452
6432
  class wall_prandtl(String, AllowedValuesMixin):
6453
6433
  """
6454
- Enter Wall Prandtl number function.
6434
+ Wall Prandtl number function.
6455
6435
  """
6456
6436
  version = '231'
6457
6437
  fluent_name = 'wall-prandtl'
@@ -6460,7 +6440,7 @@ class wall_prandtl(String, AllowedValuesMixin):
6460
6440
 
6461
6441
  class turbulent_schmidt(String, AllowedValuesMixin):
6462
6442
  """
6463
- Enter Turbulent Schmidt number function.
6443
+ Turbulent Schmidt number function.
6464
6444
  """
6465
6445
  version = '231'
6466
6446
  fluent_name = 'turbulent-schmidt'
@@ -6553,7 +6533,7 @@ class enable_3(Boolean):
6553
6533
 
6554
6534
  class orig_beam_name(String, AllowedValuesMixin):
6555
6535
  """
6556
- Choose the name for the optical beam to be copied.
6536
+ The name for the optical beam to be copied.
6557
6537
  """
6558
6538
  version = '231'
6559
6539
  fluent_name = 'orig-beam-name'
@@ -6562,7 +6542,7 @@ class orig_beam_name(String, AllowedValuesMixin):
6562
6542
 
6563
6543
  class beam_name(String):
6564
6544
  """
6565
- Set a unique name for each optical beam.
6545
+ A unique name for each optical beam.
6566
6546
  """
6567
6547
  version = '231'
6568
6548
  fluent_name = 'beam-name'
@@ -6571,7 +6551,7 @@ class beam_name(String):
6571
6551
 
6572
6552
  class ap_face_zone(String, AllowedValuesMixin):
6573
6553
  """
6574
- Set the wall face zones to specify the optical aperture surface.
6554
+ The wall face zones to specify the optical aperture surface.
6575
6555
  """
6576
6556
  version = '231'
6577
6557
  fluent_name = 'ap-face-zone'
@@ -6580,7 +6560,7 @@ class ap_face_zone(String, AllowedValuesMixin):
6580
6560
 
6581
6561
  class beam_length(Real):
6582
6562
  """
6583
- Set the length of optical beam propagation.
6563
+ The length of optical beam propagation.
6584
6564
  """
6585
6565
  version = '231'
6586
6566
  fluent_name = 'beam-length'
@@ -6589,7 +6569,7 @@ class beam_length(Real):
6589
6569
 
6590
6570
  class ray_npoints(Integer):
6591
6571
  """
6592
- Set the number of grid point in each ray of the optical beam.
6572
+ The number of grid point in each ray of the optical beam.
6593
6573
  """
6594
6574
  version = '231'
6595
6575
  fluent_name = 'ray-npoints'
@@ -6598,7 +6578,7 @@ class ray_npoints(Integer):
6598
6578
 
6599
6579
  class x_beam_vector(Real):
6600
6580
  """
6601
- Set the x-component of the beam propagation vector.
6581
+ The x-component of the beam propagation vector.
6602
6582
  """
6603
6583
  version = '231'
6604
6584
  fluent_name = 'x-beam-vector'
@@ -6607,7 +6587,7 @@ class x_beam_vector(Real):
6607
6587
 
6608
6588
  class y_beam_vector(Real):
6609
6589
  """
6610
- Set the y-component of the beam propagation vector.
6590
+ The y-component of the beam propagation vector.
6611
6591
  """
6612
6592
  version = '231'
6613
6593
  fluent_name = 'y-beam-vector'
@@ -6616,7 +6596,7 @@ class y_beam_vector(Real):
6616
6596
 
6617
6597
  class z_beam_vector(Real):
6618
6598
  """
6619
- Set the z-component of the beam propagation vector.
6599
+ The z-component of the beam propagation vector.
6620
6600
  """
6621
6601
  version = '231'
6622
6602
  fluent_name = 'z-beam-vector'
@@ -6630,21 +6610,21 @@ class copy(Command):
6630
6610
  Parameters
6631
6611
  ----------
6632
6612
  orig_beam_name : str
6633
- Choose the name for the optical beam to be copied.
6613
+ The name for the optical beam to be copied.
6634
6614
  beam_name : str
6635
- Set a unique name for each optical beam.
6615
+ A unique name for each optical beam.
6636
6616
  ap_face_zone : str
6637
- Set the wall face zones to specify the optical aperture surface.
6617
+ The wall face zones to specify the optical aperture surface.
6638
6618
  beam_length : real
6639
- Set the length of optical beam propagation.
6619
+ The length of optical beam propagation.
6640
6620
  ray_npoints : int
6641
- Set the number of grid point in each ray of the optical beam.
6621
+ The number of grid point in each ray of the optical beam.
6642
6622
  x_beam_vector : real
6643
- Set the x-component of the beam propagation vector.
6623
+ The x-component of the beam propagation vector.
6644
6624
  y_beam_vector : real
6645
- Set the y-component of the beam propagation vector.
6625
+ The y-component of the beam propagation vector.
6646
6626
  z_beam_vector : real
6647
- Set the z-component of the beam propagation vector.
6627
+ The z-component of the beam propagation vector.
6648
6628
  """
6649
6629
  version = '231'
6650
6630
  fluent_name = 'copy'
@@ -6664,7 +6644,7 @@ class copy(Command):
6664
6644
 
6665
6645
  class beam_name_1(String, AllowedValuesMixin):
6666
6646
  """
6667
- Choose the name for the optical beam to be listed.
6647
+ The name for the optical beam to be listed.
6668
6648
  """
6669
6649
  version = '231'
6670
6650
  fluent_name = 'beam-name'
@@ -6678,7 +6658,7 @@ class list_beam_parameters(Command):
6678
6658
  Parameters
6679
6659
  ----------
6680
6660
  beam_name : str
6681
- Choose the name for the optical beam to be listed.
6661
+ The name for the optical beam to be listed.
6682
6662
  """
6683
6663
  version = '231'
6684
6664
  fluent_name = 'list-beam-parameters'
@@ -6691,7 +6671,7 @@ class list_beam_parameters(Command):
6691
6671
 
6692
6672
  class ray_points_count(Integer):
6693
6673
  """
6694
- Set the number of grid point in each ray of the optical beam.
6674
+ The number of grid point in each ray of the optical beam.
6695
6675
  """
6696
6676
  version = '231'
6697
6677
  fluent_name = 'ray-points-count'
@@ -6700,7 +6680,7 @@ class ray_points_count(Integer):
6700
6680
 
6701
6681
  class beam_vector(RealList):
6702
6682
  """
6703
- Set the components of the beam propagation vector.
6683
+ The components of the beam propagation vector.
6704
6684
  """
6705
6685
  version = '231'
6706
6686
  fluent_name = 'beam-vector'
@@ -6725,7 +6705,7 @@ class beams_child(Group):
6725
6705
 
6726
6706
  class beams(NamedObject[beams_child], CreatableNamedObjectMixinOld[beams_child]):
6727
6707
  """
6728
- Enter the optical beams menu.
6708
+ The optical beams object.
6729
6709
  """
6730
6710
  version = '231'
6731
6711
  fluent_name = 'beams'
@@ -6811,7 +6791,7 @@ class statistics_controls(Command):
6811
6791
 
6812
6792
  class statistics(Group):
6813
6793
  """
6814
- Specify statistics parameter of sampling and averaging of flow and optical quantiies.
6794
+ Statistics parameter of sampling and averaging of flow and optical quantiies.
6815
6795
  """
6816
6796
  version = '231'
6817
6797
  fluent_name = 'statistics'
@@ -6826,7 +6806,7 @@ class statistics(Group):
6826
6806
 
6827
6807
  class sampling_iterations(Integer):
6828
6808
  """
6829
- Specify the sampling iterations of flow quantites.
6809
+ The sampling iterations of flow quantites.
6830
6810
  """
6831
6811
  version = '231'
6832
6812
  fluent_name = 'sampling-iterations'
@@ -6835,7 +6815,7 @@ class sampling_iterations(Integer):
6835
6815
 
6836
6816
  class index_of_refraction(Real):
6837
6817
  """
6838
- Specify the model parameters of index of refraction.
6818
+ The model parameters of index of refraction.
6839
6819
  """
6840
6820
  version = '231'
6841
6821
  fluent_name = 'index-of-refraction'
@@ -6853,7 +6833,7 @@ class report_1(Boolean):
6853
6833
 
6854
6834
  class verbosity_2(Integer):
6855
6835
  """
6856
- Specify the verbosity of the model messages.
6836
+ The verbosity of the model messages.
6857
6837
  """
6858
6838
  version = '231'
6859
6839
  fluent_name = 'verbosity'
@@ -6862,7 +6842,7 @@ class verbosity_2(Integer):
6862
6842
 
6863
6843
  class optics(Group):
6864
6844
  """
6865
- Enter the optics model menu.
6845
+ The optics model object.
6866
6846
  """
6867
6847
  version = '231'
6868
6848
  fluent_name = 'optics'
@@ -6890,7 +6870,7 @@ class enable_4(Boolean):
6890
6870
 
6891
6871
  class mode(String, AllowedValuesMixin):
6892
6872
  """
6893
- Select VBM mode non/edm/fdm.
6873
+ VBM mode non/edm/fdm.
6894
6874
  """
6895
6875
  version = '231'
6896
6876
  fluent_name = 'mode'
@@ -6899,7 +6879,7 @@ class mode(String, AllowedValuesMixin):
6899
6879
 
6900
6880
  class number_of_blades(Integer):
6901
6881
  """
6902
- Set the number of blades.
6882
+ The number of blades.
6903
6883
  """
6904
6884
  version = '231'
6905
6885
  fluent_name = 'number-of-blades'
@@ -6908,7 +6888,7 @@ class number_of_blades(Integer):
6908
6888
 
6909
6889
  class tip_radius(Real):
6910
6890
  """
6911
- Set rotor tip radius.
6891
+ Rotor tip radius.
6912
6892
  """
6913
6893
  version = '231'
6914
6894
  fluent_name = 'tip-radius'
@@ -6917,7 +6897,7 @@ class tip_radius(Real):
6917
6897
 
6918
6898
  class root_radius(Real):
6919
6899
  """
6920
- Set rotor root cutout radius.
6900
+ Rotor root cutout radius.
6921
6901
  """
6922
6902
  version = '231'
6923
6903
  fluent_name = 'root-radius'
@@ -6926,7 +6906,7 @@ class root_radius(Real):
6926
6906
 
6927
6907
  class rotor_speed(Real):
6928
6908
  """
6929
- Set rotor speed.
6909
+ Rotor speed.
6930
6910
  """
6931
6911
  version = '231'
6932
6912
  fluent_name = 'rotor-speed'
@@ -6956,7 +6936,7 @@ class basic_info(Group):
6956
6936
 
6957
6937
  class disk_origin_x(Real):
6958
6938
  """
6959
- Set rotor origin x-coordinate.
6939
+ Rotor origin x-coordinate.
6960
6940
  """
6961
6941
  version = '231'
6962
6942
  fluent_name = 'disk-origin-x'
@@ -6965,7 +6945,7 @@ class disk_origin_x(Real):
6965
6945
 
6966
6946
  class disk_origin_y(Real):
6967
6947
  """
6968
- Set rotor origin y-coordinate.
6948
+ Rotor origin y-coordinate.
6969
6949
  """
6970
6950
  version = '231'
6971
6951
  fluent_name = 'disk-origin-y'
@@ -6974,7 +6954,7 @@ class disk_origin_y(Real):
6974
6954
 
6975
6955
  class disk_origin_z(Real):
6976
6956
  """
6977
- Set rotor origin z-coordinate.
6957
+ Rotor origin z-coordinate.
6978
6958
  """
6979
6959
  version = '231'
6980
6960
  fluent_name = 'disk-origin-z'
@@ -6999,10 +6979,7 @@ class disk_origin(Group):
6999
6979
 
7000
6980
  class terminology(Integer):
7001
6981
  """
7002
- Select Rotor Disk Orientation Terminology:
7003
- - Enter 0 if using Rotor Disk Angles
7004
- - Enter 1 if using Rotor Disk Normal
7005
- For more details please consult the help option of the corresponding menu or TUI command.
6982
+ Rotor Disk Orientation Terminology:.
7006
6983
  """
7007
6984
  version = '231'
7008
6985
  fluent_name = 'terminology'
@@ -7011,7 +6988,7 @@ class terminology(Integer):
7011
6988
 
7012
6989
  class disk_normal_x(Real):
7013
6990
  """
7014
- Set x-component of disk normal vector:.
6991
+ X-component of disk normal vector:.
7015
6992
  """
7016
6993
  version = '231'
7017
6994
  fluent_name = 'disk-normal-x'
@@ -7020,7 +6997,7 @@ class disk_normal_x(Real):
7020
6997
 
7021
6998
  class disk_normal_y(Real):
7022
6999
  """
7023
- Set y-component of disk normal vector:.
7000
+ Y-component of disk normal vector:.
7024
7001
  """
7025
7002
  version = '231'
7026
7003
  fluent_name = 'disk-normal-y'
@@ -7029,7 +7006,7 @@ class disk_normal_y(Real):
7029
7006
 
7030
7007
  class disk_normal_z(Real):
7031
7008
  """
7032
- Set x-component of disk normal vector:.
7009
+ X-component of disk normal vector:.
7033
7010
  """
7034
7011
  version = '231'
7035
7012
  fluent_name = 'disk-normal-z'
@@ -7038,7 +7015,7 @@ class disk_normal_z(Real):
7038
7015
 
7039
7016
  class disk_pitch_angle(Real):
7040
7017
  """
7041
- Set disk pitch angle:.
7018
+ Disk pitch angle:.
7042
7019
  """
7043
7020
  version = '231'
7044
7021
  fluent_name = 'disk-pitch-angle'
@@ -7047,7 +7024,7 @@ class disk_pitch_angle(Real):
7047
7024
 
7048
7025
  class disk_bank_angle(Real):
7049
7026
  """
7050
- Set disk bank angle:.
7027
+ Disk bank angle:.
7051
7028
  """
7052
7029
  version = '231'
7053
7030
  fluent_name = 'disk-bank-angle'
@@ -7079,7 +7056,7 @@ class disk_orientation(Group):
7079
7056
 
7080
7057
  class embedded_face_zone(String, AllowedValuesMixin):
7081
7058
  """
7082
- Set Embedded face zone:.
7059
+ Embedded face zone:.
7083
7060
  """
7084
7061
  version = '231'
7085
7062
  fluent_name = 'embedded-face-zone'
@@ -7088,7 +7065,7 @@ class embedded_face_zone(String, AllowedValuesMixin):
7088
7065
 
7089
7066
  class floating_surface(String, AllowedValuesMixin):
7090
7067
  """
7091
- Set Floating surface name:.
7068
+ Floating surface name:.
7092
7069
  """
7093
7070
  version = '231'
7094
7071
  fluent_name = 'floating-surface'
@@ -7114,7 +7091,7 @@ class disk_id(Group):
7114
7091
 
7115
7092
  class blade_pitch_collective(Real):
7116
7093
  """
7117
- Set blade collective pitch angle:.
7094
+ Blade collective pitch angle:.
7118
7095
  """
7119
7096
  version = '231'
7120
7097
  fluent_name = 'blade-pitch-collective'
@@ -7123,7 +7100,7 @@ class blade_pitch_collective(Real):
7123
7100
 
7124
7101
  class blade_pitch_cyclic_sin(Real):
7125
7102
  """
7126
- Set magnitude of sin component of blade's cyclic pitch angle:.
7103
+ Magnitude of sin component of blade's cyclic pitch angle:.
7127
7104
  """
7128
7105
  version = '231'
7129
7106
  fluent_name = 'blade-pitch-cyclic-sin'
@@ -7132,7 +7109,7 @@ class blade_pitch_cyclic_sin(Real):
7132
7109
 
7133
7110
  class blade_pitch_cyclic_cos(Real):
7134
7111
  """
7135
- Set magnitude of cos component of blade's cyclic pitch angle:.
7112
+ Magnitude of cos component of blade's cyclic pitch angle:.
7136
7113
  """
7137
7114
  version = '231'
7138
7115
  fluent_name = 'blade-pitch-cyclic-cos'
@@ -7160,7 +7137,7 @@ class blade_pitch_angles(Group):
7160
7137
 
7161
7138
  class blade_flapping_cone(Real):
7162
7139
  """
7163
- Set blade flapping cone angle:.
7140
+ Blade flapping cone angle:.
7164
7141
  """
7165
7142
  version = '231'
7166
7143
  fluent_name = 'blade-flapping-cone'
@@ -7169,7 +7146,7 @@ class blade_flapping_cone(Real):
7169
7146
 
7170
7147
  class blade_flapping_cyclic_sin(Real):
7171
7148
  """
7172
- Set magnitude of sin component of blade's cyclic flapping angle:.
7149
+ Magnitude of sin component of blade's cyclic flapping angle:.
7173
7150
  """
7174
7151
  version = '231'
7175
7152
  fluent_name = 'blade-flapping-cyclic-sin'
@@ -7178,7 +7155,7 @@ class blade_flapping_cyclic_sin(Real):
7178
7155
 
7179
7156
  class blade_flapping_cyclic_cos(Real):
7180
7157
  """
7181
- Set magnitude of cos component of blade's cyclic flapping angle:.
7158
+ Magnitude of cos component of blade's cyclic flapping angle:.
7182
7159
  """
7183
7160
  version = '231'
7184
7161
  fluent_name = 'blade-flapping-cyclic-cos'
@@ -7206,10 +7183,7 @@ class blade_flap_angles(Group):
7206
7183
 
7207
7184
  class model_tip_loss(Integer):
7208
7185
  """
7209
- Select Tip Loss Model:
7210
- - Enter 1 if using Quadratic model
7211
- - Enter 2 if using modified Prandtl model
7212
- For more details please consult the help option of the corresponding menu or TUI command.
7186
+ Tip Loss Model:.
7213
7187
  """
7214
7188
  version = '231'
7215
7189
  fluent_name = 'model-tip-loss'
@@ -7218,7 +7192,7 @@ class model_tip_loss(Integer):
7218
7192
 
7219
7193
  class tip_loss_limit(Real):
7220
7194
  """
7221
- Set Tip Loss Limit (%R) if using Quadratic tip loss model:.
7195
+ Tip Loss Limit (%R) if using Quadratic tip loss model:.
7222
7196
  """
7223
7197
  version = '231'
7224
7198
  fluent_name = 'tip-loss-limit'
@@ -7227,7 +7201,7 @@ class tip_loss_limit(Real):
7227
7201
 
7228
7202
  class prandtl_tuning_coefficient(Real):
7229
7203
  """
7230
- Set the tuning coefficient in modified prandtl tip loss model:.
7204
+ The tuning coefficient in modified prandtl tip loss model:.
7231
7205
  """
7232
7206
  version = '231'
7233
7207
  fluent_name = 'prandtl-tuning-coefficient'
@@ -7327,11 +7301,7 @@ class geometry_1_child(Group):
7327
7301
 
7328
7302
  class geometry_1(NamedObject[geometry_1_child], CreatableNamedObjectMixinOld[geometry_1_child]):
7329
7303
  """
7330
- Main menu to define a disk-section:
7331
-
7332
- - delete : delete a disk-section% - edit : edit a disk-section
7333
- - new : create a new disk-section
7334
- - rename : rename a vbm disk-section.
7304
+ Main object.
7335
7305
  """
7336
7306
  version = '231'
7337
7307
  fluent_name = 'geometry'
@@ -7341,12 +7311,7 @@ class geometry_1(NamedObject[geometry_1_child], CreatableNamedObjectMixinOld[geo
7341
7311
 
7342
7312
  class trim_option(Integer):
7343
7313
  """
7344
- Select Trimming Option:
7345
- - Enter 0 if no trimming is required
7346
- - Enter 1 if trimming of collective pitch is required
7347
- - Enter 2 if trimming of cyclic pitch angles are required
7348
- - Enter 3 if trimming of both collective and cyclic pitch angles are required
7349
- For more details please consult the help option of the corresponding menu or TUI command.
7314
+ Trimming Option:.
7350
7315
  """
7351
7316
  version = '231'
7352
7317
  fluent_name = 'trim-option'
@@ -7355,7 +7320,7 @@ class trim_option(Integer):
7355
7320
 
7356
7321
  class update_frequency(Integer):
7357
7322
  """
7358
- Set Trimming Update Frequency N (trim after each N iterations):.
7323
+ Trimming Update Frequency N (trim after each N iterations):.
7359
7324
  """
7360
7325
  version = '231'
7361
7326
  fluent_name = 'update-frequency'
@@ -7364,7 +7329,7 @@ class update_frequency(Integer):
7364
7329
 
7365
7330
  class damping_factor(Real):
7366
7331
  """
7367
- Set trimming damping factor (relaxation factor):.
7332
+ Trimming damping factor (relaxation factor):.
7368
7333
  """
7369
7334
  version = '231'
7370
7335
  fluent_name = 'damping-factor'
@@ -7373,7 +7338,7 @@ class damping_factor(Real):
7373
7338
 
7374
7339
  class thrust_coefficient(Real):
7375
7340
  """
7376
- Set desired thrust coefficient:.
7341
+ Desired thrust coefficient:.
7377
7342
  """
7378
7343
  version = '231'
7379
7344
  fluent_name = 'thrust-coefficient'
@@ -7382,7 +7347,7 @@ class thrust_coefficient(Real):
7382
7347
 
7383
7348
  class x_moment_coefficient(Real):
7384
7349
  """
7385
- Set desired x-momentum coefficient:.
7350
+ Desired x-momentum coefficient:.
7386
7351
  """
7387
7352
  version = '231'
7388
7353
  fluent_name = 'x-moment-coefficient'
@@ -7391,7 +7356,7 @@ class x_moment_coefficient(Real):
7391
7356
 
7392
7357
  class y_moment_coefficient(Real):
7393
7358
  """
7394
- Set desired y-momentum coefficient:.
7359
+ Desired y-momentum coefficient:.
7395
7360
  """
7396
7361
  version = '231'
7397
7362
  fluent_name = 'y-moment-coefficient'
@@ -7440,12 +7405,7 @@ class disk_child(Group):
7440
7405
 
7441
7406
  class disk(NamedObject[disk_child], CreatableNamedObjectMixinOld[disk_child]):
7442
7407
  """
7443
- Main menu to define a rotor disk:
7444
-
7445
- - delete : delete a vbm disk
7446
- - edit : edit a vbm disk
7447
- - new : create a new vbm disk
7448
- - rename : rename a vbm disk.
7408
+ Main object.
7449
7409
  """
7450
7410
  version = '231'
7451
7411
  fluent_name = 'disk'
@@ -7455,7 +7415,7 @@ class disk(NamedObject[disk_child], CreatableNamedObjectMixinOld[disk_child]):
7455
7415
 
7456
7416
  class virtual_blade_model(Group):
7457
7417
  """
7458
- Enter the vbm model menu.
7418
+ The vbm model object.
7459
7419
  """
7460
7420
  version = '231'
7461
7421
  fluent_name = 'virtual-blade-model'
@@ -7488,7 +7448,7 @@ class models(Group):
7488
7448
 
7489
7449
  class database_type(String, AllowedValuesMixin):
7490
7450
  """
7491
- Specify the database type.
7451
+ The database type.
7492
7452
  """
7493
7453
  version = '231'
7494
7454
  fluent_name = 'database-type'
@@ -7611,7 +7571,7 @@ class database(Group):
7611
7571
 
7612
7572
  class option_10(String, AllowedValuesMixin):
7613
7573
  """
7614
- Select method for calculating material property.
7574
+ Method for calculating material property.
7615
7575
  """
7616
7576
  version = '231'
7617
7577
  fluent_name = 'option'
@@ -7620,7 +7580,7 @@ class option_10(String, AllowedValuesMixin):
7620
7580
 
7621
7581
  class nist_fluid(String, AllowedValuesMixin):
7622
7582
  """
7623
- Select NIST fluid data.
7583
+ NIST fluid data.
7624
7584
  """
7625
7585
  version = '231'
7626
7586
  fluent_name = 'nist-fluid'
@@ -7638,7 +7598,7 @@ class lookup_table(Boolean):
7638
7598
 
7639
7599
  class pressure_points(Integer):
7640
7600
  """
7641
- Specify number of table points for pressure.
7601
+ Number of table points for pressure.
7642
7602
  """
7643
7603
  version = '231'
7644
7604
  fluent_name = 'pressure-points'
@@ -7647,7 +7607,7 @@ class pressure_points(Integer):
7647
7607
 
7648
7608
  class pressure_minimum(Real):
7649
7609
  """
7650
- Specify lower table bound for pressure.
7610
+ Lower table bound for pressure.
7651
7611
  """
7652
7612
  version = '231'
7653
7613
  fluent_name = 'pressure-minimum'
@@ -7656,7 +7616,7 @@ class pressure_minimum(Real):
7656
7616
 
7657
7617
  class pressure_maximum(Real):
7658
7618
  """
7659
- Specify upper table bound for pressure.
7619
+ Upper table bound for pressure.
7660
7620
  """
7661
7621
  version = '231'
7662
7622
  fluent_name = 'pressure-maximum'
@@ -7665,7 +7625,7 @@ class pressure_maximum(Real):
7665
7625
 
7666
7626
  class temperature_points(Integer):
7667
7627
  """
7668
- Specify number of table points for temperature.
7628
+ Number of table points for temperature.
7669
7629
  """
7670
7630
  version = '231'
7671
7631
  fluent_name = 'temperature-points'
@@ -7674,7 +7634,7 @@ class temperature_points(Integer):
7674
7634
 
7675
7635
  class temperature_minimum(Real):
7676
7636
  """
7677
- Specify lower table bound for temperature.
7637
+ Lower table bound for temperature.
7678
7638
  """
7679
7639
  version = '231'
7680
7640
  fluent_name = 'temperature-minimum'
@@ -7683,7 +7643,7 @@ class temperature_minimum(Real):
7683
7643
 
7684
7644
  class temperature_maximum(Real):
7685
7645
  """
7686
- Specify upper table bound for temperature.
7646
+ Upper table bound for temperature.
7687
7647
  """
7688
7648
  version = '231'
7689
7649
  fluent_name = 'temperature-maximum'
@@ -7692,7 +7652,7 @@ class temperature_maximum(Real):
7692
7652
 
7693
7653
  class saturation_points(Integer):
7694
7654
  """
7695
- Specify number of table points for saturation.
7655
+ Number of table points for saturation.
7696
7656
  """
7697
7657
  version = '231'
7698
7658
  fluent_name = 'saturation-points'
@@ -7840,7 +7800,7 @@ class maximum(Real):
7840
7800
 
7841
7801
  class number_of_coefficients(Integer):
7842
7802
  """
7843
- Specify number of polynomial coefficients (polynomial order plus one).
7803
+ Number of polynomial coefficients (polynomial order plus one).
7844
7804
  """
7845
7805
  version = '231'
7846
7806
  fluent_name = 'number-of-coefficients'
@@ -7849,7 +7809,7 @@ class number_of_coefficients(Integer):
7849
7809
 
7850
7810
  class coefficients(RealList):
7851
7811
  """
7852
- Specify polynomial coefficients.
7812
+ Polynomial coefficients.
7853
7813
  """
7854
7814
  version = '231'
7855
7815
  fluent_name = 'coefficients'
@@ -7916,7 +7876,7 @@ class user_defined_function(String, AllowedValuesMixin):
7916
7876
 
7917
7877
  class rgp_table(String, AllowedValuesMixin):
7918
7878
  """
7919
- Select RGP Table Data Set.
7879
+ RGP Table Data Set.
7920
7880
  """
7921
7881
  version = '231'
7922
7882
  fluent_name = 'rgp-table'
@@ -23705,7 +23665,7 @@ class wave_spect_dir_components(Integer, AllowedValuesMixin):
23705
23665
 
23706
23666
  class mean_and_std_deviation(RealList):
23707
23667
  """
23708
- Set mean and standard deviation.
23668
+ Mean and standard deviation.
23709
23669
  """
23710
23670
  version = '231'
23711
23671
  fluent_name = 'mean-and-std-deviation'
@@ -27736,7 +27696,7 @@ class boundary_conditions(Group, _ChildNamedObjectAccessorMixin):
27736
27696
 
27737
27697
  class area(Real):
27738
27698
  """
27739
- Set reference area for normalization.
27699
+ Reference area for normalization.
27740
27700
  """
27741
27701
  version = '231'
27742
27702
  fluent_name = 'area'
@@ -27745,7 +27705,7 @@ class area(Real):
27745
27705
 
27746
27706
  class depth(Real):
27747
27707
  """
27748
- Set reference depth for volume calculation.
27708
+ Reference depth for volume calculation.
27749
27709
  """
27750
27710
  version = '231'
27751
27711
  fluent_name = 'depth'
@@ -27754,7 +27714,7 @@ class depth(Real):
27754
27714
 
27755
27715
  class density_6(Real):
27756
27716
  """
27757
- Set reference density for normalization.
27717
+ Reference density for normalization.
27758
27718
  """
27759
27719
  version = '231'
27760
27720
  fluent_name = 'density'
@@ -27763,7 +27723,7 @@ class density_6(Real):
27763
27723
 
27764
27724
  class enthalpy(Real):
27765
27725
  """
27766
- Set reference enthalpy for enthalpy damping and normalization.
27726
+ Reference enthalpy for enthalpy damping and normalization.
27767
27727
  """
27768
27728
  version = '231'
27769
27729
  fluent_name = 'enthalpy'
@@ -27772,7 +27732,7 @@ class enthalpy(Real):
27772
27732
 
27773
27733
  class length(Real):
27774
27734
  """
27775
- Set reference length for normalization.
27735
+ Reference length for normalization.
27776
27736
  """
27777
27737
  version = '231'
27778
27738
  fluent_name = 'length'
@@ -27781,7 +27741,7 @@ class length(Real):
27781
27741
 
27782
27742
  class pressure(Real):
27783
27743
  """
27784
- Set reference pressure for normalization.
27744
+ Reference pressure for normalization.
27785
27745
  """
27786
27746
  version = '231'
27787
27747
  fluent_name = 'pressure'
@@ -27790,7 +27750,7 @@ class pressure(Real):
27790
27750
 
27791
27751
  class temperature_3(Real):
27792
27752
  """
27793
- Set reference temperature for normalization.
27753
+ Reference temperature for normalization.
27794
27754
  """
27795
27755
  version = '231'
27796
27756
  fluent_name = 'temperature'
@@ -27799,7 +27759,7 @@ class temperature_3(Real):
27799
27759
 
27800
27760
  class yplus(Real):
27801
27761
  """
27802
- Set reference yplus for normalization.
27762
+ Reference yplus for normalization.
27803
27763
  """
27804
27764
  version = '231'
27805
27765
  fluent_name = 'yplus'
@@ -27808,7 +27768,7 @@ class yplus(Real):
27808
27768
 
27809
27769
  class velocity_2(Real):
27810
27770
  """
27811
- Set reference velocity for normalization.
27771
+ Reference velocity for normalization.
27812
27772
  """
27813
27773
  version = '231'
27814
27774
  fluent_name = 'velocity'
@@ -27817,7 +27777,7 @@ class velocity_2(Real):
27817
27777
 
27818
27778
  class viscosity_3(Real):
27819
27779
  """
27820
- Set reference viscosity for normalization.
27780
+ Reference viscosity for normalization.
27821
27781
  """
27822
27782
  version = '231'
27823
27783
  fluent_name = 'viscosity'
@@ -27826,7 +27786,7 @@ class viscosity_3(Real):
27826
27786
 
27827
27787
  class zone(String):
27828
27788
  """
27829
- Set reference zone.
27789
+ Reference zone.
27830
27790
  """
27831
27791
  version = '231'
27832
27792
  fluent_name = 'zone'
@@ -28035,8 +27995,7 @@ class setup(Group):
28035
27995
 
28036
27996
  class under_relaxation_factor(Real):
28037
27997
  """
28038
- Specify under-relaxation factor to be used in
28039
- the diagonal matrix elements of implicit solver.
27998
+ Under-relaxation factor to be used in .
28040
27999
  """
28041
28000
  version = '231'
28042
28001
  fluent_name = 'under-relaxation-factor'
@@ -28045,8 +28004,7 @@ class under_relaxation_factor(Real):
28045
28004
 
28046
28005
  class explicit_relaxation_factor(Real):
28047
28006
  """
28048
- Specify explicit relaxation factor to be applied to
28049
- the solution correction when updating solution in the timestep iterations.
28007
+ Explicit relaxation factor to be applied to.
28050
28008
  """
28051
28009
  version = '231'
28052
28010
  fluent_name = 'explicit-relaxation-factor'
@@ -28055,7 +28013,7 @@ class explicit_relaxation_factor(Real):
28055
28013
 
28056
28014
  class expert(Group):
28057
28015
  """
28058
- Enter menu for expert controls.
28016
+ Object.
28059
28017
  """
28060
28018
  version = '231'
28061
28019
  fluent_name = 'expert'
@@ -28069,8 +28027,7 @@ class expert(Group):
28069
28027
 
28070
28028
  class relative_convergence_criterion(Real):
28071
28029
  """
28072
- Specify convergence tolerance for the timestep iterations
28073
- as the target residual reduction factor.
28030
+ Convergence tolerance for the timestep iterations.
28074
28031
  """
28075
28032
  version = '231'
28076
28033
  fluent_name = 'relative-convergence-criterion'
@@ -28079,7 +28036,7 @@ class relative_convergence_criterion(Real):
28079
28036
 
28080
28037
  class max_iter_per_timestep_count(Integer):
28081
28038
  """
28082
- Specify maximum number of iterations per timestep.
28039
+ Maximum number of iterations per timestep.
28083
28040
  """
28084
28041
  version = '231'
28085
28042
  fluent_name = 'max-iter-per-timestep-count'
@@ -28088,7 +28045,7 @@ class max_iter_per_timestep_count(Integer):
28088
28045
 
28089
28046
  class acoustics_wave_eqn_controls(Group):
28090
28047
  """
28091
- Enter menu for acoustics wave equation solver controls.
28048
+ Object.
28092
28049
  """
28093
28050
  version = '231'
28094
28051
  fluent_name = 'acoustics-wave-eqn-controls'
@@ -28244,7 +28201,7 @@ class aggressive_coarsening(Boolean):
28244
28201
 
28245
28202
  class laplace_coarsening(Boolean):
28246
28203
  """
28247
- Set AMG laplace coarsening options.
28204
+ AMG laplace coarsening options.
28248
28205
  """
28249
28206
  version = '231'
28250
28207
  fluent_name = 'laplace-coarsening?'
@@ -28955,7 +28912,7 @@ class runge_kutta(Group):
28955
28912
 
28956
28913
  class fast_transient_settings(Group):
28957
28914
  """
28958
- Enter the fast transient settings menu.
28915
+ The fast transient settings object.
28959
28916
  """
28960
28917
  version = '231'
28961
28918
  fluent_name = 'fast-transient-settings'
@@ -28968,7 +28925,7 @@ class fast_transient_settings(Group):
28968
28925
 
28969
28926
  class relaxation_method(String):
28970
28927
  """
28971
- Set the solver relaxation method.
28928
+ The solver relaxation method.
28972
28929
  """
28973
28930
  version = '231'
28974
28931
  fluent_name = 'relaxation-method'
@@ -28996,7 +28953,7 @@ class correction_tolerance(NamedObject[correction_tolerance_child], _NonCreatabl
28996
28953
 
28997
28954
  class flux(String, AllowedValuesMixin):
28998
28955
  """
28999
- Select the heat flux calculation method for solid zones.
28956
+ The heat flux calculation method for solid zones.
29000
28957
  """
29001
28958
  version = '231'
29002
28959
  fluent_name = 'flux'
@@ -29005,7 +28962,7 @@ class flux(String, AllowedValuesMixin):
29005
28962
 
29006
28963
  class gradient(String, AllowedValuesMixin):
29007
28964
  """
29008
- Select the temperature gradient calculation method for solid zones.
28965
+ The temperature gradient calculation method for solid zones.
29009
28966
  """
29010
28967
  version = '231'
29011
28968
  fluent_name = 'gradient'
@@ -29056,7 +29013,7 @@ class solution_stabilization(Boolean):
29056
29013
 
29057
29014
  class verbosity_4(Integer):
29058
29015
  """
29059
- Specify verbosity level for contact solution controls.
29016
+ Verbosity level for contact solution controls.
29060
29017
  """
29061
29018
  version = '231'
29062
29019
  fluent_name = 'verbosity'
@@ -29065,7 +29022,7 @@ class verbosity_4(Integer):
29065
29022
 
29066
29023
  class iter_count(Integer):
29067
29024
  """
29068
- Specify additional iterations to accomodate contact solution stabilization.
29025
+ Additional iterations to accomodate contact solution stabilization.
29069
29026
  """
29070
29027
  version = '231'
29071
29028
  fluent_name = 'iter-count'
@@ -29083,7 +29040,7 @@ class solution_stabilization_persistence(Integer):
29083
29040
 
29084
29041
  class persistence_fixed_time_steps(Integer):
29085
29042
  """
29086
- Specify fixed time-steps for solution stabilization persistence after trigger.
29043
+ Fixed time-steps for solution stabilization persistence after trigger.
29087
29044
  """
29088
29045
  version = '231'
29089
29046
  fluent_name = 'persistence-fixed-time-steps'
@@ -29092,7 +29049,7 @@ class persistence_fixed_time_steps(Integer):
29092
29049
 
29093
29050
  class persistence_fixed_duration(Real):
29094
29051
  """
29095
- Specify fixed time for solution stabilization persistence after trigger.
29052
+ Fixed time for solution stabilization persistence after trigger.
29096
29053
  """
29097
29054
  version = '231'
29098
29055
  fluent_name = 'persistence-fixed-duration'
@@ -29127,7 +29084,7 @@ class parameters_1(Group):
29127
29084
 
29128
29085
  class first_to_second_order_blending(Real):
29129
29086
  """
29130
- Set factor to control first order to second order blending.
29087
+ Factor to control first order to second order blending.
29131
29088
  """
29132
29089
  version = '231'
29133
29090
  fluent_name = 'first-to-second-order-blending'
@@ -29145,7 +29102,7 @@ class first_to_second_order_blending_list(RealList):
29145
29102
 
29146
29103
  class scheme_1(Integer):
29147
29104
  """
29148
- Set advection scheme for contact event stability.
29105
+ Advection scheme for contact event stability.
29149
29106
  """
29150
29107
  version = '231'
29151
29108
  fluent_name = 'scheme'
@@ -29181,7 +29138,7 @@ class rhie_chow_flux_specify(Boolean):
29181
29138
 
29182
29139
  class rhie_chow_method(Integer):
29183
29140
  """
29184
- Enter the rhie-chow flux method.
29141
+ The rhie-chow flux method.
29185
29142
  """
29186
29143
  version = '231'
29187
29144
  fluent_name = 'rhie-chow-method'
@@ -29218,7 +29175,7 @@ class transient_parameters_specify(Boolean):
29218
29175
 
29219
29176
  class transient_scheme(Integer):
29220
29177
  """
29221
- Set temporal scheme to be used.
29178
+ Temporal scheme to be used.
29222
29179
  """
29223
29180
  version = '231'
29224
29181
  fluent_name = 'transient-scheme'
@@ -29227,7 +29184,7 @@ class transient_scheme(Integer):
29227
29184
 
29228
29185
  class time_scale_modification_method(Integer):
29229
29186
  """
29230
- Set time scale modification method [0-time-step, 1-cfl].
29187
+ Time scale modification method [0-time-step, 1-cfl].
29231
29188
  """
29232
29189
  version = '231'
29233
29190
  fluent_name = 'time-scale-modification-method'
@@ -29236,7 +29193,7 @@ class time_scale_modification_method(Integer):
29236
29193
 
29237
29194
  class time_scale_modification_factor(Real):
29238
29195
  """
29239
- Set time-scale modification factor.
29196
+ Time-scale modification factor.
29240
29197
  """
29241
29198
  version = '231'
29242
29199
  fluent_name = 'time-scale-modification-factor'
@@ -29279,7 +29236,7 @@ class increase_pre_sweeps(Boolean):
29279
29236
 
29280
29237
  class pre_sweeps_3(Integer):
29281
29238
  """
29282
- Set the number of AMG pre-sweeps.
29239
+ The number of AMG pre-sweeps.
29283
29240
  """
29284
29241
  version = '231'
29285
29242
  fluent_name = 'pre-sweeps'
@@ -29297,7 +29254,7 @@ class specify_coarsening_rate(Boolean):
29297
29254
 
29298
29255
  class coarsen_rate(Integer):
29299
29256
  """
29300
- Set AMG coarsening rate.
29257
+ AMG coarsening rate.
29301
29258
  """
29302
29259
  version = '231'
29303
29260
  fluent_name = 'coarsen-rate'
@@ -29384,7 +29341,7 @@ class pv_coupling_controls(Boolean):
29384
29341
 
29385
29342
  class pv_coupling_method(Integer):
29386
29343
  """
29387
- Set pressure-velocity coupling method change for solver stability and accuracy.
29344
+ Pressure-velocity coupling method change for solver stability and accuracy.
29388
29345
  """
29389
29346
  version = '231'
29390
29347
  fluent_name = 'pv-coupling-method'
@@ -29402,7 +29359,7 @@ class gradient_controls(Boolean):
29402
29359
 
29403
29360
  class specify_gradient_method(Integer):
29404
29361
  """
29405
- Set gradient method for solver stability and accuracy.
29362
+ Gradient method for solver stability and accuracy.
29406
29363
  """
29407
29364
  version = '231'
29408
29365
  fluent_name = 'specify-gradient-method'
@@ -29436,7 +29393,7 @@ class compute_statistics(Boolean):
29436
29393
 
29437
29394
  class statistics_level(Integer):
29438
29395
  """
29439
- Set level of detail for solution statistics.
29396
+ Level of detail for solution statistics.
29440
29397
  """
29441
29398
  version = '231'
29442
29399
  fluent_name = 'statistics-level'
@@ -29491,7 +29448,7 @@ class contact_solution_controls(Group):
29491
29448
 
29492
29449
  class courant_number(Real):
29493
29450
  """
29494
- Set Courant number.
29451
+ Courant number.
29495
29452
  """
29496
29453
  version = '231'
29497
29454
  fluent_name = 'courant-number'
@@ -29528,7 +29485,7 @@ class min_pressure(Real):
29528
29485
 
29529
29486
  class max_pressure(Real):
29530
29487
  """
29531
- Set maximum allowable absolute pressure.
29488
+ Maximum allowable absolute pressure.
29532
29489
  """
29533
29490
  version = '231'
29534
29491
  fluent_name = 'max-pressure'
@@ -29537,7 +29494,7 @@ class max_pressure(Real):
29537
29494
 
29538
29495
  class min_temperature(Real):
29539
29496
  """
29540
- Set minimum allowable temperature.
29497
+ Minimum allowable temperature.
29541
29498
  """
29542
29499
  version = '231'
29543
29500
  fluent_name = 'min-temperature'
@@ -29546,7 +29503,7 @@ class min_temperature(Real):
29546
29503
 
29547
29504
  class max_temperature(Real):
29548
29505
  """
29549
- Set maximum allowable temperature.
29506
+ Maximum allowable temperature.
29550
29507
  """
29551
29508
  version = '231'
29552
29509
  fluent_name = 'max-temperature'
@@ -29555,7 +29512,7 @@ class max_temperature(Real):
29555
29512
 
29556
29513
  class min_tke(Real):
29557
29514
  """
29558
- Set minimum allowable k.
29515
+ Minimum allowable k.
29559
29516
  """
29560
29517
  version = '231'
29561
29518
  fluent_name = 'min-tke'
@@ -29564,7 +29521,7 @@ class min_tke(Real):
29564
29521
 
29565
29522
  class min_lam_tke(Real):
29566
29523
  """
29567
- Set minimum allowable k1.
29524
+ Minimum allowable k1.
29568
29525
  """
29569
29526
  version = '231'
29570
29527
  fluent_name = 'min-lam-tke'
@@ -29573,7 +29530,7 @@ class min_lam_tke(Real):
29573
29530
 
29574
29531
  class min_des_tke(Real):
29575
29532
  """
29576
- Set minimum allowable k.
29533
+ Minimum allowable k.
29577
29534
  """
29578
29535
  version = '231'
29579
29536
  fluent_name = 'min-des-tke'
@@ -29582,7 +29539,7 @@ class min_des_tke(Real):
29582
29539
 
29583
29540
  class min_epsilon(Real):
29584
29541
  """
29585
- Set minimum allowable epsilon.
29542
+ Minimum allowable epsilon.
29586
29543
  """
29587
29544
  version = '231'
29588
29545
  fluent_name = 'min-epsilon'
@@ -29591,7 +29548,7 @@ class min_epsilon(Real):
29591
29548
 
29592
29549
  class min_des_epsilon(Real):
29593
29550
  """
29594
- Set minimum allowable epsilon.
29551
+ Minimum allowable epsilon.
29595
29552
  """
29596
29553
  version = '231'
29597
29554
  fluent_name = 'min-des-epsilon'
@@ -29600,7 +29557,7 @@ class min_des_epsilon(Real):
29600
29557
 
29601
29558
  class min_v2f_tke(Real):
29602
29559
  """
29603
- Set minimum allowable k.
29560
+ Minimum allowable k.
29604
29561
  """
29605
29562
  version = '231'
29606
29563
  fluent_name = 'min-v2f-tke'
@@ -29609,7 +29566,7 @@ class min_v2f_tke(Real):
29609
29566
 
29610
29567
  class min_v2f_epsilon(Real):
29611
29568
  """
29612
- Set minimum allowable epsilon.
29569
+ Minimum allowable epsilon.
29613
29570
  """
29614
29571
  version = '231'
29615
29572
  fluent_name = 'min-v2f-epsilon'
@@ -29618,7 +29575,7 @@ class min_v2f_epsilon(Real):
29618
29575
 
29619
29576
  class min_vel_var_scale(Real):
29620
29577
  """
29621
- Set minimum allowable v2.
29578
+ Minimum allowable v2.
29622
29579
  """
29623
29580
  version = '231'
29624
29581
  fluent_name = 'min-vel-var-scale'
@@ -29627,7 +29584,7 @@ class min_vel_var_scale(Real):
29627
29584
 
29628
29585
  class min_elliptic_relax_func(Real):
29629
29586
  """
29630
- Set minimum allowable f.
29587
+ Minimum allowable f.
29631
29588
  """
29632
29589
  version = '231'
29633
29590
  fluent_name = 'min-elliptic-relax-func'
@@ -29636,7 +29593,7 @@ class min_elliptic_relax_func(Real):
29636
29593
 
29637
29594
  class min_omega(Real):
29638
29595
  """
29639
- Set minimum allowable omega.
29596
+ Minimum allowable omega.
29640
29597
  """
29641
29598
  version = '231'
29642
29599
  fluent_name = 'min-omega'
@@ -29645,7 +29602,7 @@ class min_omega(Real):
29645
29602
 
29646
29603
  class min_des_omega(Real):
29647
29604
  """
29648
- Set minimum allowable omega.
29605
+ Minimum allowable omega.
29649
29606
  """
29650
29607
  version = '231'
29651
29608
  fluent_name = 'min-des-omega'
@@ -29654,7 +29611,7 @@ class min_des_omega(Real):
29654
29611
 
29655
29612
  class max_turb_visc_ratio(Real):
29656
29613
  """
29657
- Set maximum allowable turbulent/laminar viscosity ratio.
29614
+ Maximum allowable turbulent/laminar viscosity ratio.
29658
29615
  """
29659
29616
  version = '231'
29660
29617
  fluent_name = 'max-turb-visc-ratio'
@@ -29663,7 +29620,7 @@ class max_turb_visc_ratio(Real):
29663
29620
 
29664
29621
  class positivity_rate(Real):
29665
29622
  """
29666
- Set positivity Rate Limit.
29623
+ Positivity Rate Limit.
29667
29624
  """
29668
29625
  version = '231'
29669
29626
  fluent_name = 'positivity-rate'
@@ -29672,7 +29629,7 @@ class positivity_rate(Real):
29672
29629
 
29673
29630
  class min_vol_frac_for_matrix_sol(Real):
29674
29631
  """
29675
- Set Minimum Vol. Frac. for Matrix Solution.
29632
+ Minimum Vol. Frac. for Matrix Solution.
29676
29633
  """
29677
29634
  version = '231'
29678
29635
  fluent_name = 'min-vol-frac-for-matrix-sol'
@@ -29711,7 +29668,7 @@ class limits(Group):
29711
29668
 
29712
29669
  class skewness_correction_itr_count(Integer):
29713
29670
  """
29714
- Set iterations for skewness correction.
29671
+ Iterations for skewness correction.
29715
29672
  """
29716
29673
  version = '231'
29717
29674
  fluent_name = 'skewness-correction-itr-count'
@@ -29720,7 +29677,7 @@ class skewness_correction_itr_count(Integer):
29720
29677
 
29721
29678
  class neighbor_correction_itr_count(Integer):
29722
29679
  """
29723
- Set iterations for neighbor correction.
29680
+ Iterations for neighbor correction.
29724
29681
  """
29725
29682
  version = '231'
29726
29683
  fluent_name = 'neighbor-correction-itr-count'
@@ -29729,7 +29686,7 @@ class neighbor_correction_itr_count(Integer):
29729
29686
 
29730
29687
  class skewness_neighbor_coupling(Boolean):
29731
29688
  """
29732
- Set Skewness-Neighbor Coupling?.
29689
+ Skewness-Neighbor Coupling?.
29733
29690
  """
29734
29691
  version = '231'
29735
29692
  fluent_name = 'skewness-neighbor-coupling'
@@ -29738,7 +29695,7 @@ class skewness_neighbor_coupling(Boolean):
29738
29695
 
29739
29696
  class vof_correction_itr_count(Integer):
29740
29697
  """
29741
- Set iterations for vof correction.
29698
+ Iterations for vof correction.
29742
29699
  """
29743
29700
  version = '231'
29744
29701
  fluent_name = 'vof-correction-itr-count'
@@ -29747,7 +29704,7 @@ class vof_correction_itr_count(Integer):
29747
29704
 
29748
29705
  class explicit_momentum_under_relaxation(Real):
29749
29706
  """
29750
- Set explicit momentum under-relaxation.
29707
+ Explicit momentum under-relaxation.
29751
29708
  """
29752
29709
  version = '231'
29753
29710
  fluent_name = 'explicit-momentum-under-relaxation'
@@ -29756,7 +29713,7 @@ class explicit_momentum_under_relaxation(Real):
29756
29713
 
29757
29714
  class explicit_pressure_under_relaxation(Real):
29758
29715
  """
29759
- Set explicit pressure under-relaxation.
29716
+ Explicit pressure under-relaxation.
29760
29717
  """
29761
29718
  version = '231'
29762
29719
  fluent_name = 'explicit-pressure-under-relaxation'
@@ -29783,7 +29740,7 @@ class volume_fraction_courant_number(Real):
29783
29740
 
29784
29741
  class explicit_volume_fraction_under_relaxation(Real):
29785
29742
  """
29786
- Set explicit volume fraction under-relaxation.
29743
+ Explicit volume fraction under-relaxation.
29787
29744
  """
29788
29745
  version = '231'
29789
29746
  fluent_name = 'explicit-volume-fraction-under-relaxation'
@@ -29933,7 +29890,7 @@ class under_relaxation_child(Real):
29933
29890
 
29934
29891
  class under_relaxation(NamedObject[under_relaxation_child], _NonCreatableNamedObjectMixin[under_relaxation_child]):
29935
29892
  """
29936
- Enter Under Relaxation Menu.
29893
+ Under Relaxation Menu.
29937
29894
  """
29938
29895
  version = '231'
29939
29896
  fluent_name = 'under-relaxation'
@@ -29995,7 +29952,7 @@ class pseudo_time_explicit_relaxation_factor(Group):
29995
29952
 
29996
29953
  class pseudo_time_courant_number(Real):
29997
29954
  """
29998
- Set courant number for the local pseudo time method.
29955
+ Courant number for the local pseudo time method.
29999
29956
  """
30000
29957
  version = '231'
30001
29958
  fluent_name = 'pseudo-time-courant-number'
@@ -30013,7 +29970,7 @@ class pseudo_time_step_method_solid_zone(Boolean):
30013
29970
 
30014
29971
  class time_step_size_scale_factor(Real):
30015
29972
  """
30016
- Set time step size scale factor for solid zones.
29973
+ Time step size scale factor for solid zones.
30017
29974
  """
30018
29975
  version = '231'
30019
29976
  fluent_name = 'time-step-size-scale-factor'
@@ -30079,7 +30036,7 @@ class convergence_acceleration_type(String, AllowedValuesMixin):
30079
30036
 
30080
30037
  class casm_cutoff_multiplier(Real):
30081
30038
  """
30082
- Enter CASM cut-off multiplier :.
30039
+ CASM cut-off multiplier :.
30083
30040
  """
30084
30041
  version = '231'
30085
30042
  fluent_name = 'casm-cutoff-multiplier'
@@ -30193,7 +30150,7 @@ class alternate_diffusion_for_porous_region_solids(Boolean):
30193
30150
 
30194
30151
  class numerics_pbns(Group):
30195
30152
  """
30196
- Set numeric options.
30153
+ Numeric options.
30197
30154
  """
30198
30155
  version = '231'
30199
30156
  fluent_name = 'numerics-pbns'
@@ -30234,7 +30191,7 @@ class numerics_dbns(Group):
30234
30191
 
30235
30192
  class expert_2(Group):
30236
30193
  """
30237
- Enter expert menu.
30194
+ Expert object.
30238
30195
  """
30239
30196
  version = '231'
30240
30197
  fluent_name = 'expert'
@@ -30250,7 +30207,7 @@ class expert_2(Group):
30250
30207
 
30251
30208
  class flux_type_1(String, AllowedValuesMixin):
30252
30209
  """
30253
- Set Flux Type.
30210
+ Flux Type.
30254
30211
  """
30255
30212
  version = '231'
30256
30213
  fluent_name = 'flux-type'
@@ -30304,7 +30261,7 @@ class pbns_cases(Group):
30304
30261
 
30305
30262
  class flux_type(Group):
30306
30263
  """
30307
- Enter the flux type.
30264
+ The flux type.
30308
30265
  """
30309
30266
  version = '231'
30310
30267
  fluent_name = 'flux-type'
@@ -30327,7 +30284,7 @@ class frozen_flux(Boolean):
30327
30284
 
30328
30285
  class gradient_scheme(String, AllowedValuesMixin):
30329
30286
  """
30330
- Set gradient scheme.
30287
+ Gradient scheme.
30331
30288
  """
30332
30289
  version = '231'
30333
30290
  fluent_name = 'gradient-scheme'
@@ -30345,7 +30302,7 @@ class enable_5(Boolean):
30345
30302
 
30346
30303
  class relaxation_factor_2(Real):
30347
30304
  """
30348
- Set relaxation factor.
30305
+ Relaxation factor.
30349
30306
  """
30350
30307
  version = '231'
30351
30308
  fluent_name = 'relaxation-factor'
@@ -30354,7 +30311,7 @@ class relaxation_factor_2(Real):
30354
30311
 
30355
30312
  class select_variables(String, AllowedValuesMixin):
30356
30313
  """
30357
- Select variables for high order term relaxation.
30314
+ Variables for high order term relaxation.
30358
30315
  """
30359
30316
  version = '231'
30360
30317
  fluent_name = 'select-variables'
@@ -30363,7 +30320,7 @@ class select_variables(String, AllowedValuesMixin):
30363
30320
 
30364
30321
  class relaxation_options(String, AllowedValuesMixin):
30365
30322
  """
30366
- Enter high order relaxation option with respect to diffusion gradient.
30323
+ High order relaxation option with respect to diffusion gradient.
30367
30324
  """
30368
30325
  version = '231'
30369
30326
  fluent_name = 'relaxation-options'
@@ -30387,7 +30344,7 @@ class options_3(Group):
30387
30344
 
30388
30345
  class high_order_term_relaxation(Group):
30389
30346
  """
30390
- Enter High Order Relaxation Menu.
30347
+ High Order Relaxation Menu.
30391
30348
  """
30392
30349
  version = '231'
30393
30350
  fluent_name = 'high-order-term-relaxation'
@@ -30419,7 +30376,7 @@ class capillary_pressure_as_diffusion(Boolean):
30419
30376
 
30420
30377
  class porous_media(Group):
30421
30378
  """
30422
- Multiphase miscellaneous porous media numerics menu.
30379
+ Multiphase miscellaneous porous media numerics object.
30423
30380
  """
30424
30381
  version = '231'
30425
30382
  fluent_name = 'porous-media'
@@ -30460,7 +30417,7 @@ class analytical_thermodynamic_derivatives(Boolean):
30460
30417
 
30461
30418
  class compressible_flow(Group):
30462
30419
  """
30463
- Multiphase compressible numerics options menu.
30420
+ Multiphase compressible numerics options object.
30464
30421
  """
30465
30422
  version = '231'
30466
30423
  fluent_name = 'compressible-flow'
@@ -30493,7 +30450,7 @@ class liquid_vof_factor(Boolean):
30493
30450
 
30494
30451
  class boiling_parameters(Group):
30495
30452
  """
30496
- Multiphase boiling parameters menu.
30453
+ Multiphase boiling parameters object.
30497
30454
  """
30498
30455
  version = '231'
30499
30456
  fluent_name = 'boiling-parameters'
@@ -30635,7 +30592,7 @@ class interfacial_artificial_viscosity(Group):
30635
30592
 
30636
30593
  class viscous_flow(Group):
30637
30594
  """
30638
- Multiphase viscous flow numerics options menu.
30595
+ Multiphase viscous flow numerics options object.
30639
30596
  """
30640
30597
  version = '231'
30641
30598
  fluent_name = 'viscous-flow'
@@ -30716,7 +30673,7 @@ class old_treatment_for_turbulent_diffusion(Boolean):
30716
30673
 
30717
30674
  class cavitation(Group):
30718
30675
  """
30719
- Cavitation numerics options menu.
30676
+ Cavitation numerics options object.
30720
30677
  """
30721
30678
  version = '231'
30722
30679
  fluent_name = 'cavitation'
@@ -30789,7 +30746,7 @@ class max_rel_humidity(Real):
30789
30746
 
30790
30747
  class evaporation_condensation(Group):
30791
30748
  """
30792
- Evaporation-condensation advanced options menu.
30749
+ Evaporation-condensation advanced options object.
30793
30750
  """
30794
30751
  version = '231'
30795
30752
  fluent_name = 'evaporation-condensation'
@@ -30834,7 +30791,7 @@ class two_resistance_boiling_framework(Boolean):
30834
30791
 
30835
30792
  class boiling(Group):
30836
30793
  """
30837
- Boiling advanced options menu.
30794
+ Boiling advanced options object.
30838
30795
  """
30839
30796
  version = '231'
30840
30797
  fluent_name = 'boiling'
@@ -30867,7 +30824,7 @@ class ia_grad_sym(Boolean):
30867
30824
 
30868
30825
  class area_density_1(Group):
30869
30826
  """
30870
- Interfacial area density menu.
30827
+ Interfacial area density object.
30871
30828
  """
30872
30829
  version = '231'
30873
30830
  fluent_name = 'area-density'
@@ -30890,7 +30847,7 @@ class alternative_energy_treatment(Boolean):
30890
30847
 
30891
30848
  class heat_mass_transfer(Group):
30892
30849
  """
30893
- Multiphase interphase heat and mass transfer numerics options menu.
30850
+ Multiphase interphase heat and mass transfer numerics options object.
30894
30851
  """
30895
30852
  version = '231'
30896
30853
  fluent_name = 'heat-mass-transfer'
@@ -30916,7 +30873,7 @@ class smoothed_density_stabilization_method(Boolean):
30916
30873
 
30917
30874
  class num_of_density_smoothing(Integer):
30918
30875
  """
30919
- Set number of density smoothings.
30876
+ Number of density smoothings.
30920
30877
  """
30921
30878
  version = '231'
30922
30879
  fluent_name = 'num-of-density-smoothing'
@@ -30925,7 +30882,7 @@ class num_of_density_smoothing(Integer):
30925
30882
 
30926
30883
  class false_time_step_linearization(Boolean):
30927
30884
  """
30928
- Set false time-step linearization for added stability.
30885
+ False time-step linearization for added stability.
30929
30886
  """
30930
30887
  version = '231'
30931
30888
  fluent_name = 'false-time-step-linearization?'
@@ -30943,7 +30900,7 @@ class enable_6(Boolean):
30943
30900
 
30944
30901
  class dt_init_limit(Real):
30945
30902
  """
30946
- Set maximum value for pseudo time step size during first iteration.
30903
+ Maximum value for pseudo time step size during first iteration.
30947
30904
  """
30948
30905
  version = '231'
30949
30906
  fluent_name = 'dt-init-limit'
@@ -30952,7 +30909,7 @@ class dt_init_limit(Real):
30952
30909
 
30953
30910
  class dt_max(Real):
30954
30911
  """
30955
- Set maximum pseudo time step size.
30912
+ Maximum pseudo time step size.
30956
30913
  """
30957
30914
  version = '231'
30958
30915
  fluent_name = 'dt-max'
@@ -30961,7 +30918,7 @@ class dt_max(Real):
30961
30918
 
30962
30919
  class dt_factor_min(Real):
30963
30920
  """
30964
- Set minimum limit for reduction in pseudo time step size.
30921
+ Minimum limit for reduction in pseudo time step size.
30965
30922
  """
30966
30923
  version = '231'
30967
30924
  fluent_name = 'dt-factor-min'
@@ -30970,7 +30927,7 @@ class dt_factor_min(Real):
30970
30927
 
30971
30928
  class dt_factor_max(Real):
30972
30929
  """
30973
- Set maximum limit for increase in pseudo time step size.
30930
+ Maximum limit for increase in pseudo time step size.
30974
30931
  """
30975
30932
  version = '231'
30976
30933
  fluent_name = 'dt-factor-max'
@@ -30979,7 +30936,7 @@ class dt_factor_max(Real):
30979
30936
 
30980
30937
  class max_velocity_ratio(Real):
30981
30938
  """
30982
- Set velocity ratio to freeze the time step size for better solution stability.
30939
+ Velocity ratio to freeze the time step size for better solution stability.
30983
30940
  """
30984
30941
  version = '231'
30985
30942
  fluent_name = 'max-velocity-ratio'
@@ -30988,7 +30945,7 @@ class max_velocity_ratio(Real):
30988
30945
 
30989
30946
  class auto_dt_advanced_controls(Group):
30990
30947
  """
30991
- Set automatic time-stepping controls for better solution stability.
30948
+ Automatic time-stepping controls for better solution stability.
30992
30949
  """
30993
30950
  version = '231'
30994
30951
  fluent_name = 'auto-dt-advanced-controls'
@@ -31040,7 +30997,7 @@ class blended_treatment_for_buoyancy_forces(Boolean):
31040
30997
 
31041
30998
  class coupled_vof(Group):
31042
30999
  """
31043
- Set Coupled VOF stability controls.
31000
+ Coupled VOF stability controls.
31044
31001
  """
31045
31002
  version = '231'
31046
31003
  fluent_name = 'coupled-vof'
@@ -31113,7 +31070,7 @@ class p_v_coupling_1(Group):
31113
31070
 
31114
31071
  class outer_iterations(Integer):
31115
31072
  """
31116
- Set number of outer iterations in hybrid nita.
31073
+ Number of outer iterations in hybrid nita.
31117
31074
  """
31118
31075
  version = '231'
31119
31076
  fluent_name = 'outer-iterations'
@@ -31122,7 +31079,7 @@ class outer_iterations(Integer):
31122
31079
 
31123
31080
  class initial_time_steps(Integer):
31124
31081
  """
31125
- Set number of initial time-steps.
31082
+ Number of initial time-steps.
31126
31083
  """
31127
31084
  version = '231'
31128
31085
  fluent_name = 'initial-time-steps'
@@ -31131,7 +31088,7 @@ class initial_time_steps(Integer):
31131
31088
 
31132
31089
  class initial_outer_iter(Integer):
31133
31090
  """
31134
- Set number of initial outer iterations.
31091
+ Number of initial outer iterations.
31135
31092
  """
31136
31093
  version = '231'
31137
31094
  fluent_name = 'initial-outer-iter'
@@ -31140,7 +31097,7 @@ class initial_outer_iter(Integer):
31140
31097
 
31141
31098
  class initial_outer_iterations(Group):
31142
31099
  """
31143
- Set hybrid nita start-up controls.
31100
+ Hybrid nita start-up controls.
31144
31101
  """
31145
31102
  version = '231'
31146
31103
  fluent_name = 'initial-outer-iterations'
@@ -31163,7 +31120,7 @@ class enable_instability_detector(Boolean):
31163
31120
 
31164
31121
  class set_cfl_limit(Real):
31165
31122
  """
31166
- Set Courant Number limit for detection of unstable event.
31123
+ Courant Number limit for detection of unstable event.
31167
31124
  """
31168
31125
  version = '231'
31169
31126
  fluent_name = 'set-cfl-limit'
@@ -31172,7 +31129,7 @@ class set_cfl_limit(Real):
31172
31129
 
31173
31130
  class set_cfl_type(String, AllowedValuesMixin):
31174
31131
  """
31175
- Set Courant Number type for detection of unstable event.
31132
+ Courant Number type for detection of unstable event.
31176
31133
  """
31177
31134
  version = '231'
31178
31135
  fluent_name = 'set-cfl-type'
@@ -31181,7 +31138,7 @@ class set_cfl_type(String, AllowedValuesMixin):
31181
31138
 
31182
31139
  class set_velocity_limit(Real):
31183
31140
  """
31184
- Set velocity limit for detection of unstable event.
31141
+ Velocity limit for detection of unstable event.
31185
31142
  """
31186
31143
  version = '231'
31187
31144
  fluent_name = 'set-velocity-limit'
@@ -31190,7 +31147,7 @@ class set_velocity_limit(Real):
31190
31147
 
31191
31148
  class unstable_event_outer_iterations(Integer):
31192
31149
  """
31193
- Set number of outer iterations for unstable event.
31150
+ Number of outer iterations for unstable event.
31194
31151
  """
31195
31152
  version = '231'
31196
31153
  fluent_name = 'unstable-event-outer-iterations'
@@ -31199,7 +31156,7 @@ class unstable_event_outer_iterations(Integer):
31199
31156
 
31200
31157
  class instability_detector(Group):
31201
31158
  """
31202
- Set Hybrid NITA instability detector controls.
31159
+ Hybrid NITA instability detector controls.
31203
31160
  """
31204
31161
  version = '231'
31205
31162
  fluent_name = 'instability-detector'
@@ -31272,7 +31229,7 @@ class enable_dynamic_strength(Boolean):
31272
31229
 
31273
31230
  class set_dynamic_strength_exponent(Real):
31274
31231
  """
31275
- Set cosine exponent in dynamic strength treatment.
31232
+ Cosine exponent in dynamic strength treatment.
31276
31233
  """
31277
31234
  version = '231'
31278
31235
  fluent_name = 'set-dynamic-strength-exponent'
@@ -31281,7 +31238,7 @@ class set_dynamic_strength_exponent(Real):
31281
31238
 
31282
31239
  class set_maximum_dynamic_strength(Real):
31283
31240
  """
31284
- Set maximum value of dynamic anti-diffusion strength.
31241
+ Maximum value of dynamic anti-diffusion strength.
31285
31242
  """
31286
31243
  version = '231'
31287
31244
  fluent_name = 'set-maximum-dynamic-strength'
@@ -31373,7 +31330,7 @@ class revert_to_pre_r20_1_default_settings(Group):
31373
31330
 
31374
31331
  class default_controls(Group):
31375
31332
  """
31376
- Multiphase default controls menu.
31333
+ Multiphase default controls object.
31377
31334
  """
31378
31335
  version = '231'
31379
31336
  fluent_name = 'default-controls'
@@ -31396,7 +31353,7 @@ class pressure_corr_grad(Boolean):
31396
31353
 
31397
31354
  class face_pressure_calculation_method(String):
31398
31355
  """
31399
- Set face pressure calculation method for corrector step .
31356
+ Face pressure calculation method for corrector step .
31400
31357
  """
31401
31358
  version = '231'
31402
31359
  fluent_name = 'face-pressure-calculation-method'
@@ -31414,7 +31371,7 @@ class exclude_transient_term_in_face_pressure_calc(Boolean):
31414
31371
 
31415
31372
  class face_pressure_options(Group):
31416
31373
  """
31417
- Set face pressure options.
31374
+ Face pressure options.
31418
31375
  """
31419
31376
  version = '231'
31420
31377
  fluent_name = 'face-pressure-options'
@@ -31429,7 +31386,7 @@ class face_pressure_options(Group):
31429
31386
 
31430
31387
  class face_pressure_controls(Group):
31431
31388
  """
31432
- Enter the face pressure expert controls menu.
31389
+ The face pressure expert controls object.
31433
31390
  """
31434
31391
  version = '231'
31435
31392
  fluent_name = 'face-pressure-controls'
@@ -31571,7 +31528,7 @@ class set_damping_strengths(NamedObject[set_damping_strengths_child], _NonCreata
31571
31528
 
31572
31529
  class set_velocity_cutoff(Real):
31573
31530
  """
31574
- Enter max velocity magnitude.
31531
+ Max velocity magnitude.
31575
31532
  """
31576
31533
  version = '231'
31577
31534
  fluent_name = 'set-velocity-cutoff'
@@ -31580,7 +31537,7 @@ class set_velocity_cutoff(Real):
31580
31537
 
31581
31538
  class set_damping_strength(Real):
31582
31539
  """
31583
- Enter damping Strength.
31540
+ Damping Strength.
31584
31541
  """
31585
31542
  version = '231'
31586
31543
  fluent_name = 'set-damping-strength'
@@ -31616,7 +31573,7 @@ class velocity_limiting_treatment(Group):
31616
31573
 
31617
31574
  class solution_stabilization_1(Group):
31618
31575
  """
31619
- VOF solution stabilization menu.
31576
+ VOF solution stabilization object.
31620
31577
  """
31621
31578
  version = '231'
31622
31579
  fluent_name = 'solution-stabilization'
@@ -31633,7 +31590,7 @@ class solution_stabilization_1(Group):
31633
31590
 
31634
31591
  class multiphase_numerics(Group):
31635
31592
  """
31636
- Enter the multiphase numerics options menu.
31593
+ The multiphase numerics options object.
31637
31594
  """
31638
31595
  version = '231'
31639
31596
  fluent_name = 'multiphase-numerics'
@@ -31672,7 +31629,7 @@ class nb_gradient_dbns(String, AllowedValuesMixin):
31672
31629
 
31673
31630
  class nb_gradient_boundary_option(Group):
31674
31631
  """
31675
- Set ggnb options.
31632
+ Ggnb options.
31676
31633
  """
31677
31634
  version = '231'
31678
31635
  fluent_name = 'nb-gradient-boundary-option'
@@ -31686,7 +31643,7 @@ class nb_gradient_boundary_option(Group):
31686
31643
 
31687
31644
  class set_verbosity(Integer):
31688
31645
  """
31689
- Set nita verbosity option.
31646
+ Nita verbosity option.
31690
31647
  """
31691
31648
  version = '231'
31692
31649
  fluent_name = 'set-verbosity'
@@ -31695,7 +31652,7 @@ class set_verbosity(Integer):
31695
31652
 
31696
31653
  class skewness_neighbor_coupling_1(Boolean):
31697
31654
  """
31698
- Set skewness neighbor coupling for nita.
31655
+ Skewness neighbor coupling for nita.
31699
31656
  """
31700
31657
  version = '231'
31701
31658
  fluent_name = 'skewness-neighbor-coupling?'
@@ -31713,7 +31670,7 @@ class enable_7(Boolean):
31713
31670
 
31714
31671
  class options_4(String, AllowedValuesMixin):
31715
31672
  """
31716
- Set hybrid nita option.
31673
+ Hybrid nita option.
31717
31674
  """
31718
31675
  version = '231'
31719
31676
  fluent_name = 'options'
@@ -31736,7 +31693,7 @@ class multi_phase_setting(Group):
31736
31693
 
31737
31694
  class single_phase_setting(String, AllowedValuesMixin):
31738
31695
  """
31739
- Set hybrid nita option.
31696
+ Hybrid nita option.
31740
31697
  """
31741
31698
  version = '231'
31742
31699
  fluent_name = 'single-phase-setting'
@@ -31745,7 +31702,7 @@ class single_phase_setting(String, AllowedValuesMixin):
31745
31702
 
31746
31703
  class hybrid_nita_settings(Group):
31747
31704
  """
31748
- Select a hybrid NITA settings option for faster performance and better robustness.
31705
+ A hybrid NITA settings option for faster performance and better robustness.
31749
31706
  """
31750
31707
  version = '231'
31751
31708
  fluent_name = 'hybrid-nita-settings'
@@ -31759,7 +31716,7 @@ class hybrid_nita_settings(Group):
31759
31716
 
31760
31717
  class nita_expert_controls(Group):
31761
31718
  """
31762
- Enter the nita expert controls menu.
31719
+ The nita expert controls object.
31763
31720
  """
31764
31721
  version = '231'
31765
31722
  fluent_name = 'nita-expert-controls'
@@ -31792,7 +31749,7 @@ class high_order_pressure(Boolean):
31792
31749
 
31793
31750
  class interpolation_method(String, AllowedValuesMixin):
31794
31751
  """
31795
- Choose the interpolation method for overset interface(s).
31752
+ The interpolation method for overset interface(s).
31796
31753
  """
31797
31754
  version = '231'
31798
31755
  fluent_name = 'interpolation-method'
@@ -31810,7 +31767,7 @@ class orphan_cell_treatment(Boolean):
31810
31767
 
31811
31768
  class mass_flux_correction_method(String, AllowedValuesMixin):
31812
31769
  """
31813
- Enter mass flux correction option at overset interfaces.
31770
+ Mass flux correction option at overset interfaces.
31814
31771
  """
31815
31772
  version = '231'
31816
31773
  fluent_name = 'mass-flux-correction-method'
@@ -31842,7 +31799,7 @@ class expert_3(Group):
31842
31799
 
31843
31800
  class overset_1(Group):
31844
31801
  """
31845
- Enter overset solver options menu.
31802
+ Overset solver options object.
31846
31803
  """
31847
31804
  version = '231'
31848
31805
  fluent_name = 'overset'
@@ -31885,7 +31842,7 @@ class solve_n_phase(Boolean):
31885
31842
 
31886
31843
  class p_v_coupling(Group):
31887
31844
  """
31888
- Select the pressure velocity coupling scheme.
31845
+ The pressure velocity coupling scheme.
31889
31846
  """
31890
31847
  version = '231'
31891
31848
  fluent_name = 'p-v-coupling'
@@ -31928,7 +31885,7 @@ class reduced_rank_extrapolation(Boolean):
31928
31885
 
31929
31886
  class subspace_size(Integer):
31930
31887
  """
31931
- Set subspace size.
31888
+ Subspace size.
31932
31889
  """
31933
31890
  version = '231'
31934
31891
  fluent_name = 'subspace-size'
@@ -31960,7 +31917,7 @@ class reduced_rank_extrapolation_options(Group):
31960
31917
 
31961
31918
  class residual_smoothing_factor(Real):
31962
31919
  """
31963
- Set residual smoothing factor.
31920
+ Residual smoothing factor.
31964
31921
  """
31965
31922
  version = '231'
31966
31923
  fluent_name = 'residual-smoothing-factor'
@@ -31969,7 +31926,7 @@ class residual_smoothing_factor(Real):
31969
31926
 
31970
31927
  class residual_smoothing_iter_count(Integer):
31971
31928
  """
31972
- Set number of implicit iterations.
31929
+ Number of implicit iterations.
31973
31930
  """
31974
31931
  version = '231'
31975
31932
  fluent_name = 'residual-smoothing-iter-count'
@@ -31978,7 +31935,7 @@ class residual_smoothing_iter_count(Integer):
31978
31935
 
31979
31936
  class residual_smoothing(Group):
31980
31937
  """
31981
- Set residual smoothing factor and number of iterations.
31938
+ Residual smoothing factor and number of iterations.
31982
31939
  """
31983
31940
  version = '231'
31984
31941
  fluent_name = 'residual-smoothing'
@@ -32073,7 +32030,7 @@ class new_framework_for_vof_specific_node_based_treatment(Boolean):
32073
32030
 
32074
32031
  class vof_numerics(Group):
32075
32032
  """
32076
- Set VOF numeric options.
32033
+ VOF numeric options.
32077
32034
  """
32078
32035
  version = '231'
32079
32036
  fluent_name = 'vof-numerics'
@@ -32131,7 +32088,7 @@ class enable_8(Command):
32131
32088
 
32132
32089
  class warped_face_gradient_correction(Group):
32133
32090
  """
32134
- Enter warped-face-gradient-correction menu.
32091
+ Warped-face-gradient-correction object.
32135
32092
  """
32136
32093
  version = '231'
32137
32094
  fluent_name = 'warped-face-gradient-correction'
@@ -32146,7 +32103,7 @@ class warped_face_gradient_correction(Group):
32146
32103
 
32147
32104
  class coupled_solver(String, AllowedValuesMixin):
32148
32105
  """
32149
- Select pseudo time step size formulation for the pseudo time method.
32106
+ Pseudo time step size formulation for the pseudo time method.
32150
32107
  """
32151
32108
  version = '231'
32152
32109
  fluent_name = 'coupled-solver'
@@ -32155,7 +32112,7 @@ class coupled_solver(String, AllowedValuesMixin):
32155
32112
 
32156
32113
  class segregated_solver(String, AllowedValuesMixin):
32157
32114
  """
32158
- Select pseudo time step size formulation for the pseudo time method.
32115
+ Pseudo time step size formulation for the pseudo time method.
32159
32116
  """
32160
32117
  version = '231'
32161
32118
  fluent_name = 'segregated-solver'
@@ -32164,7 +32121,7 @@ class segregated_solver(String, AllowedValuesMixin):
32164
32121
 
32165
32122
  class density_based_solver(String, AllowedValuesMixin):
32166
32123
  """
32167
- Select pseudo time step size formulation for the pseudo time method.
32124
+ Pseudo time step size formulation for the pseudo time method.
32168
32125
  """
32169
32126
  version = '231'
32170
32127
  fluent_name = 'density-based-solver'
@@ -32173,7 +32130,7 @@ class density_based_solver(String, AllowedValuesMixin):
32173
32130
 
32174
32131
  class formulation(Group):
32175
32132
  """
32176
- Select the pseudo time step size formulation for the pseudo time method.
32133
+ The pseudo time step size formulation for the pseudo time method.
32177
32134
  """
32178
32135
  version = '231'
32179
32136
  fluent_name = 'formulation'
@@ -32188,7 +32145,7 @@ class formulation(Group):
32188
32145
 
32189
32146
  class relaxation_method_1(String, AllowedValuesMixin):
32190
32147
  """
32191
- Select relaxation definition for pseudo time method.
32148
+ Relaxation definition for pseudo time method.
32192
32149
  """
32193
32150
  version = '231'
32194
32151
  fluent_name = 'relaxation-method'
@@ -32283,7 +32240,7 @@ class relaxation_bounds(Command):
32283
32240
 
32284
32241
  class pseudo_time_method(Group):
32285
32242
  """
32286
- Enter the pseudo time method menu.
32243
+ The pseudo time method object.
32287
32244
  """
32288
32245
  version = '231'
32289
32246
  fluent_name = 'pseudo-time-method'
@@ -33326,7 +33283,7 @@ class file_name_2(String, AllowedValuesMixin):
33326
33283
 
33327
33284
  class frequency(Integer):
33328
33285
  """
33329
- Specify how often convergence checks are performed.
33286
+ How often convergence checks are performed.
33330
33287
  """
33331
33288
  version = '231'
33332
33289
  fluent_name = 'frequency'
@@ -33512,7 +33469,7 @@ class report_plots(NamedObject[report_plots_child], CreatableNamedObjectMixinOld
33512
33469
 
33513
33470
  class previous_values_to_consider(Integer):
33514
33471
  """
33515
- Specify how often convergence checks are performed.
33472
+ How often convergence checks are performed.
33516
33473
  """
33517
33474
  version = '231'
33518
33475
  fluent_name = 'previous-values-to-consider'
@@ -34536,7 +34493,7 @@ class enabled_1(Boolean):
34536
34493
 
34537
34494
  class turbulent_intensity(Real):
34538
34495
  """
34539
- Set turbulent intensity.
34496
+ Turbulent intensity.
34540
34497
  """
34541
34498
  version = '231'
34542
34499
  fluent_name = 'turbulent-intensity'
@@ -34545,7 +34502,7 @@ class turbulent_intensity(Real):
34545
34502
 
34546
34503
  class turbulent_viscosity_ratio(Real):
34547
34504
  """
34548
- Set turbulent viscosity ratio.
34505
+ Turbulent viscosity ratio.
34549
34506
  """
34550
34507
  version = '231'
34551
34508
  fluent_name = 'turbulent-viscosity-ratio'
@@ -34569,7 +34526,7 @@ class localized_turb_init(Group):
34569
34526
 
34570
34527
  class reference_frame_2(String, AllowedValuesMixin):
34571
34528
  """
34572
- Set reference frame absolute or relative.
34529
+ Reference frame absolute or relative.
34573
34530
  """
34574
34531
  version = '231'
34575
34532
  fluent_name = 'reference-frame'
@@ -34596,7 +34553,7 @@ class species_reactions(Boolean):
34596
34553
 
34597
34554
  class set_turbulent_viscosity_ratio(Real):
34598
34555
  """
34599
- Set turbulent viscosity ratio used during FMG initialization.
34556
+ Turbulent viscosity ratio used during FMG initialization.
34600
34557
  """
34601
34558
  version = '231'
34602
34559
  fluent_name = 'set-turbulent-viscosity-ratio'
@@ -34605,7 +34562,7 @@ class set_turbulent_viscosity_ratio(Real):
34605
34562
 
34606
34563
  class fmg_options(Group):
34607
34564
  """
34608
- Enter the full-multigrid option menu.
34565
+ The full-multigrid option object.
34609
34566
  """
34610
34567
  version = '231'
34611
34568
  fluent_name = 'fmg-options'
@@ -34620,7 +34577,7 @@ class fmg_options(Group):
34620
34577
 
34621
34578
  class iter_count_1(Integer):
34622
34579
  """
34623
- Set the number of iterations.
34580
+ The number of iterations.
34624
34581
  """
34625
34582
  version = '231'
34626
34583
  fluent_name = 'iter-count'
@@ -34629,7 +34586,7 @@ class iter_count_1(Integer):
34629
34586
 
34630
34587
  class explicit_urf(RealList):
34631
34588
  """
34632
- Set Explicit URF for scalar equations.
34589
+ Explicit URF for scalar equations.
34633
34590
  """
34634
34591
  version = '231'
34635
34592
  fluent_name = 'explicit-urf'
@@ -34665,7 +34622,7 @@ class const_velocity(Boolean):
34665
34622
 
34666
34623
  class general_settings_1(Group):
34667
34624
  """
34668
- Enter the general settings menu.
34625
+ The general settings object.
34669
34626
  """
34670
34627
  version = '231'
34671
34628
  fluent_name = 'general-settings'
@@ -34692,7 +34649,7 @@ class averaged_turbulent_parameters(Boolean):
34692
34649
 
34693
34650
  class viscosity_ratio_1(Real):
34694
34651
  """
34695
- Set viscosity ratio.
34652
+ Viscosity ratio.
34696
34653
  """
34697
34654
  version = '231'
34698
34655
  fluent_name = 'viscosity-ratio'
@@ -34701,7 +34658,7 @@ class viscosity_ratio_1(Real):
34701
34658
 
34702
34659
  class turbulent_setting(Group):
34703
34660
  """
34704
- Enter the turbulent settings menu.
34661
+ The turbulent settings object.
34705
34662
  """
34706
34663
  version = '231'
34707
34664
  fluent_name = 'turbulent-setting'
@@ -34754,7 +34711,7 @@ class species_1(NamedObject[species_1_child], _NonCreatableNamedObjectMixin[spec
34754
34711
 
34755
34712
  class species_setting(Group):
34756
34713
  """
34757
- Enter the species settings menu.
34714
+ The species settings object.
34758
34715
  """
34759
34716
  version = '231'
34760
34717
  fluent_name = 'species-setting'
@@ -34768,7 +34725,7 @@ class species_setting(Group):
34768
34725
 
34769
34726
  class hybrid_init_options(Group):
34770
34727
  """
34771
- Enter the settings for hybrid initialization method.
34728
+ The settings for hybrid initialization method.
34772
34729
  """
34773
34730
  version = '231'
34774
34731
  fluent_name = 'hybrid-init-options'
@@ -34801,7 +34758,7 @@ class use_volumetric_smoothing(Boolean):
34801
34758
 
34802
34759
  class smoothing_relaxation_factor(Real):
34803
34760
  """
34804
- Set Smoothing relaxation factor (min : 0, max : 1).
34761
+ Smoothing relaxation factor (min : 0, max : 1).
34805
34762
  """
34806
34763
  version = '231'
34807
34764
  fluent_name = 'smoothing-relaxation-factor'
@@ -34819,7 +34776,7 @@ class execute_smoothing(Command):
34819
34776
 
34820
34777
  class vof_smooth_options(Group):
34821
34778
  """
34822
- Enter the vof patch/smooth options menu.
34779
+ The vof patch/smooth options object.
34823
34780
  """
34824
34781
  version = '231'
34825
34782
  fluent_name = 'vof-smooth-options'
@@ -35074,7 +35031,7 @@ class customize_fmg_initialization(Command):
35074
35031
 
35075
35032
  class fmg_initialization(Group):
35076
35033
  """
35077
- Enter the set full-multigrid for initialization menu.
35034
+ The set full-multigrid for initialization object.
35078
35035
  """
35079
35036
  version = '231'
35080
35037
  fluent_name = 'fmg-initialization'
@@ -35175,7 +35132,7 @@ class set_ramping_length(Boolean):
35175
35132
 
35176
35133
  class time_step_count(Integer):
35177
35134
  """
35178
- Set number of timesteps for ramping of sources.
35135
+ Number of timesteps for ramping of sources.
35179
35136
  """
35180
35137
  version = '231'
35181
35138
  fluent_name = 'time-step-count'
@@ -35617,7 +35574,7 @@ class solution_animations(NamedObject[solution_animations_child], CreatableNamed
35617
35574
 
35618
35575
  class name_2(String, AllowedValuesMixin):
35619
35576
  """
35620
- Specify the name of the dynamic poor mesh register.
35577
+ The name of the dynamic poor mesh register.
35621
35578
  """
35622
35579
  version = '231'
35623
35580
  fluent_name = 'name'
@@ -35626,7 +35583,7 @@ class name_2(String, AllowedValuesMixin):
35626
35583
 
35627
35584
  class register(String, AllowedValuesMixin):
35628
35585
  """
35629
- Specify the register to which poor mesh numerics is automatically applied.
35586
+ The register to which poor mesh numerics is automatically applied.
35630
35587
  """
35631
35588
  version = '231'
35632
35589
  fluent_name = 'register'
@@ -35635,7 +35592,7 @@ class register(String, AllowedValuesMixin):
35635
35592
 
35636
35593
  class option_13(String, AllowedValuesMixin):
35637
35594
  """
35638
- Select the frequency unit used for automatic marking of cells in a register for poor mesh numerics treatment.
35595
+ The frequency unit used for automatic marking of cells in a register for poor mesh numerics treatment.
35639
35596
  """
35640
35597
  version = '231'
35641
35598
  fluent_name = 'option'
@@ -35644,7 +35601,7 @@ class option_13(String, AllowedValuesMixin):
35644
35601
 
35645
35602
  class iterations(Integer):
35646
35603
  """
35647
- Set the frequency (in iterations) at which cells in the register are automatically marked for poor mesh numerics treatment.
35604
+ The frequency (in iterations) at which cells in the register are automatically marked for poor mesh numerics treatment.
35648
35605
  """
35649
35606
  version = '231'
35650
35607
  fluent_name = 'iterations'
@@ -35653,7 +35610,7 @@ class iterations(Integer):
35653
35610
 
35654
35611
  class time_steps(Integer):
35655
35612
  """
35656
- Set the frequency (in time steps) at which cells in the register are automatically marked for poor mesh numerics treatment.
35613
+ The frequency (in time steps) at which cells in the register are automatically marked for poor mesh numerics treatment.
35657
35614
  """
35658
35615
  version = '231'
35659
35616
  fluent_name = 'time-steps'
@@ -35686,7 +35643,7 @@ class active_1(Boolean):
35686
35643
 
35687
35644
  class verbosity_6(Integer):
35688
35645
  """
35689
- Set the verbosity of the console messages printed about the automatic application of poor mesh numerics.
35646
+ The verbosity of the console messages printed about the automatic application of poor mesh numerics.
35690
35647
  """
35691
35648
  version = '231'
35692
35649
  fluent_name = 'verbosity'
@@ -35927,7 +35884,7 @@ class user_defined_timestep(String, AllowedValuesMixin):
35927
35884
 
35928
35885
  class error_tolerance(Real):
35929
35886
  """
35930
- Set Truncation Error Tolerance.
35887
+ Truncation Error Tolerance.
35931
35888
  """
35932
35889
  version = '231'
35933
35890
  fluent_name = 'error-tolerance'
@@ -35936,7 +35893,7 @@ class error_tolerance(Real):
35936
35893
 
35937
35894
  class time_end(Real):
35938
35895
  """
35939
- Set Total Simulation Time.
35896
+ Total Simulation Time.
35940
35897
  """
35941
35898
  version = '231'
35942
35899
  fluent_name = 'time-end'
@@ -35945,7 +35902,7 @@ class time_end(Real):
35945
35902
 
35946
35903
  class min_time_step(Real):
35947
35904
  """
35948
- Set Minimum Time Step Size.
35905
+ Minimum Time Step Size.
35949
35906
  """
35950
35907
  version = '231'
35951
35908
  fluent_name = 'min-time-step'
@@ -35954,7 +35911,7 @@ class min_time_step(Real):
35954
35911
 
35955
35912
  class max_time_step(Real):
35956
35913
  """
35957
- Set Maximum Time Step Size.
35914
+ Maximum Time Step Size.
35958
35915
  """
35959
35916
  version = '231'
35960
35917
  fluent_name = 'max-time-step'
@@ -35963,7 +35920,7 @@ class max_time_step(Real):
35963
35920
 
35964
35921
  class min_step_change_factor(Real):
35965
35922
  """
35966
- Set Minimum Step Change Factor.
35923
+ Minimum Step Change Factor.
35967
35924
  """
35968
35925
  version = '231'
35969
35926
  fluent_name = 'min-step-change-factor'
@@ -35972,7 +35929,7 @@ class min_step_change_factor(Real):
35972
35929
 
35973
35930
  class max_step_change_factor(Real):
35974
35931
  """
35975
- Set Maximum Step Change Factor.
35932
+ Maximum Step Change Factor.
35976
35933
  """
35977
35934
  version = '231'
35978
35935
  fluent_name = 'max-step-change-factor'
@@ -35981,7 +35938,7 @@ class max_step_change_factor(Real):
35981
35938
 
35982
35939
  class fixed_time_step_count(Integer):
35983
35940
  """
35984
- Set Number of Fixed Time Steps.
35941
+ Number of Fixed Time Steps.
35985
35942
  """
35986
35943
  version = '231'
35987
35944
  fluent_name = 'fixed-time-step-count'
@@ -36020,7 +35977,7 @@ class enalbled(Boolean):
36020
35977
 
36021
35978
  class desired_cfl(Real):
36022
35979
  """
36023
- Set Courant Number.
35980
+ Courant Number.
36024
35981
  """
36025
35982
  version = '231'
36026
35983
  fluent_name = 'desired-cfl'
@@ -36029,7 +35986,7 @@ class desired_cfl(Real):
36029
35986
 
36030
35987
  class initial_time_step(Real):
36031
35988
  """
36032
- Set Initial Time Step Size.
35989
+ Initial Time Step Size.
36033
35990
  """
36034
35991
  version = '231'
36035
35992
  fluent_name = 'initial-time-step'
@@ -36038,7 +35995,7 @@ class initial_time_step(Real):
36038
35995
 
36039
35996
  class max_fixed_time_step(Integer):
36040
35997
  """
36041
- Set Number of Fixed Time Steps.
35998
+ Number of Fixed Time Steps.
36042
35999
  """
36043
36000
  version = '231'
36044
36001
  fluent_name = 'max-fixed-time-step'
@@ -36047,7 +36004,7 @@ class max_fixed_time_step(Integer):
36047
36004
 
36048
36005
  class update_interval_time_step_size(Integer):
36049
36006
  """
36050
- Set Time Step Size Update Interval.
36007
+ Time Step Size Update Interval.
36051
36008
  """
36052
36009
  version = '231'
36053
36010
  fluent_name = 'update-interval-time-step-size'
@@ -36088,7 +36045,7 @@ class data_sampling_1(Boolean):
36088
36045
 
36089
36046
  class sampling_interval(Integer):
36090
36047
  """
36091
- Set Sampling interval.
36048
+ Sampling interval.
36092
36049
  """
36093
36050
  version = '231'
36094
36051
  fluent_name = 'sampling-interval'
@@ -36234,7 +36191,7 @@ class specified_time_step(Boolean):
36234
36191
 
36235
36192
  class incremental_time(Real):
36236
36193
  """
36237
- Set Incremental Time.
36194
+ Incremental Time.
36238
36195
  """
36239
36196
  version = '231'
36240
36197
  fluent_name = 'incremental-time'
@@ -36243,7 +36200,7 @@ class incremental_time(Real):
36243
36200
 
36244
36201
  class max_iter_per_time_step(Integer):
36245
36202
  """
36246
- Set Max Iterations/Time Step.
36203
+ Max Iterations/Time Step.
36247
36204
  """
36248
36205
  version = '231'
36249
36206
  fluent_name = 'max-iter-per-time-step'
@@ -36252,7 +36209,7 @@ class max_iter_per_time_step(Integer):
36252
36209
 
36253
36210
  class time_step_count_2(Integer):
36254
36211
  """
36255
- Set inceremtal number of Time steps.
36212
+ Inceremtal number of Time steps.
36256
36213
  """
36257
36214
  version = '231'
36258
36215
  fluent_name = 'time-step-count'
@@ -36261,7 +36218,7 @@ class time_step_count_2(Integer):
36261
36218
 
36262
36219
  class total_time_step_count(Integer):
36263
36220
  """
36264
- Set total number of Time steps.
36221
+ Total number of Time steps.
36265
36222
  """
36266
36223
  version = '231'
36267
36224
  fluent_name = 'total-time-step-count'
@@ -36270,7 +36227,7 @@ class total_time_step_count(Integer):
36270
36227
 
36271
36228
  class total_time(Real):
36272
36229
  """
36273
- Set Total Simulation Time.
36230
+ Total Simulation Time.
36274
36231
  """
36275
36232
  version = '231'
36276
36233
  fluent_name = 'total-time'
@@ -36279,7 +36236,7 @@ class total_time(Real):
36279
36236
 
36280
36237
  class time_step_size(Real):
36281
36238
  """
36282
- Set the physical time step size.
36239
+ The physical time step size.
36283
36240
  """
36284
36241
  version = '231'
36285
36242
  fluent_name = 'time-step-size'
@@ -36297,7 +36254,7 @@ class solution_status(Boolean):
36297
36254
 
36298
36255
  class extrapolate_vars(Boolean):
36299
36256
  """
36300
- Enter the extrapolation menu.
36257
+ The extrapolation object.
36301
36258
  """
36302
36259
  version = '231'
36303
36260
  fluent_name = 'extrapolate-vars'
@@ -36306,7 +36263,7 @@ class extrapolate_vars(Boolean):
36306
36263
 
36307
36264
  class max_flow_time(Real):
36308
36265
  """
36309
- Set maximum flow time.
36266
+ Maximum flow time.
36310
36267
  """
36311
36268
  version = '231'
36312
36269
  fluent_name = 'max-flow-time'
@@ -36315,7 +36272,7 @@ class max_flow_time(Real):
36315
36272
 
36316
36273
  class control_time_step_size_variation(Boolean):
36317
36274
  """
36318
- Enter Control time step size variation.
36275
+ Control time step size variation.
36319
36276
  """
36320
36277
  version = '231'
36321
36278
  fluent_name = 'control-time-step-size-variation?'
@@ -36324,7 +36281,7 @@ class control_time_step_size_variation(Boolean):
36324
36281
 
36325
36282
  class use_average_cfl(Boolean):
36326
36283
  """
36327
- Enter Use Averaged CFL condition rather than maximum CFL condition.
36284
+ Use Averaged CFL condition rather than maximum CFL condition.
36328
36285
  """
36329
36286
  version = '231'
36330
36287
  fluent_name = 'use-average-cfl?'
@@ -36333,8 +36290,7 @@ class use_average_cfl(Boolean):
36333
36290
 
36334
36291
  class cfl_type(Integer):
36335
36292
  """
36336
- Set CFL type
36337
- [1]Convective [2]Convective-Diffusive [3]Acoustic [4]Flow.
36293
+ CFL type .
36338
36294
  """
36339
36295
  version = '231'
36340
36296
  fluent_name = 'cfl-type'
@@ -36343,7 +36299,7 @@ class cfl_type(Integer):
36343
36299
 
36344
36300
  class courant_number_1(Real):
36345
36301
  """
36346
- Set Courant Number.
36302
+ Courant Number.
36347
36303
  """
36348
36304
  version = '231'
36349
36305
  fluent_name = 'courant-number'
@@ -36352,7 +36308,7 @@ class courant_number_1(Real):
36352
36308
 
36353
36309
  class initial_time_step_size(Real):
36354
36310
  """
36355
- Set Initial Time Step Size.
36311
+ Initial Time Step Size.
36356
36312
  """
36357
36313
  version = '231'
36358
36314
  fluent_name = 'initial-time-step-size'
@@ -36361,7 +36317,7 @@ class initial_time_step_size(Real):
36361
36317
 
36362
36318
  class fixed_time_step_size(Integer):
36363
36319
  """
36364
- Set Number of Fixed Time Steps.
36320
+ Number of Fixed Time Steps.
36365
36321
  """
36366
36322
  version = '231'
36367
36323
  fluent_name = 'fixed-time-step-size'
@@ -36370,7 +36326,7 @@ class fixed_time_step_size(Integer):
36370
36326
 
36371
36327
  class min_time_step_size(Real):
36372
36328
  """
36373
- Set Minimum Time Step Size.
36329
+ Minimum Time Step Size.
36374
36330
  """
36375
36331
  version = '231'
36376
36332
  fluent_name = 'min-time-step-size'
@@ -36379,7 +36335,7 @@ class min_time_step_size(Real):
36379
36335
 
36380
36336
  class max_time_step_size(Real):
36381
36337
  """
36382
- Set Maximum Time Step Size.
36338
+ Maximum Time Step Size.
36383
36339
  """
36384
36340
  version = '231'
36385
36341
  fluent_name = 'max-time-step-size'
@@ -36388,7 +36344,7 @@ class max_time_step_size(Real):
36388
36344
 
36389
36345
  class update_interval(Integer):
36390
36346
  """
36391
- Set Time Step Size Update Interval.
36347
+ Time Step Size Update Interval.
36392
36348
  """
36393
36349
  version = '231'
36394
36350
  fluent_name = 'update-interval'
@@ -36417,7 +36373,7 @@ class cfl_based_time_stepping(Group):
36417
36373
 
36418
36374
  class error_tolerance_1(Real):
36419
36375
  """
36420
- Set Error Tolerance.
36376
+ Error Tolerance.
36421
36377
  """
36422
36378
  version = '231'
36423
36379
  fluent_name = 'error-tolerance'
@@ -36473,7 +36429,7 @@ class rotating_mesh_flow_predictor(Boolean):
36473
36429
 
36474
36430
  class global_courant_number(Real):
36475
36431
  """
36476
- Set Global Courant Number.
36432
+ Global Courant Number.
36477
36433
  """
36478
36434
  version = '231'
36479
36435
  fluent_name = 'global-courant-number'
@@ -36592,7 +36548,7 @@ class moving_mesh_constraint(Boolean):
36592
36548
 
36593
36549
  class mesh_courant_number(Real):
36594
36550
  """
36595
- Enter Moving Mesh Courant Number.
36551
+ Moving Mesh Courant Number.
36596
36552
  """
36597
36553
  version = '231'
36598
36554
  fluent_name = 'mesh-courant-number'
@@ -36676,7 +36632,7 @@ class time_scale_options(Group):
36676
36632
 
36677
36633
  class verbosity_7(Boolean):
36678
36634
  """
36679
- Set verbosity to print multiphase specific time scales.
36635
+ Verbosity to print multiphase specific time scales.
36680
36636
  """
36681
36637
  version = '231'
36682
36638
  fluent_name = 'verbosity?'
@@ -36719,7 +36675,7 @@ class choose_auto_time_stepping(Boolean):
36719
36675
 
36720
36676
  class time_step_size_1(Real):
36721
36677
  """
36722
- Enter the time step size in seconds.
36678
+ The time step size in seconds.
36723
36679
  """
36724
36680
  version = '231'
36725
36681
  fluent_name = 'time-step-size'
@@ -36743,7 +36699,7 @@ class solid_time_step_size(Group):
36743
36699
 
36744
36700
  class time_step_size_for_acoustic_export(Real):
36745
36701
  """
36746
- Set number of time step size for acoustic export.
36702
+ Number of time step size for acoustic export.
36747
36703
  """
36748
36704
  version = '231'
36749
36705
  fluent_name = 'time-step-size-for-acoustic-export'
@@ -36761,7 +36717,7 @@ class extrapolate_eqn_vars_child(Boolean):
36761
36717
 
36762
36718
  class extrapolate_eqn_vars(NamedObject[extrapolate_eqn_vars_child], _NonCreatableNamedObjectMixin[extrapolate_eqn_vars_child]):
36763
36719
  """
36764
- Enter the extrapolation menu.
36720
+ The extrapolation object.
36765
36721
  """
36766
36722
  version = '231'
36767
36723
  fluent_name = 'extrapolate-eqn-vars'
@@ -36829,7 +36785,7 @@ class time_step_method_1(String, AllowedValuesMixin):
36829
36785
 
36830
36786
  class pseudo_time_step_size(Real):
36831
36787
  """
36832
- Set pseudo time step size.
36788
+ Pseudo time step size.
36833
36789
  """
36834
36790
  version = '231'
36835
36791
  fluent_name = 'pseudo-time-step-size'
@@ -36976,7 +36932,7 @@ class data_sampling_options(Group):
36976
36932
 
36977
36933
  class iter_count_2(Integer):
36978
36934
  """
36979
- Set number of iterations.
36935
+ Number of iterations.
36980
36936
  """
36981
36937
  version = '231'
36982
36938
  fluent_name = 'iter-count'
@@ -36985,7 +36941,7 @@ class iter_count_2(Integer):
36985
36941
 
36986
36942
  class reporting_interval(Integer):
36987
36943
  """
36988
- Set number of solver iterations before returning to scheme.
36944
+ Number of solver iterations before returning to scheme.
36989
36945
  """
36990
36946
  version = '231'
36991
36947
  fluent_name = 'reporting-interval'
@@ -36994,7 +36950,7 @@ class reporting_interval(Integer):
36994
36950
 
36995
36951
  class residual_verbosity(Integer):
36996
36952
  """
36997
- Set the residual report verbosity.
36953
+ The residual report verbosity.
36998
36954
  """
36999
36955
  version = '231'
37000
36956
  fluent_name = 'residual-verbosity'
@@ -37003,7 +36959,7 @@ class residual_verbosity(Integer):
37003
36959
 
37004
36960
  class time_step_count_1(Real):
37005
36961
  """
37006
- Set the time step.
36962
+ The time step.
37007
36963
  """
37008
36964
  version = '231'
37009
36965
  fluent_name = 'time-step-count'
@@ -37012,7 +36968,7 @@ class time_step_count_1(Real):
37012
36968
 
37013
36969
  class total_period_count(Integer):
37014
36970
  """
37015
- Set number of total periods.
36971
+ Number of total periods.
37016
36972
  """
37017
36973
  version = '231'
37018
36974
  fluent_name = 'total-period-count'
@@ -37021,7 +36977,7 @@ class total_period_count(Integer):
37021
36977
 
37022
36978
  class max_iter_per_step(Integer):
37023
36979
  """
37024
- Set Maximum Number of iterations per time step.
36980
+ Maximum Number of iterations per time step.
37025
36981
  """
37026
36982
  version = '231'
37027
36983
  fluent_name = 'max-iter-per-step'
@@ -37039,7 +36995,7 @@ class postprocess(Boolean):
37039
36995
 
37040
36996
  class post_iter_per_time_step_count(Integer):
37041
36997
  """
37042
- Set Number of post-processing iterations per time step.
36998
+ Number of post-processing iterations per time step.
37043
36999
  """
37044
37000
  version = '231'
37045
37001
  fluent_name = 'post-iter-per-time-step-count'
@@ -37053,21 +37009,21 @@ class dual_time_iterate(Command):
37053
37009
  Parameters
37054
37010
  ----------
37055
37011
  total_period_count : int
37056
- Set number of total periods.
37012
+ Number of total periods.
37057
37013
  time_step_count : int
37058
- Set inceremtal number of Time steps.
37014
+ Inceremtal number of Time steps.
37059
37015
  total_time_step_count : int
37060
- Set total number of Time steps.
37016
+ Total number of Time steps.
37061
37017
  total_time : real
37062
- Set Total Simulation Time.
37018
+ Total Simulation Time.
37063
37019
  incremental_time : real
37064
- Set Incremental Time.
37020
+ Incremental Time.
37065
37021
  max_iter_per_step : int
37066
- Set Maximum Number of iterations per time step.
37022
+ Maximum Number of iterations per time step.
37067
37023
  postprocess : bool
37068
37024
  Enable/Disable Postprocess pollutant solution?.
37069
37025
  post_iter_per_time_step_count : int
37070
- Set Number of post-processing iterations per time step.
37026
+ Number of post-processing iterations per time step.
37071
37027
  """
37072
37028
  version = '231'
37073
37029
  fluent_name = 'dual-time-iterate'
@@ -37087,7 +37043,7 @@ class dual_time_iterate(Command):
37087
37043
 
37088
37044
  class iter_count_3(Integer):
37089
37045
  """
37090
- Set incremental number of time steps.
37046
+ Incremental number of time steps.
37091
37047
  """
37092
37048
  version = '231'
37093
37049
  fluent_name = 'iter-count'
@@ -37101,7 +37057,7 @@ class iterate(Command):
37101
37057
  Parameters
37102
37058
  ----------
37103
37059
  iter_count : int
37104
- Set incremental number of time steps.
37060
+ Incremental number of time steps.
37105
37061
  """
37106
37062
  version = '231'
37107
37063
  fluent_name = 'iterate'
@@ -39427,7 +39383,7 @@ class clip_to_range_2(Boolean):
39427
39383
 
39428
39384
  class surfaces_2(StringList):
39429
39385
  """
39430
- Set surfaces to be contoured.
39386
+ Surfaces to be contoured.
39431
39387
  """
39432
39388
  version = '231'
39433
39389
  fluent_name = 'surfaces'
@@ -39472,7 +39428,7 @@ class log_scale_2(Boolean):
39472
39428
 
39473
39429
  class n_contour(Integer):
39474
39430
  """
39475
- Set the number of contour levels.
39431
+ The number of contour levels.
39476
39432
  """
39477
39433
  version = '231'
39478
39434
  fluent_name = 'n-contour'
@@ -39499,7 +39455,7 @@ class render_mesh(Boolean):
39499
39455
 
39500
39456
  class banded_coloring(Boolean):
39501
39457
  """
39502
- Specify if contours should be colored in bands.
39458
+ Specifies whether contours should be colored in bands.
39503
39459
  """
39504
39460
  version = '231'
39505
39461
  fluent_name = 'banded-coloring'
@@ -39508,7 +39464,7 @@ class banded_coloring(Boolean):
39508
39464
 
39509
39465
  class number_of_bands(Integer):
39510
39466
  """
39511
- Specify the number of bands to be used for contours.
39467
+ The number of bands to be used for contours.
39512
39468
  """
39513
39469
  version = '231'
39514
39470
  fluent_name = 'number-of-bands'
@@ -39517,7 +39473,7 @@ class number_of_bands(Integer):
39517
39473
 
39518
39474
  class coloring_2(Group):
39519
39475
  """
39520
- Select coloring option.
39476
+ Coloring option.
39521
39477
  """
39522
39478
  version = '231'
39523
39479
  fluent_name = 'coloring'
@@ -39563,7 +39519,7 @@ class display_3(Boolean):
39563
39519
 
39564
39520
  class history_filename(Filename):
39565
39521
  """
39566
- Specify the name of the particle history file.
39522
+ The name of the particle history file.
39567
39523
  """
39568
39524
  version = '231'
39569
39525
  fluent_name = 'history-filename'
@@ -39572,7 +39528,7 @@ class history_filename(Filename):
39572
39528
 
39573
39529
  class report_default_variables(String):
39574
39530
  """
39575
- Set the report variables to default.
39531
+ The report variables to default.
39576
39532
  """
39577
39533
  version = '231'
39578
39534
  fluent_name = 'report-default-variables'
@@ -39581,7 +39537,7 @@ class report_default_variables(String):
39581
39537
 
39582
39538
  class track_single_particle_stream_1(Integer):
39583
39539
  """
39584
- Specify the stream ID to be tracked.
39540
+ The stream ID to be tracked.
39585
39541
  """
39586
39542
  version = '231'
39587
39543
  fluent_name = 'track-single-particle-stream?'
@@ -39590,7 +39546,7 @@ class track_single_particle_stream_1(Integer):
39590
39546
 
39591
39547
  class arrow_scale_1(Real):
39592
39548
  """
39593
- Set the scale factor for arrows drawn on particle tracks.
39549
+ The scale factor for arrows drawn on particle tracks.
39594
39550
  """
39595
39551
  version = '231'
39596
39552
  fluent_name = 'arrow-scale'
@@ -39599,7 +39555,7 @@ class arrow_scale_1(Real):
39599
39555
 
39600
39556
  class arrow_space_1(Real):
39601
39557
  """
39602
- Set the spacing factor for arrows drawn on particle tracks.
39558
+ The spacing factor for arrows drawn on particle tracks.
39603
39559
  """
39604
39560
  version = '231'
39605
39561
  fluent_name = 'arrow-space'
@@ -39608,7 +39564,7 @@ class arrow_space_1(Real):
39608
39564
 
39609
39565
  class coarsen_factor(Integer):
39610
39566
  """
39611
- Set the particle tracks coarsening factor.
39567
+ The particle tracks coarsening factor.
39612
39568
  """
39613
39569
  version = '231'
39614
39570
  fluent_name = 'coarsen-factor'
@@ -39617,7 +39573,7 @@ class coarsen_factor(Integer):
39617
39573
 
39618
39574
  class line_width_1(Real):
39619
39575
  """
39620
- Set the width for particle track.
39576
+ The width for particle track.
39621
39577
  """
39622
39578
  version = '231'
39623
39579
  fluent_name = 'line-width'
@@ -39646,7 +39602,7 @@ class particle_tracks(Group):
39646
39602
 
39647
39603
  class background(String):
39648
39604
  """
39649
- Set the background (window) color.
39605
+ The background (window) color.
39650
39606
  """
39651
39607
  version = '231'
39652
39608
  fluent_name = 'background'
@@ -39664,7 +39620,7 @@ class color_by_type(Boolean):
39664
39620
 
39665
39621
  class foreground(String):
39666
39622
  """
39667
- Set the foreground (text and window frame) color.
39623
+ The foreground (text and window frame) color.
39668
39624
  """
39669
39625
  version = '231'
39670
39626
  fluent_name = 'foreground'
@@ -39700,7 +39656,7 @@ class reset_color(Boolean):
39700
39656
 
39701
39657
  class reset(Command):
39702
39658
  """
39703
- To reset colors and/or materials to the defaults.
39659
+ Reset colors and/or materials to the defaults.
39704
39660
 
39705
39661
  Parameters
39706
39662
  ----------
@@ -39743,7 +39699,7 @@ class use_inherent_material_color_1(Boolean):
39743
39699
 
39744
39700
  class list_surfaces_by_color(Command):
39745
39701
  """
39746
- To list the surfaces by its color.
39702
+ List the surfaces by its color.
39747
39703
  """
39748
39704
  version = '231'
39749
39705
  fluent_name = 'list-surfaces-by-color'
@@ -39752,7 +39708,7 @@ class list_surfaces_by_color(Command):
39752
39708
 
39753
39709
  class list_surfaces_by_material(Command):
39754
39710
  """
39755
- To list the surfaces by its material.
39711
+ List the surfaces by its material.
39756
39712
  """
39757
39713
  version = '231'
39758
39714
  fluent_name = 'list-surfaces-by-material'
@@ -39778,7 +39734,7 @@ class by_surface(Group):
39778
39734
 
39779
39735
  class far_field_faces(String):
39780
39736
  """
39781
- Set the color of far field faces.
39737
+ The color of far field faces.
39782
39738
  """
39783
39739
  version = '231'
39784
39740
  fluent_name = 'far-field-faces'
@@ -39787,7 +39743,7 @@ class far_field_faces(String):
39787
39743
 
39788
39744
  class inlet_faces(String):
39789
39745
  """
39790
- Set the color of inlet faces.
39746
+ The color of inlet faces.
39791
39747
  """
39792
39748
  version = '231'
39793
39749
  fluent_name = 'inlet-faces'
@@ -39796,7 +39752,7 @@ class inlet_faces(String):
39796
39752
 
39797
39753
  class interior_faces(String):
39798
39754
  """
39799
- Set the color of interior faces.
39755
+ The color of interior faces.
39800
39756
  """
39801
39757
  version = '231'
39802
39758
  fluent_name = 'interior-faces'
@@ -39805,7 +39761,7 @@ class interior_faces(String):
39805
39761
 
39806
39762
  class internal_faces(String):
39807
39763
  """
39808
- Set the color of internal interface faces.
39764
+ The color of internal interface faces.
39809
39765
  """
39810
39766
  version = '231'
39811
39767
  fluent_name = 'internal-faces'
@@ -39814,7 +39770,7 @@ class internal_faces(String):
39814
39770
 
39815
39771
  class outlet_faces(String):
39816
39772
  """
39817
- Set the color of outlet faces.
39773
+ The color of outlet faces.
39818
39774
  """
39819
39775
  version = '231'
39820
39776
  fluent_name = 'outlet-faces'
@@ -39823,7 +39779,7 @@ class outlet_faces(String):
39823
39779
 
39824
39780
  class overset_faces(String):
39825
39781
  """
39826
- Set the color of overset faces.
39782
+ The color of overset faces.
39827
39783
  """
39828
39784
  version = '231'
39829
39785
  fluent_name = 'overset-faces'
@@ -39832,7 +39788,7 @@ class overset_faces(String):
39832
39788
 
39833
39789
  class periodic_faces(String):
39834
39790
  """
39835
- Set the color of periodic faces.
39791
+ The color of periodic faces.
39836
39792
  """
39837
39793
  version = '231'
39838
39794
  fluent_name = 'periodic-faces'
@@ -39841,7 +39797,7 @@ class periodic_faces(String):
39841
39797
 
39842
39798
  class rans_les_interface_faces(String):
39843
39799
  """
39844
- Set the color of RANS/LES interface faces.
39800
+ The color of RANS/LES interface faces.
39845
39801
  """
39846
39802
  version = '231'
39847
39803
  fluent_name = 'rans-les-interface-faces'
@@ -39850,7 +39806,7 @@ class rans_les_interface_faces(String):
39850
39806
 
39851
39807
  class symmetry_faces(String):
39852
39808
  """
39853
- Set the color of symmetric faces.
39809
+ The color of symmetric faces.
39854
39810
  """
39855
39811
  version = '231'
39856
39812
  fluent_name = 'symmetry-faces'
@@ -39859,7 +39815,7 @@ class symmetry_faces(String):
39859
39815
 
39860
39816
  class axis_faces(String):
39861
39817
  """
39862
- Set the color of axisymmetric faces.
39818
+ The color of axisymmetric faces.
39863
39819
  """
39864
39820
  version = '231'
39865
39821
  fluent_name = 'axis-faces'
@@ -39868,7 +39824,7 @@ class axis_faces(String):
39868
39824
 
39869
39825
  class free_surface_faces(String):
39870
39826
  """
39871
- Set the color of free-surface faces.
39827
+ The color of free-surface faces.
39872
39828
  """
39873
39829
  version = '231'
39874
39830
  fluent_name = 'free-surface-faces'
@@ -39877,7 +39833,7 @@ class free_surface_faces(String):
39877
39833
 
39878
39834
  class traction_faces(String):
39879
39835
  """
39880
- Set the color of traction faces.
39836
+ The color of traction faces.
39881
39837
  """
39882
39838
  version = '231'
39883
39839
  fluent_name = 'traction-faces'
@@ -39886,7 +39842,7 @@ class traction_faces(String):
39886
39842
 
39887
39843
  class wall_faces(String):
39888
39844
  """
39889
- Set the color of wall faces.
39845
+ The color of wall faces.
39890
39846
  """
39891
39847
  version = '231'
39892
39848
  fluent_name = 'wall-faces'
@@ -39895,7 +39851,7 @@ class wall_faces(String):
39895
39851
 
39896
39852
  class interface_faces(String):
39897
39853
  """
39898
- Set the color of mesh interfaces.
39854
+ The color of mesh interfaces.
39899
39855
  """
39900
39856
  version = '231'
39901
39857
  fluent_name = 'interface-faces'
@@ -39904,7 +39860,7 @@ class interface_faces(String):
39904
39860
 
39905
39861
  class surface_2(String):
39906
39862
  """
39907
- Set the color of surfaces.
39863
+ The color of surfaces.
39908
39864
  """
39909
39865
  version = '231'
39910
39866
  fluent_name = 'surface'
@@ -39913,7 +39869,7 @@ class surface_2(String):
39913
39869
 
39914
39870
  class skip_label(Integer):
39915
39871
  """
39916
- Set the number of labels to be skipped in the colopmap scale.
39872
+ The number of labels to be skipped in the colopmap scale.
39917
39873
  """
39918
39874
  version = '231'
39919
39875
  fluent_name = 'skip-label'
@@ -40004,10 +39960,7 @@ class lights_on(Boolean):
40004
39960
 
40005
39961
  class lighting_interpolation(String, AllowedValuesMixin):
40006
39962
  """
40007
- Set lighting interpolation method.
40008
- Use Phong shading to interpolate the normals for each pixel of a polygon and compute a color at every pixel.
40009
- Use Gouraud shading to calculate the color at each vertex of a polygon and interpolate it in the interior.
40010
- Use flat shading for meshes and polygons.
39963
+ Lighting interpolation method.
40011
39964
  """
40012
39965
  version = '231'
40013
39966
  fluent_name = 'lighting-interpolation'
@@ -40128,7 +40081,7 @@ class color_mode(String, AllowedValuesMixin):
40128
40081
 
40129
40082
  class hardcopy_format(String, AllowedValuesMixin):
40130
40083
  """
40131
- Set hardcopy file format.
40084
+ Hardcopy file format.
40132
40085
  """
40133
40086
  version = '231'
40134
40087
  fluent_name = 'hardcopy-format'
@@ -40245,7 +40198,7 @@ class use_window_resolution(Boolean):
40245
40198
 
40246
40199
  class standard_resolution(String, AllowedValuesMixin):
40247
40200
  """
40248
- Select from pre-defined resolution list.
40201
+ From pre-defined resolution list.
40249
40202
  """
40250
40203
  version = '231'
40251
40204
  fluent_name = 'standard-resolution'
@@ -40295,7 +40248,7 @@ class list_color_mode(Command):
40295
40248
 
40296
40249
  class picture(Group):
40297
40250
  """
40298
- Enter the hardcopy/save-picture options menu.
40251
+ The hardcopy/save-picture options object.
40299
40252
  """
40300
40253
  version = '231'
40301
40254
  fluent_name = 'picture'
@@ -41059,7 +41012,7 @@ class border(Boolean):
41059
41012
 
41060
41013
  class bottom(Real):
41061
41014
  """
41062
- Set the bottom boundary of the axes window.
41015
+ The bottom boundary of the axes window.
41063
41016
  """
41064
41017
  version = '231'
41065
41018
  fluent_name = 'bottom'
@@ -41068,7 +41021,7 @@ class bottom(Real):
41068
41021
 
41069
41022
  class clear_1(Boolean):
41070
41023
  """
41071
- Set the transparency of the axes window.
41024
+ The transparency of the axes window.
41072
41025
  """
41073
41026
  version = '231'
41074
41027
  fluent_name = 'clear?'
@@ -41077,7 +41030,7 @@ class clear_1(Boolean):
41077
41030
 
41078
41031
  class left(Real):
41079
41032
  """
41080
- Set the left boundary of the axes window.
41033
+ The left boundary of the axes window.
41081
41034
  """
41082
41035
  version = '231'
41083
41036
  fluent_name = 'left'
@@ -41086,7 +41039,7 @@ class left(Real):
41086
41039
 
41087
41040
  class right_1(Real):
41088
41041
  """
41089
- Set the right boundary of the axes window.
41042
+ The right boundary of the axes window.
41090
41043
  """
41091
41044
  version = '231'
41092
41045
  fluent_name = 'right'
@@ -41095,7 +41048,7 @@ class right_1(Real):
41095
41048
 
41096
41049
  class top(Real):
41097
41050
  """
41098
- Set the top boundary of the axes window.
41051
+ The top boundary of the axes window.
41099
41052
  """
41100
41053
  version = '231'
41101
41054
  fluent_name = 'top'
@@ -41113,7 +41066,7 @@ class visible_1(Boolean):
41113
41066
 
41114
41067
  class axes_2(Group):
41115
41068
  """
41116
- Enter the axes window options menu.
41069
+ The axes window options object.
41117
41070
  """
41118
41071
  version = '231'
41119
41072
  fluent_name = 'axes'
@@ -41141,7 +41094,7 @@ class border_1(Boolean):
41141
41094
 
41142
41095
  class bottom_1(Real):
41143
41096
  """
41144
- Set the bottom boundary of the main viewing window.
41097
+ The bottom boundary of the main viewing window.
41145
41098
  """
41146
41099
  version = '231'
41147
41100
  fluent_name = 'bottom'
@@ -41150,7 +41103,7 @@ class bottom_1(Real):
41150
41103
 
41151
41104
  class left_1(Real):
41152
41105
  """
41153
- Set the left boundary of the main viewing window.
41106
+ The left boundary of the main viewing window.
41154
41107
  """
41155
41108
  version = '231'
41156
41109
  fluent_name = 'left'
@@ -41159,7 +41112,7 @@ class left_1(Real):
41159
41112
 
41160
41113
  class right_2(Real):
41161
41114
  """
41162
- Set the right boundary of the main viewing window.
41115
+ The right boundary of the main viewing window.
41163
41116
  """
41164
41117
  version = '231'
41165
41118
  fluent_name = 'right'
@@ -41168,7 +41121,7 @@ class right_2(Real):
41168
41121
 
41169
41122
  class top_1(Real):
41170
41123
  """
41171
- Set the top boundary of the main viewing window.
41124
+ The top boundary of the main viewing window.
41172
41125
  """
41173
41126
  version = '231'
41174
41127
  fluent_name = 'top'
@@ -41186,7 +41139,7 @@ class visible_2(Boolean):
41186
41139
 
41187
41140
  class main(Group):
41188
41141
  """
41189
- Enter the main view window options menu.
41142
+ The main view window options object.
41190
41143
  """
41191
41144
  version = '231'
41192
41145
  fluent_name = 'main'
@@ -41213,7 +41166,7 @@ class border_2(Boolean):
41213
41166
 
41214
41167
  class bottom_2(Real):
41215
41168
  """
41216
- Set the bottom boundary of the color scale window.
41169
+ The bottom boundary of the color scale window.
41217
41170
  """
41218
41171
  version = '231'
41219
41172
  fluent_name = 'bottom'
@@ -41222,7 +41175,7 @@ class bottom_2(Real):
41222
41175
 
41223
41176
  class clear_2(Boolean):
41224
41177
  """
41225
- Set the transparency of the scale window.
41178
+ The transparency of the scale window.
41226
41179
  """
41227
41180
  version = '231'
41228
41181
  fluent_name = 'clear?'
@@ -41231,7 +41184,7 @@ class clear_2(Boolean):
41231
41184
 
41232
41185
  class format_1(String):
41233
41186
  """
41234
- Set the number format of the color scale window (e.g. %0.2e).
41187
+ The number format of the color scale window (e.g. %0.2e).
41235
41188
  """
41236
41189
  version = '231'
41237
41190
  fluent_name = 'format'
@@ -41240,7 +41193,7 @@ class format_1(String):
41240
41193
 
41241
41194
  class font_size_1(Real):
41242
41195
  """
41243
- Set the font size of the color scale window.
41196
+ The font size of the color scale window.
41244
41197
  """
41245
41198
  version = '231'
41246
41199
  fluent_name = 'font-size'
@@ -41249,7 +41202,7 @@ class font_size_1(Real):
41249
41202
 
41250
41203
  class left_2(Real):
41251
41204
  """
41252
- Set the left boundary of the color scale window.
41205
+ The left boundary of the color scale window.
41253
41206
  """
41254
41207
  version = '231'
41255
41208
  fluent_name = 'left'
@@ -41258,7 +41211,7 @@ class left_2(Real):
41258
41211
 
41259
41212
  class margin(Real):
41260
41213
  """
41261
- Set the margin of the color scale window.
41214
+ The margin of the color scale window.
41262
41215
  """
41263
41216
  version = '231'
41264
41217
  fluent_name = 'margin'
@@ -41267,7 +41220,7 @@ class margin(Real):
41267
41220
 
41268
41221
  class right_3(Real):
41269
41222
  """
41270
- Set the right boundary of the color scale window.
41223
+ The right boundary of the color scale window.
41271
41224
  """
41272
41225
  version = '231'
41273
41226
  fluent_name = 'right'
@@ -41276,7 +41229,7 @@ class right_3(Real):
41276
41229
 
41277
41230
  class top_2(Real):
41278
41231
  """
41279
- Set the top boundary of the color scale window.
41232
+ The top boundary of the color scale window.
41280
41233
  """
41281
41234
  version = '231'
41282
41235
  fluent_name = 'top'
@@ -41294,7 +41247,7 @@ class visible_3(Boolean):
41294
41247
 
41295
41248
  class scale_3(Group):
41296
41249
  """
41297
- Enter the color scale window options menu.
41250
+ The color scale window options object.
41298
41251
  """
41299
41252
  version = '231'
41300
41253
  fluent_name = 'scale'
@@ -41334,7 +41287,7 @@ class border_3(Boolean):
41334
41287
 
41335
41288
  class bottom_3(Real):
41336
41289
  """
41337
- Set the bottom boundary of the text window.
41290
+ The bottom boundary of the text window.
41338
41291
  """
41339
41292
  version = '231'
41340
41293
  fluent_name = 'bottom'
@@ -41370,7 +41323,7 @@ class date(Boolean):
41370
41323
 
41371
41324
  class left_3(Real):
41372
41325
  """
41373
- Set the left boundary of the text window.
41326
+ The left boundary of the text window.
41374
41327
  """
41375
41328
  version = '231'
41376
41329
  fluent_name = 'left'
@@ -41379,7 +41332,7 @@ class left_3(Real):
41379
41332
 
41380
41333
  class right_4(Real):
41381
41334
  """
41382
- Set the right boundary of the text window.
41335
+ The right boundary of the text window.
41383
41336
  """
41384
41337
  version = '231'
41385
41338
  fluent_name = 'right'
@@ -41388,7 +41341,7 @@ class right_4(Real):
41388
41341
 
41389
41342
  class top_3(Real):
41390
41343
  """
41391
- Set the top boundary of the text window.
41344
+ The top boundary of the text window.
41392
41345
  """
41393
41346
  version = '231'
41394
41347
  fluent_name = 'top'
@@ -41415,7 +41368,7 @@ class alignment(String, AllowedValuesMixin):
41415
41368
 
41416
41369
  class text(Group):
41417
41370
  """
41418
- Enter the text window options menu.
41371
+ The text window options object.
41419
41372
  """
41420
41373
  version = '231'
41421
41374
  fluent_name = 'text'
@@ -41438,7 +41391,7 @@ class text(Group):
41438
41391
 
41439
41392
  class background_1(String):
41440
41393
  """
41441
- Set the background color in the video picture.
41394
+ The background color in the video picture.
41442
41395
  """
41443
41396
  version = '231'
41444
41397
  fluent_name = 'background'
@@ -41447,7 +41400,7 @@ class background_1(String):
41447
41400
 
41448
41401
  class color_filter(String):
41449
41402
  """
41450
- Set the color filter options for the picture.
41403
+ The color filter options for the picture.
41451
41404
  """
41452
41405
  version = '231'
41453
41406
  fluent_name = 'color-filter'
@@ -41456,7 +41409,7 @@ class color_filter(String):
41456
41409
 
41457
41410
  class foreground_1(String):
41458
41411
  """
41459
- Set the foreground color in the video picture.
41412
+ The foreground color in the video picture.
41460
41413
  """
41461
41414
  version = '231'
41462
41415
  fluent_name = 'foreground'
@@ -41516,7 +41469,7 @@ class pixel_size(Group):
41516
41469
 
41517
41470
  class video(Group):
41518
41471
  """
41519
- Enter the video window options menu.
41472
+ The video window options object.
41520
41473
  """
41521
41474
  version = '231'
41522
41475
  fluent_name = 'video'
@@ -41542,7 +41495,7 @@ class border_4(Boolean):
41542
41495
 
41543
41496
  class bottom_4(Real):
41544
41497
  """
41545
- Set the bottom boundary of the X-Y plotter window.
41498
+ The bottom boundary of the X-Y plotter window.
41546
41499
  """
41547
41500
  version = '231'
41548
41501
  fluent_name = 'bottom'
@@ -41551,7 +41504,7 @@ class bottom_4(Real):
41551
41504
 
41552
41505
  class left_4(Real):
41553
41506
  """
41554
- Set the left boundary of the X-Y plotter window.
41507
+ The left boundary of the X-Y plotter window.
41555
41508
  """
41556
41509
  version = '231'
41557
41510
  fluent_name = 'left'
@@ -41560,7 +41513,7 @@ class left_4(Real):
41560
41513
 
41561
41514
  class right_5(Real):
41562
41515
  """
41563
- Set the right boundary of the X-Y plotter window.
41516
+ The right boundary of the X-Y plotter window.
41564
41517
  """
41565
41518
  version = '231'
41566
41519
  fluent_name = 'right'
@@ -41569,7 +41522,7 @@ class right_5(Real):
41569
41522
 
41570
41523
  class top_4(Real):
41571
41524
  """
41572
- Set the top boundary of the X-Y plotter window.
41525
+ The top boundary of the X-Y plotter window.
41573
41526
  """
41574
41527
  version = '231'
41575
41528
  fluent_name = 'top'
@@ -41587,7 +41540,7 @@ class visible_5(Boolean):
41587
41540
 
41588
41541
  class xy(Group):
41589
41542
  """
41590
- Enter the X-Y plot window options menu.
41543
+ The X-Y plot window options object.
41591
41544
  """
41592
41545
  version = '231'
41593
41546
  fluent_name = 'xy'
@@ -41623,7 +41576,7 @@ class ruler_1(Boolean):
41623
41576
 
41624
41577
  class logo_color(String, AllowedValuesMixin):
41625
41578
  """
41626
- Set logo color to white/black.
41579
+ Logo color to white/black.
41627
41580
  """
41628
41581
  version = '231'
41629
41582
  fluent_name = 'logo-color'
@@ -42009,7 +41962,7 @@ class increment(Integer):
42009
41962
 
42010
41963
  class set_custom_frames(Group):
42011
41964
  """
42012
- Set custom frames start, end, skip frames for video export.
41965
+ Custom frames start, end, skip frames for video export.
42013
41966
  """
42014
41967
  version = '231'
42015
41968
  fluent_name = 'set-custom-frames'
@@ -42024,7 +41977,7 @@ class set_custom_frames(Group):
42024
41977
 
42025
41978
  class fps(Integer):
42026
41979
  """
42027
- Set the Frame Per Sec(FPS) for exporting video file.
41980
+ The Frame Per Sec(FPS) for exporting video file.
42028
41981
  """
42029
41982
  version = '231'
42030
41983
  fluent_name = 'fps'
@@ -42033,7 +41986,7 @@ class fps(Integer):
42033
41986
 
42034
41987
  class format_2(String, AllowedValuesMixin):
42035
41988
  """
42036
- Set format for exporting video file.
41989
+ Format for exporting video file.
42037
41990
  """
42038
41991
  version = '231'
42039
41992
  fluent_name = 'format'
@@ -42042,7 +41995,7 @@ class format_2(String, AllowedValuesMixin):
42042
41995
 
42043
41996
  class quality_1(String, AllowedValuesMixin):
42044
41997
  """
42045
- Set quality for exporting video file.
41998
+ Quality for exporting video file.
42046
41999
  """
42047
42000
  version = '231'
42048
42001
  fluent_name = 'quality'
@@ -42069,7 +42022,7 @@ class use_original_resolution(Boolean):
42069
42022
 
42070
42023
  class scale_4(String, AllowedValuesMixin):
42071
42024
  """
42072
- Set scale by which video resolution will expand.
42025
+ Scale by which video resolution will expand.
42073
42026
  """
42074
42027
  version = '231'
42075
42028
  fluent_name = 'scale'
@@ -42078,7 +42031,7 @@ class scale_4(String, AllowedValuesMixin):
42078
42031
 
42079
42032
  class set_standard_resolution(String, AllowedValuesMixin):
42080
42033
  """
42081
- Select from pre-defined resolution list.
42034
+ From pre-defined resolution list.
42082
42035
  """
42083
42036
  version = '231'
42084
42037
  fluent_name = 'set-standard-resolution'
@@ -42087,7 +42040,7 @@ class set_standard_resolution(String, AllowedValuesMixin):
42087
42040
 
42088
42041
  class width_2(Integer):
42089
42042
  """
42090
- Set the width for exporting video file.
42043
+ The width for exporting video file.
42091
42044
  """
42092
42045
  version = '231'
42093
42046
  fluent_name = 'width'
@@ -42096,7 +42049,7 @@ class width_2(Integer):
42096
42049
 
42097
42050
  class height_2(Integer):
42098
42051
  """
42099
- Set the height for exporting video file.
42052
+ The height for exporting video file.
42100
42053
  """
42101
42054
  version = '231'
42102
42055
  fluent_name = 'height'
@@ -42123,7 +42076,7 @@ class enable_h264(Boolean):
42123
42076
 
42124
42077
  class bitrate(Integer):
42125
42078
  """
42126
- Set video bitrate(kbits/sec) for exporting video file.
42079
+ Video bitrate(kbits/sec) for exporting video file.
42127
42080
  """
42128
42081
  version = '231'
42129
42082
  fluent_name = 'bitrate'
@@ -42141,7 +42094,7 @@ class compression_method(String, AllowedValuesMixin):
42141
42094
 
42142
42095
  class keyframe(Integer):
42143
42096
  """
42144
- Set video keyframe rate for exporting video file.
42097
+ Video keyframe rate for exporting video file.
42145
42098
  """
42146
42099
  version = '231'
42147
42100
  fluent_name = 'keyframe'
@@ -42910,7 +42863,7 @@ class weighting(Boolean):
42910
42863
 
42911
42864
  class histogram_options(Group):
42912
42865
  """
42913
- Enter the settings menu for the histogram.
42866
+ The settings object.
42914
42867
  """
42915
42868
  version = '231'
42916
42869
  fluent_name = 'histogram-options'
@@ -42931,7 +42884,7 @@ class histogram_options(Group):
42931
42884
 
42932
42885
  class minimum_val(Real):
42933
42886
  """
42934
- Specify mimimum value of x-axis variable for histogram plots.
42887
+ Mimimum value of x-axis variable for histogram plots.
42935
42888
  """
42936
42889
  version = '231'
42937
42890
  fluent_name = 'minimum-val'
@@ -42940,7 +42893,7 @@ class minimum_val(Real):
42940
42893
 
42941
42894
  class maximum_val(Real):
42942
42895
  """
42943
- Specify maximum value of x-axis variable for histogram plots.
42896
+ Maximum value of x-axis variable for histogram plots.
42944
42897
  """
42945
42898
  version = '231'
42946
42899
  fluent_name = 'maximum-val'
@@ -42949,7 +42902,7 @@ class maximum_val(Real):
42949
42902
 
42950
42903
  class division_val(Integer):
42951
42904
  """
42952
- Specify the number of bins.
42905
+ The number of bins.
42953
42906
  """
42954
42907
  version = '231'
42955
42908
  fluent_name = 'division-val'
@@ -42958,7 +42911,7 @@ class division_val(Integer):
42958
42911
 
42959
42912
  class histogram_parameters(Group):
42960
42913
  """
42961
- Enter the parameter menu for the histogram.
42914
+ The parameter object.
42962
42915
  """
42963
42916
  version = '231'
42964
42917
  fluent_name = 'histogram-parameters'
@@ -43077,7 +43030,7 @@ class use_weighting(Boolean):
43077
43030
 
43078
43031
  class make_steady_from_unsteady_file(Boolean):
43079
43032
  """
43080
- Specify whether the unsteady sample is to be reduced into a steady-state injection file.
43033
+ Specifies whether the unsteady sample is to be reduced into a steady-state injection file.
43081
43034
  """
43082
43035
  version = '231'
43083
43036
  fluent_name = 'make-steady-from-unsteady-file?'
@@ -43313,7 +43266,7 @@ class list_settings(Command):
43313
43266
 
43314
43267
  class setup_reduction(Group):
43315
43268
  """
43316
- Set up the sample data reduction by specifying all relevant options and setting parameters as desired.
43269
+ Up the sample data reduction by specifying all relevant options and setting parameters as desired.
43317
43270
  """
43318
43271
  version = '231'
43319
43272
  fluent_name = 'setup-reduction'
@@ -43492,7 +43445,7 @@ class list_samples(Command):
43492
43445
 
43493
43446
  class sample_file(Filename):
43494
43447
  """
43495
- Enter the name of a sample file to be loaded.
43448
+ The name of a sample file to be loaded.
43496
43449
  """
43497
43450
  version = '231'
43498
43451
  fluent_name = 'sample-file'
@@ -43506,7 +43459,7 @@ class read_sample_file(Command):
43506
43459
  Parameters
43507
43460
  ----------
43508
43461
  sample_file : str
43509
- Enter the name of a sample file to be loaded.
43462
+ The name of a sample file to be loaded.
43510
43463
  """
43511
43464
  version = '231'
43512
43465
  fluent_name = 'read-sample-file'
@@ -43541,7 +43494,7 @@ class histogram(Group):
43541
43494
 
43542
43495
  class user_defined_functions_1(String):
43543
43496
  """
43544
- Set the DPM sampling output UDF.
43497
+ The DPM sampling output UDF.
43545
43498
  """
43546
43499
  version = '231'
43547
43500
  fluent_name = 'user-defined-functions'
@@ -43798,7 +43751,7 @@ class domain_val(String, AllowedValuesMixin):
43798
43751
 
43799
43752
  class all_bndry_zones(Boolean):
43800
43753
  """
43801
- Select all the boundary/interior zones.
43754
+ All the boundary/interior zones.
43802
43755
  """
43803
43756
  version = '231'
43804
43757
  fluent_name = 'all-bndry-zones?'
@@ -43841,7 +43794,7 @@ class mass_flow_1(Command):
43841
43794
  domain_val : str
43842
43795
  'domain_val' child.
43843
43796
  all_bndry_zones : bool
43844
- Select all the boundary/interior zones.
43797
+ All the boundary/interior zones.
43845
43798
  zone_list : List
43846
43799
  'zone_list' child.
43847
43800
  write_to_file : bool
@@ -43877,7 +43830,7 @@ class heat_transfer_1(Command):
43877
43830
  domain_val : str
43878
43831
  'domain_val' child.
43879
43832
  all_bndry_zones : bool
43880
- Select all the boundary/interior zones.
43833
+ All the boundary/interior zones.
43881
43834
  zone_list : List
43882
43835
  'zone_list' child.
43883
43836
  write_to_file : bool
@@ -43913,7 +43866,7 @@ class heat_transfer_sensible(Command):
43913
43866
  domain_val : str
43914
43867
  'domain_val' child.
43915
43868
  all_bndry_zones : bool
43916
- Select all the boundary/interior zones.
43869
+ All the boundary/interior zones.
43917
43870
  zone_list : List
43918
43871
  'zone_list' child.
43919
43872
  write_to_file : bool
@@ -43949,7 +43902,7 @@ class rad_heat_trans(Command):
43949
43902
  domain_val : str
43950
43903
  'domain_val' child.
43951
43904
  all_bndry_zones : bool
43952
- Select all the boundary/interior zones.
43905
+ All the boundary/interior zones.
43953
43906
  zone_list : List
43954
43907
  'zone_list' child.
43955
43908
  write_to_file : bool
@@ -43985,7 +43938,7 @@ class film_mass_flow(Command):
43985
43938
  domain_val : str
43986
43939
  'domain_val' child.
43987
43940
  all_bndry_zones : bool
43988
- Select all the boundary/interior zones.
43941
+ All the boundary/interior zones.
43989
43942
  zone_list : List
43990
43943
  'zone_list' child.
43991
43944
  write_to_file : bool
@@ -44021,7 +43974,7 @@ class film_heat_transfer(Command):
44021
43974
  domain_val : str
44022
43975
  'domain_val' child.
44023
43976
  all_bndry_zones : bool
44024
- Select all the boundary/interior zones.
43977
+ All the boundary/interior zones.
44025
43978
  zone_list : List
44026
43979
  'zone_list' child.
44027
43980
  write_to_file : bool
@@ -44057,7 +44010,7 @@ class pressure_work_1(Command):
44057
44010
  domain_val : str
44058
44011
  'domain_val' child.
44059
44012
  all_bndry_zones : bool
44060
- Select all the boundary/interior zones.
44013
+ All the boundary/interior zones.
44061
44014
  zone_list : List
44062
44015
  'zone_list' child.
44063
44016
  write_to_file : bool
@@ -44093,7 +44046,7 @@ class viscous_work(Command):
44093
44046
  domain_val : str
44094
44047
  'domain_val' child.
44095
44048
  all_bndry_zones : bool
44096
- Select all the boundary/interior zones.
44049
+ All the boundary/interior zones.
44097
44050
  zone_list : List
44098
44051
  'zone_list' child.
44099
44052
  write_to_file : bool
@@ -44738,7 +44691,7 @@ class print_write_histogram(Group):
44738
44691
 
44739
44692
  class aero_optical_distortions(Command):
44740
44693
  """
44741
- Optics report menu.
44694
+ Optics report object.
44742
44695
  """
44743
44696
  version = '231'
44744
44697
  fluent_name = 'aero-optical-distortions'
@@ -44756,7 +44709,7 @@ class options_11(String, AllowedValuesMixin):
44756
44709
 
44757
44710
  class all_wall_zones(Boolean):
44758
44711
  """
44759
- Select all wall zones available.
44712
+ All wall zones available.
44760
44713
  """
44761
44714
  version = '231'
44762
44715
  fluent_name = 'all-wall-zones?'
@@ -45677,7 +45630,7 @@ class thread_number_control(Group):
45677
45630
 
45678
45631
  class check_verbosity_1(Integer):
45679
45632
  """
45680
- Set verbosity output of parallel check. Higher verbosity corresponds to more detailed information.
45633
+ Verbosity output of parallel check. Higher verbosity corresponds to more detailed information.
45681
45634
  """
45682
45635
  version = '231'
45683
45636
  fluent_name = 'check-verbosity'
@@ -45695,7 +45648,7 @@ class across_zones(Boolean):
45695
45648
 
45696
45649
  class load_vector(RealList):
45697
45650
  """
45698
- Set auto the partition load vector.
45651
+ Auto the partition load vector.
45699
45652
  """
45700
45653
  version = '231'
45701
45654
  fluent_name = 'load-vector'
@@ -45704,7 +45657,7 @@ class load_vector(RealList):
45704
45657
 
45705
45658
  class pre_test(Boolean):
45706
45659
  """
45707
- Set auto partition pre-testing optimization.
45660
+ Auto partition pre-testing optimization.
45708
45661
  """
45709
45662
  version = '231'
45710
45663
  fluent_name = 'pre-test'
@@ -45740,7 +45693,7 @@ class use_case_file_method(Command):
45740
45693
 
45741
45694
  class auto(Group):
45742
45695
  """
45743
- Enter the menu to set auto partition parameters.
45696
+ The object.
45744
45697
  """
45745
45698
  version = '231'
45746
45699
  fluent_name = 'auto'
@@ -45758,7 +45711,7 @@ class auto(Group):
45758
45711
 
45759
45712
  class cell_function_1(String, AllowedValuesMixin):
45760
45713
  """
45761
- Set cell function.
45714
+ Cell function.
45762
45715
  """
45763
45716
  version = '231'
45764
45717
  fluent_name = 'cell-function'
@@ -45767,7 +45720,7 @@ class cell_function_1(String, AllowedValuesMixin):
45767
45720
 
45768
45721
  class load_distribution(RealList):
45769
45722
  """
45770
- Set partition load vector.
45723
+ Partition load vector.
45771
45724
  """
45772
45725
  version = '231'
45773
45726
  fluent_name = 'load-distribution'
@@ -45794,7 +45747,7 @@ class max_merge_iterations(Integer):
45794
45747
 
45795
45748
  class merge(Group):
45796
45749
  """
45797
- Set partition merging optimization.
45750
+ Partition merging optimization.
45798
45751
  """
45799
45752
  version = '231'
45800
45753
  fluent_name = 'merge'
@@ -45827,7 +45780,7 @@ class partition_origin_vector(ListObject[partition_origin_vector_child]):
45827
45780
 
45828
45781
  class pre_test_1(Boolean):
45829
45782
  """
45830
- Set partition pre-testing optimization.
45783
+ Partition pre-testing optimization.
45831
45784
  """
45832
45785
  version = '231'
45833
45786
  fluent_name = 'pre-test?'
@@ -45854,7 +45807,7 @@ class max_smoothing_iterations(Integer):
45854
45807
 
45855
45808
  class smooth_1(Group):
45856
45809
  """
45857
- Set partition smoothing optimization.
45810
+ Partition smoothing optimization.
45858
45811
  """
45859
45812
  version = '231'
45860
45813
  fluent_name = 'smooth'
@@ -45868,7 +45821,7 @@ class smooth_1(Group):
45868
45821
 
45869
45822
  class print_verbosity(Integer):
45870
45823
  """
45871
- Set partition print verbosity.
45824
+ Partition print verbosity.
45872
45825
  """
45873
45826
  version = '231'
45874
45827
  fluent_name = 'print-verbosity'
@@ -46057,7 +46010,7 @@ class hybrid_optimization(Boolean):
46057
46010
 
46058
46011
  class particle_weight(Group):
46059
46012
  """
46060
- Set DPM particle weight.
46013
+ DPM particle weight.
46061
46014
  """
46062
46015
  version = '231'
46063
46016
  fluent_name = 'particle-weight'
@@ -46073,7 +46026,7 @@ class particle_weight(Group):
46073
46026
 
46074
46027
  class vof_free_surface_weight(Group):
46075
46028
  """
46076
- Set VOF free surface weight.
46029
+ VOF free surface weight.
46077
46030
  """
46078
46031
  version = '231'
46079
46032
  fluent_name = 'vof-free-surface-weight'
@@ -46088,7 +46041,7 @@ class vof_free_surface_weight(Group):
46088
46041
 
46089
46042
  class isat_weight(Group):
46090
46043
  """
46091
- Set ISAT weight.
46044
+ ISAT weight.
46092
46045
  """
46093
46046
  version = '231'
46094
46047
  fluent_name = 'isat-weight'
@@ -46112,7 +46065,7 @@ class fluid_solid_rebalance_after_read_case(Boolean):
46112
46065
 
46113
46066
  class model_weighted_partition(Boolean):
46114
46067
  """
46115
- Set model weighted partition.
46068
+ Model weighted partition.
46116
46069
  """
46117
46070
  version = '231'
46118
46071
  fluent_name = 'model-weighted-partition'
@@ -46199,7 +46152,7 @@ class all_on(Command):
46199
46152
 
46200
46153
  class set_3(Group):
46201
46154
  """
46202
- Enter the menu to set partition parameters.
46155
+ The object.
46203
46156
  """
46204
46157
  version = '231'
46205
46158
  fluent_name = 'set'
@@ -46373,7 +46326,7 @@ class reorder_partitions_to_architecture(Command):
46373
46326
 
46374
46327
  class smoothing_iteration(Integer):
46375
46328
  """
46376
- Set maximum number of smoothing iterations.
46329
+ Maximum number of smoothing iterations.
46377
46330
  """
46378
46331
  version = '231'
46379
46332
  fluent_name = 'smoothing-iteration'
@@ -46387,7 +46340,7 @@ class smooth_partition(Command):
46387
46340
  Parameters
46388
46341
  ----------
46389
46342
  smoothing_iteration : int
46390
- Set maximum number of smoothing iterations.
46343
+ Maximum number of smoothing iterations.
46391
46344
  """
46392
46345
  version = '231'
46393
46346
  fluent_name = 'smooth-partition'
@@ -46409,7 +46362,7 @@ class use_stored_partitions(Command):
46409
46362
 
46410
46363
  class partition_1(Group):
46411
46364
  """
46412
- Enter the partition domain menu.
46365
+ The partition domain object.
46413
46366
  """
46414
46367
  version = '231'
46415
46368
  fluent_name = 'partition'
@@ -46434,7 +46387,7 @@ class partition_1(Group):
46434
46387
 
46435
46388
  class partition_mask(IntegerList):
46436
46389
  """
46437
- Set partition mask.
46390
+ Partition mask.
46438
46391
  """
46439
46392
  version = '231'
46440
46393
  fluent_name = 'partition-mask'
@@ -46443,7 +46396,7 @@ class partition_mask(IntegerList):
46443
46396
 
46444
46397
  class verbosity_9(Integer):
46445
46398
  """
46446
- Set the parallel verbosity.
46399
+ The parallel verbosity.
46447
46400
  """
46448
46401
  version = '231'
46449
46402
  fluent_name = 'verbosity'
@@ -46452,7 +46405,7 @@ class verbosity_9(Integer):
46452
46405
 
46453
46406
  class time_out(Real):
46454
46407
  """
46455
- Set spawn timeout seconds.
46408
+ Spawn timeout seconds.
46456
46409
  """
46457
46410
  version = '231'
46458
46411
  fluent_name = 'time-out'
@@ -46582,7 +46535,7 @@ class iter_per_coupling_count(Integer):
46582
46535
 
46583
46536
  class method_4(String, AllowedValuesMixin):
46584
46537
  """
46585
- Specify the method for fluid and solid zone coupling.
46538
+ The method for fluid and solid zone coupling.
46586
46539
  """
46587
46540
  version = '231'
46588
46541
  fluent_name = 'method'
@@ -46834,7 +46787,7 @@ class multidomain(Group):
46834
46787
 
46835
46788
  class shell_script_path(String):
46836
46789
  """
46837
- Set the Fluent shell script path.
46790
+ The Fluent shell script path.
46838
46791
  """
46839
46792
  version = '231'
46840
46793
  fluent_name = 'shell-script-path'
@@ -46989,7 +46942,7 @@ class save_hosts(Command):
46989
46942
 
46990
46943
  class network_1(Group):
46991
46944
  """
46992
- Enter the network configuration menu.
46945
+ The network configuration object.
46993
46946
  """
46994
46947
  version = '231'
46995
46948
  fluent_name = 'network'