ansys-fluent-core 0.29.dev3__py3-none-any.whl → 0.30.dev1__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 (147) hide show
  1. ansys/fluent/core/__init__.py +31 -6
  2. ansys/fluent/core/_stand_alone_datamodel_client/_datamodel_client.py +22 -0
  3. ansys/fluent/core/_version.py +23 -1
  4. ansys/fluent/core/codegen/__init__.py +22 -0
  5. ansys/fluent/core/codegen/allapigen.py +38 -5
  6. ansys/fluent/core/codegen/builtin_settingsgen.py +22 -0
  7. ansys/fluent/core/codegen/data/__init__.py +21 -0
  8. ansys/fluent/core/codegen/data/fluent_gui_help_patch.py +22 -0
  9. ansys/fluent/core/codegen/data/meshing_utilities_examples.py +22 -0
  10. ansys/fluent/core/codegen/datamodelgen.py +40 -4
  11. ansys/fluent/core/codegen/print_fluent_version.py +22 -0
  12. ansys/fluent/core/codegen/settingsgen.py +67 -4
  13. ansys/fluent/core/codegen/tuigen.py +43 -5
  14. ansys/fluent/core/codegen/walk_api.py +22 -0
  15. ansys/fluent/core/codegen/write_settings_yaml.py +22 -0
  16. ansys/fluent/core/data_model_cache.py +22 -0
  17. ansys/fluent/core/examples/__init__.py +22 -0
  18. ansys/fluent/core/examples/downloads.py +22 -0
  19. ansys/fluent/core/exceptions.py +22 -0
  20. ansys/fluent/core/file_session.py +22 -0
  21. ansys/fluent/core/filereader/__init__.py +21 -0
  22. ansys/fluent/core/filereader/case_file.py +50 -6
  23. ansys/fluent/core/filereader/casereader.py +23 -1
  24. ansys/fluent/core/filereader/data_file.py +22 -0
  25. ansys/fluent/core/filereader/lispy.py +22 -0
  26. ansys/fluent/core/fluent_connection.py +24 -2
  27. ansys/fluent/core/generated/api_tree/api_objects.json +1 -1
  28. ansys/fluent/core/generated/datamodel_252/MeshingUtilities.py +16 -0
  29. ansys/fluent/core/generated/datamodel_252/meshing.py +41 -0
  30. ansys/fluent/core/generated/fluent_version_252.py +3 -3
  31. ansys/fluent/core/generated/meshing/tui_252.py +33 -5
  32. ansys/fluent/core/generated/solver/settings_222.py +0 -72
  33. ansys/fluent/core/generated/solver/settings_222.pyi +0 -307
  34. ansys/fluent/core/generated/solver/settings_231.py +0 -574
  35. ansys/fluent/core/generated/solver/settings_231.pyi +0 -561
  36. ansys/fluent/core/generated/solver/settings_232.py +0 -527
  37. ansys/fluent/core/generated/solver/settings_232.pyi +0 -2803
  38. ansys/fluent/core/generated/solver/settings_241.py +0 -478
  39. ansys/fluent/core/generated/solver/settings_241.pyi +0 -522
  40. ansys/fluent/core/generated/solver/settings_242.py +0 -361
  41. ansys/fluent/core/generated/solver/settings_242.pyi +0 -591
  42. ansys/fluent/core/generated/solver/settings_251.py +0 -399
  43. ansys/fluent/core/generated/solver/settings_251.pyi +0 -629
  44. ansys/fluent/core/generated/solver/settings_252.py +11896 -7129
  45. ansys/fluent/core/generated/solver/settings_252.pyi +9127 -4847
  46. ansys/fluent/core/generated/solver/tui_252.py +549 -179
  47. ansys/fluent/core/get_build_details.py +22 -0
  48. ansys/fluent/core/journaling.py +38 -0
  49. ansys/fluent/core/launcher/__init__.py +22 -0
  50. ansys/fluent/core/launcher/container_launcher.py +63 -55
  51. ansys/fluent/core/launcher/error_handler.py +22 -0
  52. ansys/fluent/core/launcher/fluent_container.py +23 -1
  53. ansys/fluent/core/launcher/launcher.py +52 -4
  54. ansys/fluent/core/launcher/launcher_utils.py +24 -2
  55. ansys/fluent/core/launcher/pim_launcher.py +120 -86
  56. ansys/fluent/core/launcher/process_launch_string.py +22 -0
  57. ansys/fluent/core/launcher/pyfluent_enums.py +22 -0
  58. ansys/fluent/core/launcher/server_info.py +22 -0
  59. ansys/fluent/core/launcher/slurm_launcher.py +23 -1
  60. ansys/fluent/core/launcher/standalone_launcher.py +68 -63
  61. ansys/fluent/core/launcher/watchdog.py +22 -0
  62. ansys/fluent/core/logging.py +22 -0
  63. ansys/fluent/core/meshing/meshing_workflow.py +22 -0
  64. ansys/fluent/core/parametric.py +22 -0
  65. ansys/fluent/core/post_objects/__init__.py +21 -0
  66. ansys/fluent/core/post_objects/check_in_notebook.py +22 -0
  67. ansys/fluent/core/post_objects/meta.py +28 -6
  68. ansys/fluent/core/post_objects/post_helper.py +22 -0
  69. ansys/fluent/core/post_objects/post_object_definitions.py +22 -0
  70. ansys/fluent/core/post_objects/post_objects_container.py +22 -0
  71. ansys/fluent/core/post_objects/singleton_meta.py +22 -0
  72. ansys/fluent/core/post_objects/timing_decorator.py +22 -0
  73. ansys/fluent/core/pyfluent_warnings.py +55 -0
  74. ansys/fluent/core/report.py +77 -0
  75. ansys/fluent/core/rpvars.py +22 -0
  76. ansys/fluent/core/scheduler/__init__.py +22 -0
  77. ansys/fluent/core/scheduler/load_machines.py +22 -0
  78. ansys/fluent/core/scheduler/machine_list.py +22 -0
  79. ansys/fluent/core/search.py +22 -0
  80. ansys/fluent/core/services/__init__.py +22 -0
  81. ansys/fluent/core/services/api_upgrade.py +22 -0
  82. ansys/fluent/core/services/app_utilities.py +38 -0
  83. ansys/fluent/core/services/batch_ops.py +22 -0
  84. ansys/fluent/core/services/datamodel_se.py +22 -2
  85. ansys/fluent/core/services/datamodel_tui.py +22 -0
  86. ansys/fluent/core/services/deprecated_field_data.py +24 -2
  87. ansys/fluent/core/services/events.py +22 -0
  88. ansys/fluent/core/services/field_data.py +46 -15
  89. ansys/fluent/core/services/health_check.py +22 -0
  90. ansys/fluent/core/services/interceptors.py +22 -0
  91. ansys/fluent/core/services/monitor.py +22 -0
  92. ansys/fluent/core/services/reduction.py +22 -0
  93. ansys/fluent/core/services/scheme_eval.py +22 -0
  94. ansys/fluent/core/services/settings.py +22 -0
  95. ansys/fluent/core/services/solution_variables.py +23 -1
  96. ansys/fluent/core/services/streaming.py +22 -0
  97. ansys/fluent/core/services/transcript.py +22 -0
  98. ansys/fluent/core/session.py +36 -1
  99. ansys/fluent/core/session_base_meshing.py +22 -0
  100. ansys/fluent/core/session_meshing.py +22 -0
  101. ansys/fluent/core/session_meshing.pyi +22 -0
  102. ansys/fluent/core/session_pure_meshing.py +22 -0
  103. ansys/fluent/core/session_pure_meshing.pyi +22 -0
  104. ansys/fluent/core/session_shared.py +22 -0
  105. ansys/fluent/core/session_solver.py +23 -1
  106. ansys/fluent/core/session_solver.pyi +22 -0
  107. ansys/fluent/core/session_solver_aero.py +22 -0
  108. ansys/fluent/core/session_solver_icing.py +22 -0
  109. ansys/fluent/core/session_solver_lite.py +22 -0
  110. ansys/fluent/core/solver/__init__.py +22 -0
  111. ansys/fluent/core/solver/error_message.py +22 -0
  112. ansys/fluent/core/solver/flobject.py +26 -1
  113. ansys/fluent/core/solver/flunits.py +22 -0
  114. ansys/fluent/core/solver/function/__init__.py +22 -0
  115. ansys/fluent/core/solver/function/reduction.py +22 -0
  116. ansys/fluent/core/solver/settings_builtin_bases.py +22 -0
  117. ansys/fluent/core/solver/settings_builtin_data.py +22 -0
  118. ansys/fluent/core/solver/settings_external.py +22 -0
  119. ansys/fluent/core/streaming_services/__init__.py +21 -0
  120. ansys/fluent/core/streaming_services/datamodel_event_streaming.py +22 -0
  121. ansys/fluent/core/streaming_services/datamodel_streaming.py +22 -0
  122. ansys/fluent/core/streaming_services/events_streaming.py +23 -1
  123. ansys/fluent/core/streaming_services/field_data_streaming.py +22 -0
  124. ansys/fluent/core/streaming_services/monitor_streaming.py +23 -1
  125. ansys/fluent/core/streaming_services/streaming.py +22 -0
  126. ansys/fluent/core/streaming_services/transcript_streaming.py +22 -0
  127. ansys/fluent/core/systemcoupling.py +22 -0
  128. ansys/fluent/core/utils/__init__.py +22 -0
  129. ansys/fluent/core/utils/data_transfer.py +22 -0
  130. ansys/fluent/core/utils/deprecate.py +25 -2
  131. ansys/fluent/core/utils/dictionary_operations.py +22 -0
  132. ansys/fluent/core/utils/dump_session_data.py +22 -0
  133. ansys/fluent/core/utils/event_loop.py +22 -0
  134. ansys/fluent/core/utils/execution.py +22 -0
  135. ansys/fluent/core/utils/file_transfer_service.py +26 -4
  136. ansys/fluent/core/utils/fix_doc.py +22 -0
  137. ansys/fluent/core/utils/fldoc.py +22 -0
  138. ansys/fluent/core/utils/fluent_version.py +22 -0
  139. ansys/fluent/core/utils/networking.py +22 -0
  140. ansys/fluent/core/utils/setup_for_fluent.py +22 -0
  141. ansys/fluent/core/workflow.py +26 -1
  142. {ansys_fluent_core-0.29.dev3.dist-info → ansys_fluent_core-0.30.dev1.dist-info}/LICENSE +8 -8
  143. {ansys_fluent_core-0.29.dev3.dist-info → ansys_fluent_core-0.30.dev1.dist-info}/METADATA +10 -8
  144. ansys_fluent_core-0.30.dev1.dist-info/RECORD +219 -0
  145. ansys/fluent/core/warnings.py +0 -33
  146. ansys_fluent_core-0.29.dev3.dist-info/RECORD +0 -218
  147. {ansys_fluent_core-0.29.dev3.dist-info → ansys_fluent_core-0.30.dev1.dist-info}/WHEEL +0 -0
