ansys-fluent-core 0.29.dev2__py3-none-any.whl → 0.30.dev0__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 (144) hide show
  1. ansys/fluent/core/__init__.py +26 -1
  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 +22 -0
  23. ansys/fluent/core/filereader/casereader.py +22 -0
  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 +23 -1
  27. ansys/fluent/core/generated/api_tree/api_objects.json +1 -1
  28. ansys/fluent/core/generated/datamodel_252/meshing.py +31 -0
  29. ansys/fluent/core/generated/fluent_version_252.py +3 -3
  30. ansys/fluent/core/generated/solver/settings_222.py +0 -72
  31. ansys/fluent/core/generated/solver/settings_222.pyi +0 -307
  32. ansys/fluent/core/generated/solver/settings_231.py +0 -574
  33. ansys/fluent/core/generated/solver/settings_231.pyi +0 -561
  34. ansys/fluent/core/generated/solver/settings_232.py +0 -527
  35. ansys/fluent/core/generated/solver/settings_232.pyi +0 -2803
  36. ansys/fluent/core/generated/solver/settings_241.py +0 -478
  37. ansys/fluent/core/generated/solver/settings_241.pyi +0 -522
  38. ansys/fluent/core/generated/solver/settings_242.py +0 -361
  39. ansys/fluent/core/generated/solver/settings_242.pyi +0 -591
  40. ansys/fluent/core/generated/solver/settings_251.py +0 -399
  41. ansys/fluent/core/generated/solver/settings_251.pyi +0 -629
  42. ansys/fluent/core/generated/solver/settings_252.py +7626 -4108
  43. ansys/fluent/core/generated/solver/settings_252.pyi +6779 -3098
  44. ansys/fluent/core/generated/solver/tui_252.py +489 -157
  45. ansys/fluent/core/get_build_details.py +22 -0
  46. ansys/fluent/core/journaling.py +38 -0
  47. ansys/fluent/core/launcher/__init__.py +22 -0
  48. ansys/fluent/core/launcher/container_launcher.py +63 -55
  49. ansys/fluent/core/launcher/error_handler.py +30 -0
  50. ansys/fluent/core/launcher/fluent_container.py +23 -1
  51. ansys/fluent/core/launcher/launcher.py +51 -3
  52. ansys/fluent/core/launcher/launcher_utils.py +22 -0
  53. ansys/fluent/core/launcher/pim_launcher.py +120 -86
  54. ansys/fluent/core/launcher/process_launch_string.py +22 -0
  55. ansys/fluent/core/launcher/pyfluent_enums.py +22 -0
  56. ansys/fluent/core/launcher/server_info.py +45 -3
  57. ansys/fluent/core/launcher/slurm_launcher.py +23 -1
  58. ansys/fluent/core/launcher/standalone_launcher.py +68 -63
  59. ansys/fluent/core/launcher/watchdog.py +22 -0
  60. ansys/fluent/core/logging.py +22 -0
  61. ansys/fluent/core/meshing/meshing_workflow.py +22 -0
  62. ansys/fluent/core/parametric.py +22 -0
  63. ansys/fluent/core/post_objects/__init__.py +21 -0
  64. ansys/fluent/core/post_objects/check_in_notebook.py +22 -0
  65. ansys/fluent/core/post_objects/meta.py +22 -0
  66. ansys/fluent/core/post_objects/post_helper.py +22 -0
  67. ansys/fluent/core/post_objects/post_object_definitions.py +22 -0
  68. ansys/fluent/core/post_objects/post_objects_container.py +22 -0
  69. ansys/fluent/core/post_objects/singleton_meta.py +22 -0
  70. ansys/fluent/core/post_objects/timing_decorator.py +22 -0
  71. ansys/fluent/core/report.py +77 -0
  72. ansys/fluent/core/rpvars.py +22 -0
  73. ansys/fluent/core/scheduler/__init__.py +22 -0
  74. ansys/fluent/core/scheduler/load_machines.py +22 -0
  75. ansys/fluent/core/scheduler/machine_list.py +22 -0
  76. ansys/fluent/core/search.py +22 -0
  77. ansys/fluent/core/services/__init__.py +22 -0
  78. ansys/fluent/core/services/api_upgrade.py +22 -0
  79. ansys/fluent/core/services/app_utilities.py +38 -0
  80. ansys/fluent/core/services/batch_ops.py +22 -0
  81. ansys/fluent/core/services/datamodel_se.py +22 -2
  82. ansys/fluent/core/services/datamodel_tui.py +22 -0
  83. ansys/fluent/core/services/deprecated_field_data.py +23 -1
  84. ansys/fluent/core/services/events.py +22 -0
  85. ansys/fluent/core/services/field_data.py +46 -15
  86. ansys/fluent/core/services/health_check.py +22 -0
  87. ansys/fluent/core/services/interceptors.py +22 -0
  88. ansys/fluent/core/services/monitor.py +22 -0
  89. ansys/fluent/core/services/reduction.py +22 -0
  90. ansys/fluent/core/services/scheme_eval.py +22 -0
  91. ansys/fluent/core/services/settings.py +22 -0
  92. ansys/fluent/core/services/solution_variables.py +22 -0
  93. ansys/fluent/core/services/streaming.py +22 -0
  94. ansys/fluent/core/services/transcript.py +22 -0
  95. ansys/fluent/core/session.py +32 -0
  96. ansys/fluent/core/session_base_meshing.py +22 -0
  97. ansys/fluent/core/session_meshing.py +22 -0
  98. ansys/fluent/core/session_meshing.pyi +22 -0
  99. ansys/fluent/core/session_pure_meshing.py +22 -0
  100. ansys/fluent/core/session_pure_meshing.pyi +22 -0
  101. ansys/fluent/core/session_shared.py +22 -0
  102. ansys/fluent/core/session_solver.py +22 -0
  103. ansys/fluent/core/session_solver.pyi +22 -0
  104. ansys/fluent/core/session_solver_aero.py +22 -0
  105. ansys/fluent/core/session_solver_icing.py +22 -0
  106. ansys/fluent/core/session_solver_lite.py +22 -0
  107. ansys/fluent/core/solver/__init__.py +22 -0
  108. ansys/fluent/core/solver/error_message.py +22 -0
  109. ansys/fluent/core/solver/flobject.py +22 -0
  110. ansys/fluent/core/solver/flunits.py +22 -0
  111. ansys/fluent/core/solver/function/__init__.py +22 -0
  112. ansys/fluent/core/solver/function/reduction.py +22 -0
  113. ansys/fluent/core/solver/settings_builtin_bases.py +22 -0
  114. ansys/fluent/core/solver/settings_builtin_data.py +22 -0
  115. ansys/fluent/core/solver/settings_external.py +22 -0
  116. ansys/fluent/core/streaming_services/__init__.py +21 -0
  117. ansys/fluent/core/streaming_services/datamodel_event_streaming.py +22 -0
  118. ansys/fluent/core/streaming_services/datamodel_streaming.py +22 -0
  119. ansys/fluent/core/streaming_services/events_streaming.py +22 -0
  120. ansys/fluent/core/streaming_services/field_data_streaming.py +22 -0
  121. ansys/fluent/core/streaming_services/monitor_streaming.py +23 -1
  122. ansys/fluent/core/streaming_services/streaming.py +22 -0
  123. ansys/fluent/core/streaming_services/transcript_streaming.py +22 -0
  124. ansys/fluent/core/systemcoupling.py +22 -0
  125. ansys/fluent/core/utils/__init__.py +22 -0
  126. ansys/fluent/core/utils/data_transfer.py +22 -0
  127. ansys/fluent/core/utils/deprecate.py +24 -1
  128. ansys/fluent/core/utils/dictionary_operations.py +22 -0
  129. ansys/fluent/core/utils/dump_session_data.py +22 -0
  130. ansys/fluent/core/utils/event_loop.py +22 -0
  131. ansys/fluent/core/utils/execution.py +22 -0
  132. ansys/fluent/core/utils/file_transfer_service.py +22 -0
  133. ansys/fluent/core/utils/fix_doc.py +22 -0
  134. ansys/fluent/core/utils/fldoc.py +22 -0
  135. ansys/fluent/core/utils/fluent_version.py +22 -0
  136. ansys/fluent/core/utils/networking.py +22 -0
  137. ansys/fluent/core/utils/setup_for_fluent.py +22 -0
  138. ansys/fluent/core/warnings.py +22 -0
  139. ansys/fluent/core/workflow.py +22 -0
  140. {ansys_fluent_core-0.29.dev2.dist-info → ansys_fluent_core-0.30.dev0.dist-info}/LICENSE +8 -8
  141. {ansys_fluent_core-0.29.dev2.dist-info → ansys_fluent_core-0.30.dev0.dist-info}/METADATA +10 -8
  142. ansys_fluent_core-0.30.dev0.dist-info/RECORD +219 -0
  143. ansys_fluent_core-0.29.dev2.dist-info/RECORD +0 -218
  144. {ansys_fluent_core-0.29.dev2.dist-info → ansys_fluent_core-0.30.dev0.dist-info}/WHEEL +0 -0
@@ -1363,13 +1363,6 @@ class file_name_1(Filename):
1363
1363
  class read_1(Command):
1364
1364
  """
1365
1365
  'read' command.
1366
-
1367
- Parameters
1368
- ----------
1369
- file_type : str
1370
- 'file_type' child.
1371
- file_name : str
1372
- 'file_name' child.
1373
1366
  """
1374
1367
  version = '232'
1375
1368
  fluent_name = 'read'
@@ -1393,11 +1386,6 @@ class report_each_line(Boolean):
1393
1386
  class chemkin_report_each_line(Command):
1394
1387
  """
1395
1388
  'chemkin_report_each_line' command.
1396
-
1397
- Parameters
1398
- ----------
1399
- report_each_line : bool
1400
- Enable/disable reporting after reading each line.
1401
1389
  """
1402
1390
  version = '232'
1403
1391
  fluent_name = 'chemkin-report-each-line?'
@@ -1737,17 +1725,6 @@ class lightweight_setup(Boolean):
1737
1725
  class read(Command):
1738
1726
  """
1739
1727
  'read' command.
1740
-
1741
- Parameters
1742
- ----------
1743
- file_type : str
1744
- 'file_type' child.
1745
- file_name : str
1746
- 'file_name' child.
1747
- pdf_file_name : str
1748
- 'pdf_file_name' child.
1749
- lightweight_setup : bool
1750
- 'lightweight_setup' child.
1751
1728
  """
1752
1729
  version = '232'
1753
1730
  fluent_name = 'read'
@@ -1764,17 +1741,6 @@ class read(Command):
1764
1741
  class read_case(Command):
1765
1742
  """
1766
1743
  'read_case' command.
1767
-
1768
- Parameters
1769
- ----------
1770
- file_type : str
1771
- 'file_type' child.
1772
- file_name : str
1773
- 'file_name' child.
1774
- pdf_file_name : str
1775
- 'pdf_file_name' child.
1776
- lightweight_setup : bool
1777
- 'lightweight_setup' child.
1778
1744
  """
1779
1745
  version = '232'
1780
1746
  fluent_name = 'read-case'