@@ -1395,13 +1395,6 @@ class file_type(String, AllowedValuesMixin):
1395
1395
  class read_1(Command):
1396
1396
  """
1397
1397
  'read' command.
1398
-
1399
- Parameters
1400
- ----------
1401
- file_type : str
1402
- 'file_type' child.
1403
- file_name : str
1404
- 'file_name' child.
1405
1398
  """
1406
1399
  version = '241'
1407
1400
  fluent_name = 'read'
@@ -1425,11 +1418,6 @@ class report_each_line(Boolean):
1425
1418
  class chemkin_report_each_line(Command):
1426
1419
  """
1427
1420
  'chemkin_report_each_line' command.
1428
-
1429
- Parameters
1430
- ----------
1431
- report_each_line : bool
1432
- Enable/disable reporting after reading each line.
1433
1421
  """
1434
1422
  version = '241'
1435
1423
  fluent_name = 'chemkin-report-each-line?'
@@ -1812,17 +1800,6 @@ class lightweight_setup(Boolean):
1812
1800
  class read(Command):
1813
1801
  """
1814
1802
  'read' command.
1815
-
1816
- Parameters
1817
- ----------
1818
- file_type : str
1819
- 'file_type' child.
1820
- file_name : str
1821
- 'file_name' child.
1822
- pdf_file_name : str
1823
- 'pdf_file_name' child.
1824
- lightweight_setup : bool
1825
- 'lightweight_setup' child.
1826
1803
  """