@@ -1791,17 +1757,6 @@ class read_case(Command):
1791
1757
  class read_case_data(Command):
1792
1758
  """
1793
1759
  'read_case_data' command.
1794
-
1795
- Parameters
1796
- ----------
1797
- file_type : str
1798
- 'file_type' child.
1799
- file_name : str
1800
- 'file_name' child.
1801
- pdf_file_name : str
1802
- 'pdf_file_name' child.
1803
- lightweight_setup : bool
1804
- 'lightweight_setup' child.
1805
1760
  """
1806
1761
  version = '232'
1807
1762
  fluent_name = 'read-case-data'
@@ -1818,17 +1773,6 @@ class read_case_data(Command):
1818
1773
  class read_case_setting(Command):
1819
1774
  """
1820
1775
  'read_case_setting' command.
1821
-
1822
- Parameters
1823
- ----------
1824
- file_type : str
1825
- 'file_type' child.
1826
- file_name : str
1827
- 'file_name' child.
1828
- pdf_file_name : str
1829
- 'pdf_file_name' child.
1830
- lightweight_setup : bool
1831
- 'lightweight_setup' child.
1832
1776
  """
1833
1777
  version = '232'
1834
1778
  fluent_name = 'read-case-setting'
@@ -1845,17 +1789,6 @@ class read_case_setting(Command):
1845
1789
  class read_data(Command):
1846
1790
  """
1847
1791
  'read_data' command.
1848
-
1849
- Parameters
1850
- ----------
1851
- file_type : str
1852
- 'file_type' child.
1853
- file_name : str
1854
- 'file_name' child.
1855
- pdf_file_name : str
1856
- 'pdf_file_name' child.
1857
- lightweight_setup : bool
1858
- 'lightweight_setup' child.
1859
1792
  """
1860
1793
  version = '232'
1861
1794
  fluent_name = 'read-data'
@@ -1872,17 +1805,6 @@ class read_data(Command):
1872
1805
  class read_mesh(Command):
1873
1806
  """
1874
1807
  'read_mesh' command.
1875
-
1876
- Parameters
1877
- ----------
1878
- file_type : str
1879
- 'file_type' child.
1880
- file_name : str
1881
- 'file_name' child.
1882
- pdf_file_name : str
1883
- 'pdf_file_name' child.
1884
- lightweight_setup : bool
1885
- 'lightweight_setup' child.
1886
1808
  """
1887
1809
  version = '232'
1888
1810
  fluent_name = 'read-mesh'
@@ -1953,11 +1875,6 @@ class stop_journal(Command):
1953
1875
  class replace_mesh(Command):
1954
1876
  """
1955
1877
  'replace_mesh' command.
1956
-
1957
- Parameters
1958
- ----------
1959
- file_name : str
1960
- 'file_name' child.
1961
1878
  """
1962
1879
  version = '232'
1963
1880
  fluent_name = 'replace-mesh'
@@ -1971,13 +1888,6 @@ class replace_mesh(Command):
1971
1888
  class write(Command):
1972
1889
  """
1973
1890
  'write' command.
1974
-
1975
- Parameters
1976
- ----------
1977
- file_type : str
1978
- 'file_type' child.
1979
- file_name : str
1980
- 'file_name' child.
1981
1891
  """
1982
1892
  version = '232'
1983
1893
  fluent_name = 'write'
@@ -3256,15 +3166,6 @@ class convert_skewed_cells_1(Boolean):
3256
3166
  class convert_skewed_cells(Command):
3257
3167
  """
3258
3168
  'convert_skewed_cells' command.
3259
-
3260
- Parameters
3261
- ----------
3262
- cell_thread_list : List
3263
- Set zones where cells should be converted.
3264
- max_cell_skewness : real
3265
- Set target maximum cell skewness.
3266
- convert_skewed_cells : bool
3267
- 'convert_skewed_cells' child.
3268
3169
  """
3269
3170
  version = '232'
3270
3171
  fluent_name = 'convert-skewed-cells'
@@ -3448,15 +3349,6 @@ class z_scale(Real):
3448
3349
  class scale(Command):
3449
3350
  """
3450
3351
  'scale' command.
3451
-
3452
- Parameters
3453
- ----------
3454
- x_scale : real
3455
- 'x_scale' child.
3456
- y_scale : real
3457
- 'y_scale' child.
3458
- z_scale : real
3459
- 'z_scale' child.
3460
3352
  """
3461
3353
  version = '232'
3462
3354
  fluent_name = 'scale'
@@ -5429,11 +5321,6 @@ class object_name(String, AllowedValuesMixin):
5429
5321
  class list_properties(Command):
5430
5322
  """
5431
5323
  'list_properties' command.
5432
-
5433
- Parameters
5434
- ----------
5435
- object_name : str
5436
- 'object_name' child.
5437
5324
  """
5438
5325
  version = '232'
5439
5326
  fluent_name = 'list-properties'
@@ -5465,13 +5352,6 @@ class to(String):
5465
5352
  class duplicate(Command):
5466
5353
  """
5467
5354
  'duplicate' command.
5468
-
5469
- Parameters
5470
- ----------
5471
- from_ : str
5472
- 'from' child.
5473
- to : str
5474
- 'to' child.
5475
5355
  """
5476
5356
  version = '232'
5477
5357
  fluent_name = 'duplicate'
@@ -5696,11 +5576,6 @@ class object_at(Integer):
5696
5576
  class list_properties_1(Command):
5697
5577
  """
5698
5578
  'list_properties' command.
5699
-
5700
- Parameters
5701
- ----------
5702
- object_at : int
5703
- 'object_at' child.
5704
5579
  """
5705
5580
  version = '232'
5706
5581
  fluent_name = 'list-properties'
@@ -10574,12 +10449,10 @@ class root_radius(Real):
10574
10449
  class basic_info(Group):
10575
10450
  """
10576
10451
  Menu to define the rotor basic informations:
10577
-
10578
10452
  - Number of Blades
10579
10453
  - Rotor Speed ,
10580
10454
  - Tip Radius
10581
10455
  - Root Radius ,
10582
-
10583
10456
  For more details please consult the help option of the corresponding menu or TUI command.
10584
10457
  """
10585
10458
  version = '232'
@@ -10640,10 +10513,8 @@ class disk_origin(Group):
10640
10513
  class terminology(Integer):
10641
10514
  """
10642
10515
  Select Rotor Disk Orientation Terminology:
10643
-
10644
10516
  - Enter 0 if using Rotor Disk Angles
10645
10517
  - Enter 1 if using Rotor Disk Normal
10646
-
10647
10518
  For more details please consult the help option of the corresponding menu or TUI command.
10648
10519
  """
10649
10520
  version = '232'
@@ -10699,12 +10570,10 @@ class disk_bank_angle(Real):
10699
10570
  class disk_orientation(Group):
10700
10571
  """
10701
10572
  Menu to define the rotor disk orientation.
10702
-
10703
10573
  - terminology : the terminology to specify the rotor disk orientation: rotor-disk-angles / rotor-disk-normal,
10704
10574
  - disk-normal-x/yz : rotor-disk-normal components,
10705
10575
  - disk-pitch-angle : ,
10706
10576
  - disk-bank-angle : ,
10707
-
10708
10577
  For more details please consult the help option of the corresponding menu or TUI command.
10709
10578
  """
10710
10579
  version = '232'
@@ -10751,11 +10620,9 @@ class create_floating_disk(Command):
10751
10620
  class disk_id(Group):
10752
10621
  """
10753
10622
  Menu to define the disk face/surface name:
10754
-
10755
10623
  - embedded-face-zone : select embedded-face-zone name,
10756
10624
  - floating-surface-name : select floating-surface-name,
10757
10625
  - create-floating-disk : create a floating-disk for the current rotor,
10758
-
10759
10626
  For more details please consult the help option of the corresponding menu or TUI command.
10760
10627
  """
10761
10628
  version = '232'
@@ -10800,11 +10667,9 @@ class blade_pitch_cyclic_cos(Real):
10800
10667
  class blade_pitch_angles(Group):
10801
10668
  """
10802
10669
  Menu to define the rotor pitch and flapping angles.
10803
-
10804
10670
  - blade-pitch-collective : ,
10805
10671
  - blade-pitch-cyclic-sin : ,
10806
10672
  - blade-pitch-cyclic-cos : ,
10807
-
10808
10673
  For more details please consult the help option of the corresponding menu or TUI command.
10809
10674
  """
10810
10675
  version = '232'
@@ -10848,11 +10713,9 @@ class blade_flapping_cyclic_cos(Real):
10848
10713
  class blade_flap_angles(Group):
10849
10714
  """
10850
10715
  Menu to define the rotor pitch angles.
10851
-
10852
10716
  - blade-flapping-cone : ,
10853
10717
  - blade-flapping-cyclic-sin : ,
10854
10718
  - blade-flapping-cyclic-cos : ,
10855
-
10856
10719
  For more details please consult the help option of the corresponding menu or TUI command.
10857
10720
  """
10858
10721
  version = '232'
@@ -10869,10 +10732,8 @@ class blade_flap_angles(Group):
10869
10732
  class model_tip_loss(Integer):
10870
10733
  """
10871
10734
  Select Tip Loss Model:
10872
-
10873
10735
  - Enter 1 if using Quadratic model
10874
10736
  - Enter 2 if using modified Prandtl model
10875
-
10876
10737
  For more details please consult the help option of the corresponding menu or TUI command.
10877
10738
  """
10878
10739
  version = '232'
@@ -10901,11 +10762,9 @@ class prandtl_tuning_coefficient(Real):
10901
10762
  class tip_loss(Group):
10902
10763
  """
10903
10764
  Menu to define the rotor tip loss model.
10904
-
10905
10765
  - method : define the method to model rotor tip loss, quadratic-tip-loss, prandtl-tip-loss
10906
10766
  - tip-loss-limit : tip-loss-limit,
10907
10767
  - prandtl-tuning-coefficient: prandtl-tuning-coefficient,
10908
-
10909
10768
  For more details please consult the help option of the corresponding menu or TUI command.
10910
10769
  """
10911
10770
  version = '232'