1827
1804
  version = '241'
1828
1805
  fluent_name = 'read'
@@ -1839,13 +1816,6 @@ class read(Command):
1839
1816
  class read_case(Command):
1840
1817
  """
1841
1818
  'read_case' command.
1842
-
1843
- Parameters
1844
- ----------
1845
- file_name : str
1846
- 'file_name' child.
1847
- pdf_file_name : str
1848
- 'pdf_file_name' child.
1849
1819
  """
1850
1820
  version = '241'
1851
1821
  fluent_name = 'read-case'
@@ -1860,13 +1830,6 @@ class read_case(Command):
1860
1830
  class read_case_data(Command):
1861
1831
  """
1862
1832
  'read_case_data' command.
1863
-
1864
- Parameters
1865
- ----------
1866
- file_name : str
1867
- 'file_name' child.
1868
- pdf_file_name : str
1869
- 'pdf_file_name' child.
1870
1833
  """
1871
1834
  version = '241'
1872
1835
  fluent_name = 'read-case-data'
@@ -1881,13 +1844,6 @@ class read_case_data(Command):
1881
1844
  class read_case_setting(Command):
1882
1845
  """
1883
1846
  'read_case_setting' command.
1884
-
1885
- Parameters
1886
- ----------
1887
- file_name : str
1888
- 'file_name' child.
1889
- pdf_file_name : str
1890
- 'pdf_file_name' child.
1891
1847
  """
1892
1848
  version = '241'
1893
1849
  fluent_name = 'read-case-setting'
@@ -1902,11 +1858,6 @@ class read_case_setting(Command):
1902
1858
  class read_data(Command):
1903
1859
  """
1904
1860
  'read_data' command.
1905
-
1906
- Parameters
1907
- ----------
1908
- file_name : str
1909
- 'file_name' child.
1910
1861
  """
1911
1862
  version = '241'
1912
1863
  fluent_name = 'read-data'
@@ -1920,11 +1871,6 @@ class read_data(Command):
1920
1871
  class read_mesh(Command):
1921
1872
  """
1922
1873
  'read_mesh' command.
1923
-
1924
- Parameters
1925
- ----------
1926
- file_name : str
1927
- 'file_name' child.
1928
1874
  """
1929
1875
  version = '241'
1930
1876
  fluent_name = 'read-mesh'
@@ -2031,11 +1977,6 @@ class stop_journal(Command):
2031
1977
  class replace_mesh(Command):
2032
1978
  """
2033
1979
  'replace_mesh' command.
2034
-
2035
- Parameters
2036
- ----------
2037
- file_name : str
2038
- 'file_name' child.
2039
1980
  """
2040
1981
  version = '241'
2041
1982
  fluent_name = 'replace-mesh'
@@ -2049,13 +1990,6 @@ class replace_mesh(Command):
2049
1990
  class write(Command):
2050
1991
  """
2051
1992
  'write' command.
2052
-
2053
- Parameters
2054
- ----------
2055
- file_type : str
2056
- 'file_type' child.
2057
- file_name : str
2058
- 'file_name' child.
2059
1993
  """
2060
1994
  version = '241'
2061
1995
  fluent_name = 'write'
@@ -2070,11 +2004,6 @@ class write(Command):
2070
2004
  class write_case(Command):
2071
2005
  """
2072
2006
  'write_case' command.
2073
-
2074
- Parameters
2075
- ----------
2076
- file_name : str
2077
- 'file_name' child.
2078
2007
  """
2079
2008
  version = '241'
2080
2009
  fluent_name = 'write-case'
@@ -2088,11 +2017,6 @@ class write_case(Command):
2088
2017
  class write_data(Command):
2089
2018
  """
2090
2019
  'write_data' command.
2091
-
2092
- Parameters
2093
- ----------
2094
- file_name : str
2095
- 'file_name' child.
2096
2020
  """
2097
2021
  version = '241'
2098
2022
  fluent_name = 'write-data'
@@ -2106,11 +2030,6 @@ class write_data(Command):
2106
2030
  class write_case_data(Command):
2107
2031
  """
2108
2032
  'write_case_data' command.
2109
-
2110
- Parameters
2111
- ----------
2112
- file_name : str
2113
- 'file_name' child.
2114
2033
  """
2115
2034
  version = '241'
2116
2035
  fluent_name = 'write-case-data'
@@ -4646,15 +4565,6 @@ class convert_skewed_cells_1(Boolean):
4646
4565
  class convert_skewed_cells(Command):
4647
4566
  """
4648
4567
  'convert_skewed_cells' command.
4649
-
4650
- Parameters
4651
- ----------
4652
- cell_thread_list : List
4653
- Set zones where cells should be converted.
4654
- max_cell_skewness : real
4655
- Set target maximum cell skewness.
4656
- convert_skewed_cells : bool
4657
- 'convert_skewed_cells' child.
4658
4568
  """