@@ -11014,12 +10873,10 @@ class geometry_2(NamedObject[geometry_2_child], CreatableNamedObjectMixinOld[geo
11014
10873
  class trim_option(Integer):
11015
10874
  """
11016
10875
  Select Trimming Option:
11017
-
11018
10876
  - Enter 0 if no trimming is required
11019
10877
  - Enter 1 if trimming of collective pitch is required
11020
10878
  - Enter 2 if trimming of cyclic pitch angles are required
11021
10879
  - Enter 3 if trimming of both collective and cyclic pitch angles are required
11022
-
11023
10880
  For more details please consult the help option of the corresponding menu or TUI command.
11024
10881
  """
11025
10882
  version = '232'
@@ -11075,14 +10932,12 @@ class roll_moment_coef(Real):
11075
10932
  class trimming(Group):
11076
10933
  """
11077
10934
  Menu to define rotor trimming set-up.
11078
-
11079
10935
  - trim-option : to define collective and cyclic pitches to trim,
11080
10936
  - update-frequency : the number of solver iterations that pitch angle will be updated each time,
11081
10937
  - damping-factor : relaxation factor for pitch angles,
11082
10938
  - thrust-coef : desired thrust coefficient to set pitch for
11083
10939
  - pitch-moment-coef : desired pitch-moment coefficient to set pitch for,
11084
10940
  - roll-moment-coef : desired roll-moment coefficient to set pitch for,
11085
-
11086
10941
  For more details please consult the help option of the corresponding menu or TUI command.
11087
10942
  """
11088
10943
  version = '232'
@@ -11389,19 +11244,6 @@ class avg_time_steps(Integer):
11389
11244
  class statistics_controls(Command):
11390
11245
  """
11391
11246
  'statistics_controls' command.
11392
-
11393
- Parameters
11394
- ----------
11395
- method : int
11396
- 'method' child.
11397
- samp_time_period : real
11398
- 'samp_time_period' child.
11399
- samp_time_steps : int
11400
- 'samp_time_steps' child.
11401
- avg_time_period : real
11402
- 'avg_time_period' child.
11403
- avg_time_steps : int
11404
- 'avg_time_steps' child.
11405
11247
  """
11406
11248
  version = '232'
11407
11249
  fluent_name = 'statistics-controls'
@@ -19367,15 +19209,6 @@ class verbosity_3(Boolean):
19367
19209
  class copy_1(Command):
19368
19210
  """
19369
19211
  'copy' command.
19370
-
19371
- Parameters
19372
- ----------
19373
- from_ : str
19374
- 'from' child.
19375
- to : List
19376
- 'to' child.
19377
- verbosity : bool
19378
- 'verbosity' child.
19379
19212
  """
19380
19213
  version = '232'
19381
19214
  fluent_name = 'copy'
@@ -19409,13 +19242,6 @@ class new_type(String, AllowedValuesMixin):
19409
19242
  class change_type(Command):
19410
19243
  """
19411
19244
  'change_type' command.
19412
-
19413
- Parameters
19414
- ----------
19415
- zone_list : List
19416
- 'zone_list' child.
19417
- new_type : str
19418
- 'new_type' child.
19419
19245
  """
19420
19246
  version = '232'
19421
19247
  fluent_name = 'change-type'
@@ -19439,11 +19265,6 @@ class cell_zone_list(StringList, AllowedValuesMixin):
19439
19265
  class activate_cell_zone(Command):
19440
19266
  """
19441
19267
  'activate_cell_zone' command.
19442
-
19443
- Parameters
19444
- ----------
19445
- cell_zone_list : List
19446
- 'cell_zone_list' child.
19447
19268
  """
19448
19269
  version = '232'
19449
19270
  fluent_name = 'activate-cell-zone'
@@ -33104,15 +32925,6 @@ class phase_25(String):
33104
32925
  class compute(Command):
33105
32926
  """
33106
32927
  'compute' command.
33107
-
33108
- Parameters
33109
- ----------
33110
- from_zone_type : str
33111
- 'from_zone_type' child.
33112
- from_zone_name : str
33113
- 'from_zone_name' child.
33114
- phase : str
33115
- 'phase' child.
33116
32928
  """
33117
32929
  version = '232'
33118
32930
  fluent_name = 'compute'
@@ -34424,11 +34236,6 @@ class face_name(String, AllowedValuesMixin):
34424
34236
  class list_face(Command):
34425
34237
  """
34426
34238
  'list_face' command.
34427
-
34428
- Parameters
34429
- ----------
34430
- face_name : str
34431
- 'face_name' child.
34432
34239
  """
34433
34240
  version = '232'
34434
34241
  fluent_name = 'list-face'
@@ -40508,11 +40315,6 @@ class report_defs(StringList, AllowedValuesMixin):
40508
40315
  class compute_1(Command):
40509
40316
  """
40510
40317
  'compute' command.
40511
-
40512
- Parameters
40513
- ----------
40514
- report_defs : List
40515
- 'report_defs' child.
40516
40318
  """
40517
40319
  version = '232'
40518
40320
  fluent_name = 'compute'
@@ -40544,13 +40346,6 @@ class copy_to(String):
40544
40346
  class copy_2(Command):
40545
40347
  """
40546
40348
  'copy' command.
40547
-
40548
- Parameters
40549
- ----------
40550
- copy_from : str
40551
- 'copy_from' child.
40552
- copy_to : str
40553
- 'copy_to' child.
40554
40349
  """
40555
40350
  version = '232'
40556
40351
  fluent_name = 'copy'
@@ -42382,15 +42177,6 @@ class cycle_count(RealList):
42382
42177
  class customize_fmg_initialization(Command):
42383
42178
  """
42384
42179
  'customize_fmg_initialization' command.
42385
-
42386
- Parameters
42387
- ----------
42388
- multi_level_grid : int
42389
- 'multi_level_grid' child.
42390
- residual_reduction_level : List
42391
- 'residual_reduction_level' child.
42392
- cycle_count : List
42393
- 'cycle_count' child.
42394
42180
  """
42395
42181
  version = '232'
42396
42182
  fluent_name = 'customize-fmg-initialization'
@@ -42431,15 +42217,6 @@ class initialize(Command):
42431
42217
  class compute_defaults(Command):
42432
42218
  """
42433
42219
  'compute_defaults' command.
42434
-
42435
- Parameters
42436
- ----------
42437
- from_zone_type : str
42438
- 'from_zone_type' child.
42439
- from_zone_name : str
42440
- 'from_zone_name' child.
42441
- phase : str
42442
- 'phase' child.
42443
42220
  """
42444
42221
  version = '232'
42445
42222
  fluent_name = 'compute-defaults'
@@ -42563,13 +42340,6 @@ class time_step_count(Integer):
42563
42340
  class init_acoustics_options(Command):
42564
42341
  """
42565
42342
  'init_acoustics_options' command.
42566
-
42567
- Parameters
42568
- ----------
42569
- set_ramping_length : bool
42570
- Enable/Disable ramping length and initialize acoustics.
42571
- time_step_count : int
42572
- Set number of timesteps for ramping of sources.
42573
42343
  """
42574
42344
  version = '232'
42575
42345
  fluent_name = 'init-acoustics-options'
@@ -42638,11 +42408,6 @@ class command_name(String):
42638
42408
  class enable_14(Command):
42639
42409
  """
42640
42410
  Enable an execute-command.
42641
-
42642
- Parameters
42643
- ----------
42644
- command_name : str
42645
- 'command_name' child.
42646
42411
  """
42647
42412
  version = '232'
42648
42413
  fluent_name = 'enable'
@@ -42656,11 +42421,6 @@ class enable_14(Command):
42656
42421
  class disable_1(Command):
42657
42422
  """
42658
42423
  Disable an execute-command.
42659
-
42660
- Parameters
42661
- ----------
42662
- command_name : str
42663
- 'command_name' child.
42664
42424
  """
42665
42425
  version = '232'
42666
42426
  fluent_name = 'disable'
@@ -42674,11 +42434,6 @@ class disable_1(Command):
42674
42434
  class copy_3(Command):
42675
42435
  """
42676
42436
  Copy an execute-command.
42677
-
42678
- Parameters
42679
- ----------
42680
- command_name : str
42681
- 'command_name' child.
42682
42437
  """
42683
42438
  version = '232'
42684
42439
  fluent_name = 'copy'
@@ -42692,11 +42447,6 @@ class copy_3(Command):
42692
42447
  class delete_2(CommandWithPositionalArgs):
42693
42448
  """
42694
42449
  Delete an execute-command.
42695
-
42696
- Parameters
42697
- ----------
42698
- command_name : str
42699
- 'command_name' child.
42700
42450
  """
42701
42451
  version = '232'
42702
42452
  fluent_name = 'delete'
@@ -42728,13 +42478,6 @@ class tsv_file_name(Filename):
42728
42478
  class export_1(Command):
42729
42479
  """
42730
42480
  Export execute-commands to a TSV file.
42731
-
42732
- Parameters
42733
- ----------
42734
- command_name : List
42735
- 'command_name' child.
42736
- tsv_file_name : str
42737
- 'tsv_file_name' child.
42738
42481
  """
42739
42482
  version = '232'
42740
42483
  fluent_name = 'export'
@@ -42749,11 +42492,6 @@ class export_1(Command):
42749
42492
  class import__1(Command):
42750
42493
  """
42751
42494
  Import execute-commands from a TSV file.
42752
-
42753
- Parameters
42754
- ----------
42755
- tsv_file_name : str
42756
- 'tsv_file_name' child.
42757
42495
  """
42758
42496
  version = '232'
42759
42497
  fluent_name = 'import'
@@ -43300,13 +43038,6 @@ class command_list(StringList):
43300
43038
  class export_modifications(Command):
43301
43039
  """
43302
43040
  Export all case modifications to a tsv file.
43303
-
43304
- Parameters
43305
- ----------
43306
- command_list : List
43307
- 'command_list' child.
43308
- filename : str
43309
- 'filename' child.
43310
43041
  """
43311
43042
  version = '232'
43312
43043
  fluent_name = 'export-modifications'
@@ -47961,21 +47692,6 @@ class direction_vector_1(RealList):
47961
47692
  class set_light(Command):
47962
47693
  """
47963
47694
  'set_light' command.
47964
-
47965
- Parameters
47966
- ----------
47967
- light_number : int
47968
- 'light_number' child.
47969
- light_on : bool
47970
- 'light_on' child.
47971
- rgb_vector : List
47972
- 'rgb_vector' child.
47973
- use_view_factor : bool
47974
- 'use_view_factor' child.
47975
- change_light_direction : bool
47976
- 'change_light_direction' child.
47977
- direction_vector : List
47978
- 'direction_vector' child.
47979
47695
  """
47980
47696
  version = '232'
47981
47697
  fluent_name = 'set-light'
@@ -48175,11 +47891,6 @@ class preview(Command):
48175
47891
  class save_picture(Command):
48176
47892
  """
48177
47893
  'save_picture' command.
48178
-
48179
- Parameters
48180
- ----------
48181
- file_name : str
48182
- 'file_name' child.
48183
47894
  """
48184
47895
  version = '232'
48185
47896
  fluent_name = 'save-picture'
@@ -48518,11 +48229,6 @@ class state_name(String, AllowedValuesMixin):
48518
48229
  class use_active(Command):
48519
48230
  """
48520
48231
  'use_active' command.
48521
-
48522
- Parameters
48523
- ----------
48524
- state_name : str
48525
- 'state_name' child.
48526
48232
  """
48527
48233
  version = '232'
48528
48234
  fluent_name = 'use-active'
@@ -50716,11 +50422,6 @@ class file_name_path_1(String):
50716
50422
  class write_simulation_report_template_file(Command):
50717
50423
  """
50718
50424
  'write_simulation_report_template_file' command.
50719
-
50720
- Parameters
50721
- ----------
50722
- file_name_path : str
50723
- 'file_name_path' child.
50724
50425
  """
50725
50426
  version = '232'
50726
50427
  fluent_name = 'write-simulation-report-template-file'
@@ -50968,21 +50669,6 @@ class read_fn(Filename):
50968
50669
  class plot_sample(Command):
50969
50670
  """
50970
50671
  'plot_sample' command.
50971
-
50972
- Parameters
50973
- ----------
50974
- loaded_samples : str
50975
- 'loaded_samples' child.
50976
- variable_to_sampled : str
50977
- 'variable_to_sampled' child.
50978
- weighting_var : str
50979
- 'weighting_var' child.
50980
- correlation_var : str
50981
- 'correlation_var' child.
50982
- read_fn : str
50983
- 'read_fn' child.
50984
- overwrite : bool
50985
- 'overwrite' child.
50986
50672
  """
50987
50673
  version = '232'
50988
50674
  fluent_name = 'plot-sample'
@@ -51001,21 +50687,6 @@ class plot_sample(Command):
51001
50687
  class write_sample(Command):
51002
50688
  """
51003
50689
  'write_sample' command.
51004
-
51005
- Parameters
51006
- ----------
51007
- loaded_samples : str
51008
- 'loaded_samples' child.
51009
- variable_to_sampled : str
51010
- 'variable_to_sampled' child.
51011
- weighting_var : str
51012
- 'weighting_var' child.
51013
- correlation_var : str
51014
- 'correlation_var' child.
51015
- read_fn : str
51016
- 'read_fn' child.
51017
- overwrite : bool
51018
- 'overwrite' child.
51019
50690
  """
51020
50691
  version = '232'
51021
50692
  fluent_name = 'write-sample'
@@ -51183,13 +50854,6 @@ class max_val(Real):
51183
50854
  class set_maximum(Command):
51184
50855
  """
51185
50856
  'set_maximum' command.
51186
-
51187
- Parameters
51188
- ----------
51189
- sample_var : str
51190
- 'sample_var' child.
51191
- max_val : real
51192
- 'max_val' child.
51193
50857
  """
51194
50858
  version = '232'
51195
50859
  fluent_name = 'set-maximum'
@@ -51414,11 +51078,6 @@ class compute_sample(Command):
51414
51078
  class delete_sample(Command):
51415
51079
  """
51416
51080
  'delete_sample' command.
51417
-
51418
- Parameters
51419
- ----------
51420
- sample : str
51421
- 'sample' child.
51422
51081
  """
51423
51082
  version = '232'
51424
51083
  fluent_name = 'delete-sample'
@@ -51610,23 +51269,6 @@ class accumulate_rates(Boolean):
51610
51269
  class sample_1(Command):
51611
51270
  """
51612
51271
  'sample' command.
51613
-
51614
- Parameters
51615
- ----------
51616
- injections : List
51617
- 'injections' child.
51618
- boundaries : List
51619
- 'boundaries' child.
51620
- lines : List
51621
- 'lines' child.
51622
- planes : List
51623
- 'planes' child.
51624
- op_udf : str
51625
- 'op_udf' child.
51626
- append_sample : bool
51627
- 'append_sample' child.
51628
- accumulate_rates : bool
51629
- 'accumulate_rates' child.
51630
51272
  """
51631
51273
  version = '232'
51632
51274
  fluent_name = 'sample'
@@ -52184,11 +51826,6 @@ class fluxes(Group):
52184
51826
  class species_mass_flow(Command):
52185
51827
  """
52186
51828
  'species_mass_flow' command.
52187
-
52188
- Parameters
52189
- ----------
52190
- domain_val : str
52191
- 'domain_val' child.
52192
51829
  """
52193
51830
  version = '232'
52194
51831
  fluent_name = 'species-mass-flow'
@@ -52202,11 +51839,6 @@ class species_mass_flow(Command):
52202
51839
  class element_mass_flow(Command):
52203
51840
  """
52204
51841
  'element_mass_flow' command.
52205
-
52206
- Parameters
52207
- ----------
52208
- domain_val : str
52209
- 'domain_val' child.
52210
51842
  """
52211
51843
  version = '232'
52212
51844
  fluent_name = 'element-mass-flow'
@@ -52220,11 +51852,6 @@ class element_mass_flow(Command):
52220
51852
  class uds_flow(Command):
52221
51853
  """
52222
51854
  'uds_flow' command.
52223
-
52224
- Parameters
52225
- ----------
52226
- domain_val : str
52227
- 'domain_val' child.
52228
51855
  """
52229
51856
  version = '232'
52230
51857
  fluent_name = 'uds-flow'
@@ -52420,29 +52047,6 @@ class dia_upper_limit(Real):
52420
52047
  class number_density(Command):
52421
52048
  """
52422
52049
  'number_density' command.
52423
-
52424
- Parameters
52425
- ----------
52426
- report_type : str
52427
- 'report_type' child.
52428
- disc_output_type : str
52429
- 'disc_output_type' child.
52430
- qmom_output_type : str
52431
- 'qmom_output_type' child.
52432
- smm_output_type : str
52433
- 'smm_output_type' child.
52434
- surface_list : List
52435
- 'surface_list' child.
52436
- volume_list : List
52437
- 'volume_list' child.
52438
- num_dens_func : str
52439
- 'num_dens_func' child.
52440
- dia_upper_limit : real
52441
- 'dia_upper_limit' child.
52442
- file_name : str
52443
- 'file_name' child.
52444
- overwrite : bool
52445
- 'overwrite' child.
52446
52050
  """
52447
52051
  version = '232'
52448
52052
  fluent_name = 'number-density'
@@ -52515,25 +52119,6 @@ class append_file(Boolean):
52515
52119
  class computed_heat_rejection(Command):
52516
52120
  """
52517
52121
  'computed_heat_rejection' command.
52518
-
52519
- Parameters
52520
- ----------
52521
- heat_exchanger : str
52522
- 'heat_exchanger' child.
52523
- fluid_zone : str
52524
- 'fluid_zone' child.
52525
- boundary_zone : str
52526
- 'boundary_zone' child.
52527
- report_type : str
52528
- 'report_type' child.
52529
- write_to_file : bool
52530
- 'write_to_file' child.
52531
- file_name : str
52532
- 'file_name' child.
52533
- append_file : bool
52534
- 'append_file' child.
52535
- overwrite : bool
52536
- 'overwrite' child.
52537
52122
  """
52538
52123
  version = '232'
52539
52124
  fluent_name = 'computed-heat-rejection'
@@ -52554,25 +52139,6 @@ class computed_heat_rejection(Command):
52554
52139
  class inlet_temperature(Command):
52555
52140
  """
52556
52141
  'inlet_temperature' command.
52557
-
52558
- Parameters
52559
- ----------
52560
- heat_exchanger : str
52561
- 'heat_exchanger' child.
52562
- fluid_zone : str
52563
- 'fluid_zone' child.
52564
- boundary_zone : str
52565
- 'boundary_zone' child.
52566
- report_type : str
52567
- 'report_type' child.
52568
- write_to_file : bool
52569
- 'write_to_file' child.
52570
- file_name : str
52571
- 'file_name' child.
52572
- append_file : bool
52573
- 'append_file' child.
52574
- overwrite : bool
52575
- 'overwrite' child.
52576
52142
  """
52577
52143
  version = '232'
52578
52144
  fluent_name = 'inlet-temperature'
@@ -52593,25 +52159,6 @@ class inlet_temperature(Command):
52593
52159
  class outlet_temperature(Command):
52594
52160
  """
52595
52161
  'outlet_temperature' command.
52596
-
52597
- Parameters
52598
- ----------
52599
- heat_exchanger : str
52600
- 'heat_exchanger' child.
52601
- fluid_zone : str
52602
- 'fluid_zone' child.
52603
- boundary_zone : str
52604
- 'boundary_zone' child.
52605
- report_type : str
52606
- 'report_type' child.
52607
- write_to_file : bool
52608
- 'write_to_file' child.
52609
- file_name : str
52610
- 'file_name' child.
52611
- append_file : bool
52612
- 'append_file' child.
52613
- overwrite : bool
52614
- 'overwrite' child.
52615
52162
  """
52616
52163
  version = '232'
52617
52164
  fluent_name = 'outlet-temperature'
@@ -52632,25 +52179,6 @@ class outlet_temperature(Command):
52632
52179
  class mass_flow_rate_1(Command):
52633
52180
  """
52634
52181
  'mass_flow_rate' command.
52635
-
52636
- Parameters
52637
- ----------
52638
- heat_exchanger : str
52639
- 'heat_exchanger' child.
52640
- fluid_zone : str
52641
- 'fluid_zone' child.
52642
- boundary_zone : str
52643
- 'boundary_zone' child.
52644
- report_type : str
52645
- 'report_type' child.
52646
- write_to_file : bool
52647
- 'write_to_file' child.
52648
- file_name : str
52649
- 'file_name' child.
52650
- append_file : bool
52651
- 'append_file' child.
52652
- overwrite : bool
52653
- 'overwrite' child.
52654
52182
  """
52655
52183
  version = '232'
52656
52184
  fluent_name = 'mass-flow-rate'
@@ -52671,25 +52199,6 @@ class mass_flow_rate_1(Command):
52671
52199
  class specific_heat_5(Command):
52672
52200
  """
52673
52201
  'specific_heat' command.
52674
-
52675
- Parameters
52676
- ----------
52677
- heat_exchanger : str
52678
- 'heat_exchanger' child.
52679
- fluid_zone : str
52680
- 'fluid_zone' child.
52681
- boundary_zone : str
52682
- 'boundary_zone' child.
52683
- report_type : str
52684
- 'report_type' child.
52685
- write_to_file : bool
52686
- 'write_to_file' child.
52687
- file_name : str
52688
- 'file_name' child.
52689
- append_file : bool
52690
- 'append_file' child.
52691
- overwrite : bool
52692
- 'overwrite' child.
52693
52202
  """
52694
52203
  version = '232'
52695
52204
  fluent_name = 'specific-heat'
@@ -52976,35 +52485,6 @@ class coord_val(Real):
52976
52485
  class forces(Command):
52977
52486
  """
52978
52487
  'forces' command.
52979
-
52980
- Parameters
52981
- ----------
52982
- options : str
52983
- 'options' child.
52984
- domain_val : str
52985
- 'domain_val' child.
52986
- all_wall_zones : bool
52987
- Select all wall zones available.
52988
- wall_thread_list : List
52989
- 'wall_thread_list' child.
52990
- direction_vector : List
52991
- 'direction_vector' child.
52992
- momentum_center : List
52993
- 'momentum_center' child.
52994
- momentum_axis : List
52995
- 'momentum_axis' child.
52996
- pressure_coordinate : str
52997
- 'pressure_coordinate' child.
52998
- coord_val : real
52999
- 'coord_val' child.
53000
- write_to_file : bool
53001
- 'write_to_file' child.
53002
- file_name : str
53003
- 'file_name' child.
53004
- append_data : bool
53005
- 'append_data' child.
53006
- overwrite : bool
53007
- 'overwrite' child.
53008
52488
  """
53009
52489
  version = '232'
53010
52490
  fluent_name = 'forces'
@@ -55214,13 +54694,6 @@ class compute_node(Integer):
55214
54694
  class kill_node(Command):
55215
54695
  """
55216
54696
  'kill_node' command.
55217
-
55218
- Parameters
55219
- ----------
55220
- compute_node : int
55221
- 'compute_node' child.
55222
- invalidate_case : bool
55223
- 'invalidate_case' child.
55224
54697
  """
55225
54698
  version = '232'
55226
54699
  fluent_name = 'kill-node'