4659
4569
  version = '241'
4660
4570
  fluent_name = 'convert-skewed-cells'
@@ -4820,15 +4730,6 @@ class z_scale(Real):
4820
4730
  class scale(Command):
4821
4731
  """
4822
4732
  'scale' command.
4823
-
4824
- Parameters
4825
- ----------
4826
- x_scale : real
4827
- 'x_scale' child.
4828
- y_scale : real
4829
- 'y_scale' child.
4830
- z_scale : real
4831
- 'z_scale' child.
4832
4733
  """
4833
4734
  version = '241'
4834
4735
  fluent_name = 'scale'
@@ -12244,12 +12145,10 @@ class root_radius(Real):
12244
12145
  class basic_info(Group):
12245
12146
  """
12246
12147
  Menu to define the rotor basic informations:
12247
-
12248
12148
  - Number of Blades
12249
12149
  - Rotor Speed ,
12250
12150
  - Tip Radius
12251
12151
  - Root Radius ,
12252
-
12253
12152
  For more details please consult the help option of the corresponding menu or TUI command.
12254
12153
  """
12255
12154
  version = '241'
@@ -12310,10 +12209,8 @@ class disk_origin(Group):
12310
12209
  class terminology(Integer):
12311
12210
  """
12312
12211
  Select Rotor Disk Orientation Terminology:
12313
-
12314
12212
  - Enter 0 if using Rotor Disk Angles
12315
12213
  - Enter 1 if using Rotor Disk Normal
12316
-
12317
12214
  For more details please consult the help option of the corresponding menu or TUI command.
12318
12215
  """
12319
12216
  version = '241'
@@ -12369,12 +12266,10 @@ class disk_bank_angle(Real):
12369
12266
  class disk_orientation(Group):
12370
12267
  """
12371
12268
  Menu to define the rotor disk orientation.
12372
-
12373
12269
  - terminology : the terminology to specify the rotor disk orientation: rotor-disk-angles / rotor-disk-normal,
12374
12270
  - disk-normal-x/yz : rotor-disk-normal components,
12375
12271
  - disk-pitch-angle : ,
12376
12272
  - disk-bank-angle : ,
12377
-
12378
12273
  For more details please consult the help option of the corresponding menu or TUI command.
12379
12274
  """
12380
12275
  version = '241'
@@ -12421,11 +12316,9 @@ class create_floating_disk(Command):
12421
12316
  class disk_id(Group):
12422
12317
  """
12423
12318
  Menu to define the disk face/surface name:
12424
-
12425
12319
  - embedded-face-zone : select embedded-face-zone name,
12426
12320
  - floating-surface-name : select floating-surface-name,
12427
12321
  - create-floating-disk : create a floating-disk for the current rotor,
12428
-
12429
12322
  For more details please consult the help option of the corresponding menu or TUI command.
12430
12323
  """
12431
12324
  version = '241'
@@ -12470,11 +12363,9 @@ class blade_pitch_cyclic_cos(Real):
12470
12363
  class blade_pitch_angles(Group):
12471
12364
  """
12472
12365
  Menu to define the rotor pitch and flapping angles.
12473
-
12474
12366
  - blade-pitch-collective : ,
12475
12367
  - blade-pitch-cyclic-sin : ,
12476
12368
  - blade-pitch-cyclic-cos : ,
12477
-
12478
12369
  For more details please consult the help option of the corresponding menu or TUI command.
12479
12370
  """
12480
12371
  version = '241'
@@ -12518,11 +12409,9 @@ class blade_flapping_cyclic_cos(Real):
12518
12409
  class blade_flap_angles(Group):
12519
12410
  """
12520
12411
  Menu to define the rotor pitch angles.
12521
-
12522
12412
  - blade-flapping-cone : ,
12523
12413
  - blade-flapping-cyclic-sin : ,
12524
12414
  - blade-flapping-cyclic-cos : ,
12525
-
12526
12415
  For more details please consult the help option of the corresponding menu or TUI command.
12527
12416
  """
12528
12417
  version = '241'
@@ -12539,10 +12428,8 @@ class blade_flap_angles(Group):
12539
12428
  class model_tip_loss(Integer):
12540
12429
  """
12541
12430
  Select Tip Loss Model:
12542
-
12543
12431
  - Enter 1 if using Quadratic model
12544
12432
  - Enter 2 if using modified Prandtl model
12545
-
12546
12433
  For more details please consult the help option of the corresponding menu or TUI command.
12547
12434
  """
12548
12435
  version = '241'
@@ -12571,11 +12458,9 @@ class prandtl_tuning_coefficient(Real):
12571
12458
  class tip_loss(Group):
12572
12459
  """
12573
12460
  Menu to define the rotor tip loss model.
12574
-
12575
12461
  - method : define the method to model rotor tip loss, quadratic-tip-loss, prandtl-tip-loss
12576
12462
  - tip-loss-limit : tip-loss-limit,
12577
12463
  - prandtl-tuning-coefficient: prandtl-tuning-coefficient,
12578
-
12579
12464
  For more details please consult the help option of the corresponding menu or TUI command.
12580
12465
  """
12581
12466
  version = '241'
@@ -12686,12 +12571,10 @@ class geometry_2(NamedObject[geometry_2_child], CreatableNamedObjectMixinOld[geo
12686
12571
  class trim_option(Integer):
12687
12572
  """
12688
12573
  Select Trimming Option:
12689
-
12690
12574
  - Enter 0 if no trimming is required
12691
12575
  - Enter 1 if trimming of collective pitch is required
12692
12576
  - Enter 2 if trimming of cyclic pitch angles are required
12693
12577
  - Enter 3 if trimming of both collective and cyclic pitch angles are required
12694
-
12695
12578
  For more details please consult the help option of the corresponding menu or TUI command.
12696
12579
  """
12697
12580
  version = '241'
@@ -12747,14 +12630,12 @@ class roll_moment_coef(Real):
12747
12630
  class trimming(Group):
12748
12631
  """
12749
12632
  Menu to define rotor trimming set-up.
12750
-
12751
12633
  - trim-option : to define collective and cyclic pitches to trim,
12752
12634
  - update-frequency : the number of solver iterations that pitch angle will be updated each time,
12753
12635
  - damping-factor : relaxation factor for pitch angles,
12754
12636
  - thrust-coef : desired thrust coefficient to set pitch for
12755
12637
  - pitch-moment-coef : desired pitch-moment coefficient to set pitch for,
12756
12638
  - roll-moment-coef : desired roll-moment coefficient to set pitch for,
12757
-
12758
12639
  For more details please consult the help option of the corresponding menu or TUI command.
12759
12640
  """
12760
12641
  version = '241'
@@ -14989,13 +14870,6 @@ class electrical_tab(Group):
14989
14870
  class add_zone(Command):
14990
14871
  """
14991
14872
  'add_zone' command.
14992
-
14993
- Parameters
14994
- ----------
14995
- zone_name : str
14996
- 'zone_name' child.
14997
- value : real
14998
- 'value' child.
14999
14873
  """
15000
14874
  version = '241'
15001
14875
  fluent_name = 'add-zone'
@@ -15028,11 +14902,6 @@ class face_name(String, AllowedValuesMixin):
15028
14902
  class delete_zone(Command):
15029
14903
  """
15030
14904
  'delete_zone' command.
15031
-
15032
- Parameters
15033
- ----------
15034
- face_name : str
15035
- Pick ~a zone you want to delete.
15036
14905
  """
15037
14906
  version = '241'
15038
14907
  fluent_name = 'delete-zone'
@@ -15181,13 +15050,6 @@ class negative_tab(String, AllowedValuesMixin):
15181
15050
  class virtual_connection(Command):
15182
15051
  """
15183
15052
  'virtual_connection' command.
15184
-
15185
- Parameters
15186
- ----------
15187
- enabled : bool
15188
- 'enabled' child.
15189
- file_name : str
15190
- 'file_name' child.
15191
15053
  """
15192
15054
  version = '241'
15193
15055
  fluent_name = 'virtual-connection'
@@ -15248,13 +15110,6 @@ class resistance_value(Real):
15248
15110
  class add_contact_resistance(Command):
15249
15111
  """
15250
15112
  'add_contact_resistance' command.
15251
-
15252
- Parameters
15253
- ----------
15254
- contact_face : str
15255
- Set contact face.
15256
- resistance_value : real
15257
- Set resistance value.
15258
15113
  """
15259
15114
  version = '241'
15260
15115
  fluent_name = 'add-contact-resistance'
@@ -15287,11 +15142,6 @@ class face_name_1(String, AllowedValuesMixin):
15287
15142
  class delete_contact_face(Command):
15288
15143
  """
15289
15144
  'delete_contact_face' command.
15290
-
15291
- Parameters
15292
- ----------
15293
- face_name : str
15294
- Pick contact face you want to delete.
15295
15145
  """
15296
15146
  version = '241'
15297
15147
  fluent_name = 'delete-contact-face'
@@ -18158,21 +18008,6 @@ class value_list(RealList):
18158
18008
  class add_rom_parameter(Command):
18159
18009
  """
18160
18010
  'add_rom_parameter' command.
18161
-
18162
- Parameters
18163
- ----------
18164
- parameter_type : int
18165
- 'parameter_type' child.
18166
- entity_list : List
18167
- 'entity_list' child.
18168
- individual_or_group : bool
18169
- 'individual_or_group' child.
18170
- individual_value : bool
18171
- 'individual_value' child.
18172
- group_value : real
18173
- 'group_value' child.
18174
- value_list : List
18175
- 'value_list' child.
18176
18011
  """
18177
18012
  version = '241'
18178
18013
  fluent_name = 'add-rom-parameter'
@@ -27021,15 +26856,6 @@ class verbosity_3(Boolean):
27021
26856
  class copy_1(Command):
27022
26857
  """
27023
26858
  'copy' command.
27024
-
27025
- Parameters
27026
- ----------
27027
- from_ : str
27028
- 'from' child.
27029
- to : List
27030
- 'to' child.
27031
- verbosity : bool
27032
- 'verbosity' child.
27033
26859
  """
27034
26860
  version = '241'
27035
26861
  fluent_name = 'copy'
@@ -27054,13 +26880,6 @@ class zone_list(StringList, AllowedValuesMixin):
27054
26880
  class set_zone_type(Command):
27055
26881
  """
27056
26882
  'set_zone_type' command.
27057
-
27058
- Parameters
27059
- ----------
27060
- zone_list : List
27061
- Enter zone name list.
27062
- new_type : str
27063
- 'new_type' child.
27064
26883
  """
27065
26884
  version = '241'
27066
26885
  fluent_name = 'set-zone-type'
@@ -40802,11 +40621,6 @@ class model_setup(Group):
40802
40621
  class read_input_file(Command):
40803
40622
  """
40804
40623
  'read_input_file' command.
40805
-
40806
- Parameters
40807
- ----------
40808
- file_name : str
40809
- 'file_name' child.
40810
40624
  """
40811
40625
  version = '241'
40812
40626
  fluent_name = 'read-input-file'
@@ -42688,15 +42502,6 @@ class phase_26(String):
42688
42502
  class compute(Command):
42689
42503
  """
42690
42504
  'compute' command.
42691
-
42692
- Parameters
42693
- ----------
42694
- from_zone_type : str
42695
- 'from_zone_type' child.
42696
- from_zone_name : str
42697
- 'from_zone_name' child.
42698
- phase : str
42699
- 'phase' child.
42700
42505
  """
42701
42506
  version = '241'
42702
42507
  fluent_name = 'compute'
@@ -43081,11 +42886,6 @@ class names(StringList, AllowedValuesMixin):
43081
42886
  class compute_1(Command):
43082
42887
  """
43083
42888
  'compute' command.
43084
-
43085
- Parameters
43086
- ----------
43087
- names : List
43088
- 'names' child.
43089
42889
  """
43090
42890
  version = '241'
43091
42891
  fluent_name = 'compute'
@@ -43440,11 +43240,6 @@ class face_name_2(String, AllowedValuesMixin):
43440
43240
  class list_face(Command):
43441
43241
  """
43442
43242
  'list_face' command.
43443
-
43444
- Parameters
43445
- ----------
43446
- face_name : str
43447
- 'face_name' child.
43448
43243
  """
43449
43244
  version = '241'
43450
43245
  fluent_name = 'list-face'
@@ -49267,11 +49062,6 @@ class report_defs(StringList, AllowedValuesMixin):
49267
49062
  class compute_2(Command):
49268
49063
  """
49269
49064
  'compute' command.
49270
-
49271
- Parameters
49272
- ----------
49273
- report_defs : List
49274
- 'report_defs' child.
49275
49065
  """
49276
49066
  version = '241'
49277
49067
  fluent_name = 'compute'
@@ -49303,13 +49093,6 @@ class copy_to(String):
49303
49093
  class copy_2(Command):
49304
49094
  """
49305
49095
  'copy' command.
49306
-
49307
- Parameters
49308
- ----------
49309
- copy_from : str
49310
- 'copy_from' child.
49311
- copy_to : str
49312
- 'copy_to' child.
49313
49096
  """
49314
49097
  version = '241'
49315
49098
  fluent_name = 'copy'
@@ -52030,11 +51813,6 @@ class command_name(String):
52030
51813
  class enable_16(Command):
52031
51814
  """
52032
51815
  Enable an execute-command.
52033
-
52034
- Parameters
52035
- ----------
52036
- command_name : str
52037
- 'command_name' child.
52038
51816
  """
52039
51817
  version = '241'
52040
51818
  fluent_name = 'enable'
@@ -52048,11 +51826,6 @@ class enable_16(Command):
52048
51826
  class disable_1(Command):
52049
51827
  """
52050
51828
  Disable an execute-command.
52051
-
52052
- Parameters
52053
- ----------
52054
- command_name : str
52055
- 'command_name' child.
52056
51829
  """
52057
51830
  version = '241'
52058
51831
  fluent_name = 'disable'
@@ -52066,11 +51839,6 @@ class disable_1(Command):
52066
51839
  class copy_3(Command):
52067
51840
  """
52068
51841
  Copy an execute-command.
52069
-
52070
- Parameters
52071
- ----------
52072
- command_name : str
52073
- 'command_name' child.
52074
51842
  """
52075
51843
  version = '241'
52076
51844
  fluent_name = 'copy'
@@ -52084,11 +51852,6 @@ class copy_3(Command):
52084
51852
  class delete_4(CommandWithPositionalArgs):
52085
51853
  """
52086
51854
  Delete an execute-command.
52087
-
52088
- Parameters
52089
- ----------
52090
- command_name : str
52091
- 'command_name' child.
52092
51855
  """
52093
51856
  version = '241'
52094
51857
  fluent_name = 'delete'
@@ -52120,13 +51883,6 @@ class tsv_file_name(Filename):
52120
51883
  class export_1(Command):
52121
51884
  """
52122
51885
  Export execute-commands to a TSV file.
52123
-
52124
- Parameters
52125
- ----------
52126
- command_name : List
52127
- 'command_name' child.
52128
- tsv_file_name : str
52129
- 'tsv_file_name' child.
52130
51886
  """
52131
51887
  version = '241'
52132
51888
  fluent_name = 'export'
@@ -52141,11 +51897,6 @@ class export_1(Command):
52141
51897
  class import__1(Command):
52142
51898
  """
52143
51899
  Import execute-commands from a TSV file.
52144
-
52145
- Parameters
52146
- ----------
52147
- tsv_file_name : str
52148
- 'tsv_file_name' child.
52149
51900
  """
52150
51901
  version = '241'
52151
51902
  fluent_name = 'import_'
@@ -52813,13 +52564,6 @@ class command_list(StringList):
52813
52564
  class export_modifications(Command):
52814
52565
  """
52815
52566
  Export all case modifications to a tsv file.
52816
-
52817
- Parameters
52818
- ----------
52819
- command_list : List
52820
- 'command_list' child.
52821
- filename : str
52822
- 'filename' child.
52823
52567
  """
52824
52568
  version = '241'
52825
52569
  fluent_name = 'export-modifications'
@@ -55423,11 +55167,6 @@ class surface_cells(NamedObject[surface_cells_child], CreatableNamedObjectMixinO
55423
55167
  class create_multiple_zone_surfaces(Command):
55424
55168
  """
55425
55169
  'create_multiple_zone_surfaces' command.
55426
-
55427
- Parameters
55428
- ----------
55429
- zone_names : List
55430
- Enter zone name list.
55431
55170
  """
55432
55171
  version = '241'
55433
55172
  fluent_name = 'create-multiple-zone-surfaces'
@@ -55477,23 +55216,6 @@ class spacing(Real):
55477
55216
  class create_multiple_iso_surfaces(Command):
55478
55217
  """
55479
55218
  'create_multiple_iso_surfaces' command.
55480
-
55481
- Parameters
55482
- ----------
55483
- field : str
55484
- Specify Field.
55485
- name : str
55486
- 'name' child.
55487
- surfaces : List
55488
- Select surface.
55489
- zones : List
55490
- Enter cell zone name list.
55491
- iso_value : real
55492
- 'iso_value' child.
55493
- no_of_surfaces : int
55494
- 'no_of_surfaces' child.
55495
- spacing : real
55496
- 'spacing' child.
55497
55219
  """
55498
55220
  version = '241'
55499
55221
  fluent_name = 'create-multiple-iso-surfaces'
@@ -55513,13 +55235,6 @@ class create_multiple_iso_surfaces(Command):
55513
55235
  class create_group_surfaces(Command):
55514
55236
  """
55515
55237
  'create_group_surfaces' command.
55516
-
55517
- Parameters
55518
- ----------
55519
- surfaces : List
55520
- Select list of surfaces.
55521
- name : str
55522
- 'name' child.
55523
55238
  """
55524
55239
  version = '241'
55525
55240
  fluent_name = 'create-group-surfaces'
@@ -55534,11 +55249,6 @@ class create_group_surfaces(Command):
55534
55249
  class ungroup_surfaces(Command):
55535
55250
  """
55536
55251
  'ungroup_surfaces' command.
55537
-
55538
- Parameters
55539
- ----------
55540
- surface : str
55541
- 'surface' child.
55542
55252
  """
55543
55253
  version = '241'
55544
55254
  fluent_name = 'ungroup-surfaces'
@@ -55561,13 +55271,6 @@ class priority(String, AllowedValuesMixin):
55561
55271
  class set_rendering_priority(Command):
55562
55272
  """
55563
55273
  'set_rendering_priority' command.
55564
-
55565
- Parameters
55566
- ----------
55567
- surface : str
55568
- Select surface.
55569
- priority : str
55570
- Select surface.
55571
55274
  """
55572
55275
  version = '241'
55573
55276
  fluent_name = 'set-rendering-priority'
@@ -59415,11 +59118,6 @@ class preview(Command):
59415
59118
  class save_picture(Command):
59416
59119
  """
59417
59120
  'save_picture' command.
59418
-
59419
- Parameters
59420
- ----------
59421
- file_name : str
59422
- 'file_name' child.
59423
59121
  """
59424
59122
  version = '241'
59425
59123
  fluent_name = 'save-picture'
@@ -59767,11 +59465,6 @@ class state_name(String, AllowedValuesMixin):
59767
59465
  class use_active(Command):
59768
59466
  """
59769
59467
  'use_active' command.
59770
-
59771
- Parameters
59772
- ----------
59773
- state_name : str
59774
- 'state_name' child.
59775
59468
  """
59776
59469
  version = '241'
59777
59470
  fluent_name = 'use-active'
@@ -61335,15 +61028,6 @@ class write_format(String, AllowedValuesMixin):
61335
61028
  class write_2(Command):
61336
61029
  """
61337
61030
  'write' command.
61338
-
61339
- Parameters
61340
- ----------
61341
- object_name : str
61342
- 'object_name' child.
61343
- write_format : str
61344
- 'write_format' child.
61345
- file_name : str
61346
- 'file_name' child.
61347
61031
  """
61348
61032
  version = '241'
61349
61033
  fluent_name = 'write'
@@ -62616,11 +62300,6 @@ class set_custom_frames_1(Group):
62616
62300
  class read_animation(Command):
62617
62301
  """
62618
62302
  'read_animation' command.
62619
-
62620
- Parameters
62621
- ----------
62622
- file_name : str
62623
- 'file_name' child.
62624
62303
  """
62625
62304
  version = '241'
62626
62305
  fluent_name = 'read-animation'
@@ -63257,19 +62936,6 @@ class correlation_variable(String, AllowedValuesMixin):
63257
62936
  class plot_sample(Command):
63258
62937
  """
63259
62938
  'plot_sample' command.
63260
-
63261
- Parameters
63262
- ----------
63263
- sample : str
63264
- 'sample' child.
63265
- variable_to_sample : str
63266
- 'variable_to_sample' child.
63267
- weighting_variable : str
63268
- 'weighting_variable' child.
63269
- correlation_variable : str
63270
- 'correlation_variable' child.
63271
- file_name : str
63272
- 'file_name' child.
63273
62939
  """
63274
62940
  version = '241'
63275
62941
  fluent_name = 'plot-sample'
@@ -63287,19 +62953,6 @@ class plot_sample(Command):
63287
62953
  class write_sample(Command):
63288
62954
  """
63289
62955
  'write_sample' command.
63290
-
63291
- Parameters
63292
- ----------
63293
- sample : str
63294
- 'sample' child.
63295
- variable_to_sample : str
63296
- 'variable_to_sample' child.
63297
- weighting_variable : str
63298
- 'weighting_variable' child.
63299
- correlation_variable : str
63300
- 'correlation_variable' child.
63301
- file_name : str
63302
- 'file_name' child.
63303
62956
  """
63304
62957
  version = '241'
63305
62958
  fluent_name = 'write-sample'
@@ -63457,13 +63110,6 @@ class max_val(Real):
63457
63110
  class set_maximum(Command):
63458
63111
  """
63459
63112
  'set_maximum' command.
63460
-
63461
- Parameters
63462
- ----------
63463
- sample_var : str
63464
- 'sample_var' child.
63465
- max_val : real
63466
- 'max_val' child.
63467
63113
  """
63468
63114
  version = '241'
63469
63115
  fluent_name = 'set-maximum'
@@ -63694,11 +63340,6 @@ class compute_sample(Command):
63694
63340
  class delete_sample(Command):
63695
63341
  """
63696
63342
  'delete_sample' command.
63697
-
63698
- Parameters
63699
- ----------
63700
- sample : str
63701
- 'sample' child.
63702
63343
  """
63703
63344
  version = '241'
63704
63345
  fluent_name = 'delete-sample'
@@ -63881,23 +63522,6 @@ class accumulate_rates(Boolean):
63881
63522
  class compute_3(Command):
63882
63523
  """
63883
63524
  'compute' command.
63884
-
63885
- Parameters
63886
- ----------
63887
- injections : List
63888
- 'injections' child.
63889
- boundaries : List
63890
- 'boundaries' child.
63891
- lines : List
63892
- Select surface.
63893
- planes : List
63894
- Select surface.
63895
- op_udf : str
63896
- 'op_udf' child.
63897
- append_sample : bool
63898
- 'append_sample' child.
63899
- accumulate_rates : bool
63900
- 'accumulate_rates' child.
63901
63525
  """
63902
63526
  version = '241'
63903
63527
  fluent_name = 'compute'
@@ -63917,23 +63541,6 @@ class compute_3(Command):
63917
63541
  class start_file_write(Command):
63918
63542
  """
63919
63543
  'start_file_write' command.
63920
-
63921
- Parameters
63922
- ----------
63923
- injections : List
63924
- 'injections' child.
63925
- boundaries : List
63926
- 'boundaries' child.
63927
- lines : List
63928
- Select surface.
63929
- planes : List
63930
- Select surface.
63931
- op_udf : str
63932
- 'op_udf' child.
63933
- append_sample : bool
63934
- 'append_sample' child.
63935
- accumulate_rates : bool
63936
- 'accumulate_rates' child.
63937
63544
  """
63938
63545
  version = '241'
63939
63546
  fluent_name = 'start-file-write'
@@ -64486,11 +64093,6 @@ class fluxes(Group):
64486
64093
  class species_mass_flow(Command):
64487
64094
  """
64488
64095
  'species_mass_flow' command.
64489
-
64490
- Parameters
64491
- ----------
64492
- domain : str
64493
- 'domain' child.
64494
64096
  """
64495
64097
  version = '241'
64496
64098
  fluent_name = 'species-mass-flow'
@@ -64504,11 +64106,6 @@ class species_mass_flow(Command):
64504
64106
  class element_mass_flow(Command):
64505
64107
  """
64506
64108
  'element_mass_flow' command.
64507
-
64508
- Parameters
64509
- ----------
64510
- domain : str
64511
- 'domain' child.
64512
64109
  """
64513
64110
  version = '241'
64514
64111
  fluent_name = 'element-mass-flow'
@@ -64522,11 +64119,6 @@ class element_mass_flow(Command):
64522
64119
  class uds_flow(Command):
64523
64120
  """
64524
64121
  'uds_flow' command.
64525
-
64526
- Parameters
64527
- ----------
64528
- domain : str
64529
- 'domain' child.
64530
64122
  """
64531
64123
  version = '241'
64532
64124
  fluent_name = 'uds-flow'
@@ -64716,27 +64308,6 @@ class dia_upper_limit(Real):
64716
64308
  class number_density(Command):
64717
64309
  """
64718
64310
  'number_density' command.
64719
-
64720
- Parameters
64721
- ----------
64722
- report_type : str
64723
- 'report_type' child.
64724
- disc_output_type : str
64725
- 'disc_output_type' child.
64726
- qmom_output_type : str
64727
- 'qmom_output_type' child.
64728
- smm_output_type : str
64729
- 'smm_output_type' child.
64730
- surface_list : List
64731
- Select surface.
64732
- volume_list : List
64733
- Enter cell zone name list.
64734
- num_dens_func : str
64735
- 'num_dens_func' child.
64736
- dia_upper_limit : real
64737
- 'dia_upper_limit' child.
64738
- file_name : str
64739
- 'file_name' child.
64740
64311
  """
64741
64312
  version = '241'
64742
64313
  fluent_name = 'number-density'
@@ -66347,33 +65918,6 @@ class coordinate_value(Real):
66347
65918
  class forces(Command):
66348
65919
  """
66349
65920
  'forces' command.
66350
-
66351
- Parameters
66352
- ----------
66353
- option : str
66354
- 'option' child.
66355
- domain : str
66356
- 'domain' child.
66357
- all_wall_zones : bool
66358
- Select all wall zones available.
66359
- wall_zones : List
66360
- Enter wall zone name list.
66361
- direction_vector : List
66362
- 'direction_vector' child.
66363
- momentum_center : List
66364
- 'momentum_center' child.
66365
- momentum_axis : List
66366
- 'momentum_axis' child.
66367
- pressure_coordinate : str
66368
- 'pressure_coordinate' child.
66369
- coordinate_value : real
66370
- 'coordinate_value' child.
66371
- write_to_file : bool
66372
- 'write_to_file' child.
66373
- file_name : str
66374
- 'file_name' child.
66375
- append_data : bool
66376
- 'append_data' child.
66377
65921
  """
66378
65922
  version = '241'
66379
65923
  fluent_name = 'forces'
@@ -66551,21 +66095,6 @@ class scale_output(Boolean):
66551
66095
  class vbm(Command):
66552
66096
  """
66553
66097
  'vbm' command.
66554
-
66555
- Parameters
66556
- ----------
66557
- output_quantity : str
66558
- 'output_quantity' child.
66559
- rotor_name : str
66560
- 'rotor_name' child.
66561
- scale_output : bool
66562
- 'scale_output' child.
66563
- write_to_file : bool
66564
- 'write_to_file' child.
66565
- file_name : str
66566
- 'file_name' child.
66567
- append : bool
66568
- 'append' child.
66569
66098
  """
66570
66099
  version = '241'
66571
66100
  fluent_name = 'vbm'
@@ -68678,13 +68207,6 @@ class invalidate_case(Boolean):
68678
68207
  class kill_node(Command):
68679
68208
  """
68680
68209
  'kill_node' command.
68681
-
68682
- Parameters
68683
- ----------
68684
- compute_node : int
68685
- 'compute_node' child.
68686
- invalidate_case : bool
68687
- 'invalidate_case' child.
68688
68210
  """
68689
68211
  version = '241'
68690
68212
  fluent_name = 'kill-node'