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
@@ -826,68 +826,26 @@ class file(Group):
826
826
  def read(self, file_type: str, file_name: str, pdf_file_name: str, lightweight_setup: bool):
827
827
  """
828
828
  'read' command.
829
-
830
- Parameters
831
- ----------
832
- file_type : str
833
- 'file_type' child.
834
- file_name_1 : str
835
- 'file_name' child.
836
- pdf_file_name : str
837
- 'pdf_file_name' child.
838
- lightweight_setup : bool
839
- 'lightweight_setup' child.
840
829
  """
841
830
  def read_case(self, file_name: str, pdf_file_name: str):
842
831
  """
843
832
  'read_case' command.
844
-
845
- Parameters
846
- ----------
847
- file_name_1 : str
848
- 'file_name' child.
849
- pdf_file_name : str
850
- 'pdf_file_name' child.
851
833
  """
852
834
  def read_case_data(self, file_name: str, pdf_file_name: str):
853
835
  """
854
836
  'read_case_data' command.
855
-
856
- Parameters
857
- ----------
858
- file_name_1 : str
859
- 'file_name' child.
860
- pdf_file_name : str
861
- 'pdf_file_name' child.
862
837
  """
863
838
  def read_case_setting(self, file_name: str, pdf_file_name: str):
864
839
  """
865
840
  'read_case_setting' command.
866
-
867
- Parameters
868
- ----------
869
- file_name_1 : str
870
- 'file_name' child.
871
- pdf_file_name : str
872
- 'pdf_file_name' child.
873
841
  """
874
842
  def read_data(self, file_name: str):
875
843
  """
876
844
  'read_data' command.
877
-
878
- Parameters
879
- ----------
880
- file_name_1 : str
881
- 'file_name' child.
882
845
  """
883
846
  def read_mesh(self, file_name: str):
884
847
  """
885
848
  'read_mesh' command.
886
-
887
- Parameters
888
- ----------
889
- file_name_1 : str
890
- 'file_name' child.
891
849
  """
892
850
  def read_surface_mesh(self, filename: str, unit: str):
893
851
  """
@@ -934,49 +892,22 @@ class file(Group):
934
892
  def replace_mesh(self, file_name: str):
935
893
  """
936
894
  'replace_mesh' command.
937
-
938
- Parameters
939
- ----------
940
- file_name_1 : str
941
- 'file_name' child.
942
895
  """
943
896
  def write(self, file_type: str, file_name: str):
944
897
  """
945
898
  'write' command.
946
-
947
- Parameters
948
- ----------
949
- file_type : str
950
- 'file_type' child.
951
- file_name : str
952
- 'file_name' child.
953
899
  """
954
900
  def write_case(self, file_name: str):
955
901
  """
956
902
  'write_case' command.
957
-
958
- Parameters
959
- ----------
960
- file_name : str
961
- 'file_name' child.
962
903
  """
963
904
  def write_data(self, file_name: str):
964
905
  """
965
906
  'write_data' command.
966
-
967
- Parameters
968
- ----------
969
- file_name : str
970
- 'file_name' child.
971
907
  """
972
908
  def write_case_data(self, file_name: str):
973
909
  """
974
910
  'write_case_data' command.
975
-
976
- Parameters
977
- ----------
978
- file_name : str
979
- 'file_name' child.
980
911
  """
981
912
  def read_settings(self, file_name: str):
982
913
  """
@@ -1949,15 +1880,6 @@ class polyhedra(Group):
1949
1880
  def convert_skewed_cells(self, cell_thread_list: list[str], max_cell_skewness: float | str, convert_skewed_cells: bool):
1950
1881
  """
1951
1882
  'convert_skewed_cells' command.
1952
-
1953
- Parameters
1954
- ----------
1955
- cell_thread_list : List
1956
- Set zones where cells should be converted.
1957
- max_cell_skewness : real
1958
- Set target maximum cell skewness.
1959
- convert_skewed_cells : bool
1960
- 'convert_skewed_cells' child.
1961
1883
  """
1962
1884
  class wall_distance_method(String, AllowedValuesMixin):
1963
1885
  version: str
@@ -2023,15 +1945,6 @@ class mesh(Group):
2023
1945
  def scale(self, x_scale: float | str, y_scale: float | str, z_scale: float | str):
2024
1946
  """
2025
1947
  'scale' command.
2026
-
2027
- Parameters
2028
- ----------
2029
- x_scale : real
2030
- 'x_scale' child.
2031
- y_scale : real
2032
- 'y_scale' child.
2033
- z_scale : real
2034
- 'z_scale' child.
2035
1948
  """
2036
1949
  def size_info(self):
2037
1950
  """
@@ -9060,20 +8973,10 @@ class u_table(Group):
9060
8973
  def write_table(self, file_name: str):
9061
8974
  """
9062
8975
  2D table writting command.
9063
-
9064
- Parameters
9065
- ----------
9066
- file_name : str
9067
- File name in 2D table writting.
9068
8976
  """
9069
8977
  def read_table(self, file_name: str):
9070
8978
  """
9071
8979
  2D table reading command.
9072
-
9073
- Parameters
9074
- ----------
9075
- file_name_1 : str
9076
- File name in 2D table reading.
9077
8980
  """
9078
8981
  def print_table(self):
9079
8982
  """
@@ -9097,20 +9000,10 @@ class y_table(Group):
9097
9000
  def write_table(self, file_name: str):
9098
9001
  """
9099
9002
  2D table writting command.
9100
-
9101
- Parameters
9102
- ----------
9103
- file_name : str
9104
- File name in 2D table writting.
9105
9003
  """
9106
9004
  def read_table(self, file_name: str):
9107
9005
  """
9108
9006
  2D table reading command.
9109
-
9110
- Parameters
9111
- ----------
9112
- file_name_1 : str
9113
- File name in 2D table reading.
9114
9007
  """
9115
9008
  def print_table(self):
9116
9009
  """
@@ -9156,20 +9049,10 @@ class internal_resistance_table(ListObject[internal_resistance_table_child]):
9156
9049
  def write_table(self, file_name: str):
9157
9050
  """
9158
9051
  Writing 3D table command.
9159
-
9160
- Parameters
9161
- ----------
9162
- file_name : str
9163
- Set file name in the 3D table-writing command.
9164
9052
  """
9165
9053
  def read_table(self, file_name: str):
9166
9054
  """
9167
9055
  3D Reading table command.
9168
-
9169
- Parameters
9170
- ----------
9171
- file_name_1 : str
9172
- Set file name in the 3D table-reading command.
9173
9056
  """
9174
9057
  def print_table(self):
9175
9058
  """
@@ -9224,20 +9107,10 @@ class limit_current_table(ListObject[limit_current_table_child]):
9224
9107
  def write_table(self, file_name: str):
9225
9108
  """
9226
9109
  Writing 3D table command.
9227
-
9228
- Parameters
9229
- ----------
9230
- file_name : str
9231
- Set file name in the 3D table-writing command.
9232
9110
  """
9233
9111
  def read_table(self, file_name: str):
9234
9112
  """
9235
9113
  3D Reading table command.
9236
-
9237
- Parameters
9238
- ----------
9239
- file_name_1 : str
9240
- Set file name in the 3D table-reading command.
9241
9114
  """
9242
9115
  def print_table(self):
9243
9116
  """
@@ -9412,20 +9285,10 @@ class table_rs(Group):
9412
9285
  def write_table(self, file_name: str):
9413
9286
  """
9414
9287
  2D table writting command.
9415
-
9416
- Parameters
9417
- ----------
9418
- file_name : str
9419
- File name in 2D table writting.
9420
9288
  """
9421
9289
  def read_table(self, file_name: str):
9422
9290
  """
9423
9291
  2D table reading command.
9424
-
9425
- Parameters
9426
- ----------
9427
- file_name_1 : str
9428
- File name in 2D table reading.
9429
9292
  """
9430
9293
  def print_table(self):
9431
9294
  """
@@ -9449,20 +9312,10 @@ class table_r1(Group):
9449
9312
  def write_table(self, file_name: str):
9450
9313
  """
9451
9314
  2D table writting command.
9452
-
9453
- Parameters
9454
- ----------
9455
- file_name : str
9456
- File name in 2D table writting.
9457
9315
  """
9458
9316
  def read_table(self, file_name: str):
9459
9317
  """
9460
9318
  2D table reading command.
9461
-
9462
- Parameters
9463
- ----------
9464
- file_name_1 : str
9465
- File name in 2D table reading.
9466
9319
  """
9467
9320
  def print_table(self):
9468
9321
  """
@@ -9486,20 +9339,10 @@ class table_c1(Group):
9486
9339
  def write_table(self, file_name: str):
9487
9340
  """
9488
9341
  2D table writting command.
9489
-
9490
- Parameters
9491
- ----------
9492
- file_name : str
9493
- File name in 2D table writting.
9494
9342
  """
9495
9343
  def read_table(self, file_name: str):
9496
9344
  """
9497
9345
  2D table reading command.
9498
-
9499
- Parameters
9500
- ----------
9501
- file_name_1 : str
9502
- File name in 2D table reading.
9503
9346
  """
9504
9347
  def print_table(self):
9505
9348
  """
@@ -9523,20 +9366,10 @@ class table_r2(Group):
9523
9366
  def write_table(self, file_name: str):
9524
9367
  """
9525
9368
  2D table writting command.
9526
-
9527
- Parameters
9528
- ----------
9529
- file_name : str
9530
- File name in 2D table writting.
9531
9369
  """
9532
9370
  def read_table(self, file_name: str):
9533
9371
  """
9534
9372
  2D table reading command.
9535
-
9536
- Parameters
9537
- ----------
9538
- file_name_1 : str
9539
- File name in 2D table reading.
9540
9373
  """
9541
9374
  def print_table(self):
9542
9375
  """
@@ -9560,20 +9393,10 @@ class table_c2(Group):
9560
9393
  def write_table(self, file_name: str):
9561
9394
  """
9562
9395
  2D table writting command.
9563
-
9564
- Parameters
9565
- ----------
9566
- file_name : str
9567
- File name in 2D table writting.
9568
9396
  """
9569
9397
  def read_table(self, file_name: str):
9570
9398
  """
9571
9399
  2D table reading command.
9572
-
9573
- Parameters
9574
- ----------
9575
- file_name_1 : str
9576
- File name in 2D table reading.
9577
9400
  """
9578
9401
  def print_table(self):
9579
9402
  """
@@ -9597,20 +9420,10 @@ class table_r3(Group):
9597
9420
  def write_table(self, file_name: str):
9598
9421
  """
9599
9422
  2D table writting command.
9600
-
9601
- Parameters
9602
- ----------
9603
- file_name : str
9604
- File name in 2D table writting.
9605
9423
  """
9606
9424
  def read_table(self, file_name: str):
9607
9425
  """
9608
9426
  2D table reading command.
9609
-
9610
- Parameters
9611
- ----------
9612
- file_name_1 : str
9613
- File name in 2D table reading.
9614
9427
  """
9615
9428
  def print_table(self):
9616
9429
  """
@@ -9634,20 +9447,10 @@ class table_c3(Group):
9634
9447
  def write_table(self, file_name: str):
9635
9448
  """
9636
9449
  2D table writting command.
9637
-
9638
- Parameters
9639
- ----------
9640
- file_name : str
9641
- File name in 2D table writting.
9642
9450
  """
9643
9451
  def read_table(self, file_name: str):
9644
9452
  """
9645
9453
  2D table reading command.
9646
-
9647
- Parameters
9648
- ----------
9649
- file_name_1 : str
9650
- File name in 2D table reading.
9651
9454
  """
9652
9455
  def print_table(self):
9653
9456
  """
@@ -9671,20 +9474,10 @@ class table_voc(Group):
9671
9474
  def write_table(self, file_name: str):
9672
9475
  """
9673
9476
  2D table writting command.
9674
-
9675
- Parameters
9676
- ----------
9677
- file_name : str
9678
- File name in 2D table writting.
9679
9477
  """
9680
9478
  def read_table(self, file_name: str):
9681
9479
  """
9682
9480
  2D table reading command.
9683
-
9684
- Parameters
9685
- ----------
9686
- file_name_1 : str
9687
- File name in 2D table reading.
9688
9481
  """
9689
9482
  def print_table(self):
9690
9483
  """
@@ -9708,20 +9501,10 @@ class table_rs_c(Group):
9708
9501
  def write_table(self, file_name: str):
9709
9502
  """
9710
9503
  2D table writting command.
9711
-
9712
- Parameters
9713
- ----------
9714
- file_name : str
9715
- File name in 2D table writting.
9716
9504
  """
9717
9505
  def read_table(self, file_name: str):
9718
9506
  """
9719
9507
  2D table reading command.
9720
-
9721
- Parameters
9722
- ----------
9723
- file_name_1 : str
9724
- File name in 2D table reading.
9725
9508
  """
9726
9509
  def print_table(self):
9727
9510
  """
@@ -9745,20 +9528,10 @@ class table_r1_c(Group):
9745
9528
  def write_table(self, file_name: str):
9746
9529
  """
9747
9530
  2D table writting command.
9748
-
9749
- Parameters
9750
- ----------
9751
- file_name : str
9752
- File name in 2D table writting.
9753
9531
  """
9754
9532
  def read_table(self, file_name: str):
9755
9533
  """
9756
9534
  2D table reading command.
9757
-
9758
- Parameters
9759
- ----------
9760
- file_name_1 : str
9761
- File name in 2D table reading.
9762
9535
  """
9763
9536
  def print_table(self):
9764
9537
  """
@@ -9782,20 +9555,10 @@ class table_c1_c(Group):
9782
9555
  def write_table(self, file_name: str):
9783
9556
  """
9784
9557
  2D table writting command.
9785
-
9786
- Parameters
9787
- ----------
9788
- file_name : str
9789
- File name in 2D table writting.
9790
9558
  """
9791
9559
  def read_table(self, file_name: str):
9792
9560
  """
9793
9561
  2D table reading command.
9794
-
9795
- Parameters
9796
- ----------
9797
- file_name_1 : str
9798
- File name in 2D table reading.
9799
9562
  """
9800
9563
  def print_table(self):
9801
9564
  """
@@ -9819,20 +9582,10 @@ class table_r2_c(Group):
9819
9582
  def write_table(self, file_name: str):
9820
9583
  """
9821
9584
  2D table writting command.
9822
-
9823
- Parameters
9824
- ----------
9825
- file_name : str
9826
- File name in 2D table writting.
9827
9585
  """
9828
9586
  def read_table(self, file_name: str):
9829
9587
  """
9830
9588
  2D table reading command.
9831
-
9832
- Parameters
9833
- ----------
9834
- file_name_1 : str
9835
- File name in 2D table reading.
9836
9589
  """
9837
9590
  def print_table(self):
9838
9591
  """
@@ -9856,20 +9609,10 @@ class table_c2_c(Group):
9856
9609
  def write_table(self, file_name: str):
9857
9610
  """
9858
9611
  2D table writting command.
9859
-
9860
- Parameters
9861
- ----------
9862
- file_name : str
9863
- File name in 2D table writting.
9864
9612
  """
9865
9613
  def read_table(self, file_name: str):
9866
9614
  """
9867
9615
  2D table reading command.
9868
-
9869
- Parameters
9870
- ----------
9871
- file_name_1 : str
9872
- File name in 2D table reading.
9873
9616
  """
9874
9617
  def print_table(self):
9875
9618
  """
@@ -9893,20 +9636,10 @@ class table_r3_c(Group):
9893
9636
  def write_table(self, file_name: str):
9894
9637
  """
9895
9638
  2D table writting command.
9896
-
9897
- Parameters
9898
- ----------
9899
- file_name : str
9900
- File name in 2D table writting.
9901
9639
  """
9902
9640
  def read_table(self, file_name: str):
9903
9641
  """
9904
9642
  2D table reading command.
9905
-
9906
- Parameters
9907
- ----------
9908
- file_name_1 : str
9909
- File name in 2D table reading.
9910
9643
  """
9911
9644
  def print_table(self):
9912
9645
  """
@@ -9930,20 +9663,10 @@ class table_c3_c(Group):
9930
9663
  def write_table(self, file_name: str):
9931
9664
  """
9932
9665
  2D table writting command.
9933
-
9934
- Parameters
9935
- ----------
9936
- file_name : str
9937
- File name in 2D table writting.
9938
9666
  """
9939
9667
  def read_table(self, file_name: str):
9940
9668
  """
9941
9669
  2D table reading command.
9942
-
9943
- Parameters
9944
- ----------
9945
- file_name_1 : str
9946
- File name in 2D table reading.
9947
9670
  """
9948
9671
  def print_table(self):
9949
9672
  """
@@ -9967,20 +9690,10 @@ class table_voc_c(Group):
9967
9690
  def write_table(self, file_name: str):
9968
9691
  """
9969
9692
  2D table writting command.
9970
-
9971
- Parameters
9972
- ----------
9973
- file_name : str
9974
- File name in 2D table writting.
9975
9693
  """
9976
9694
  def read_table(self, file_name: str):
9977
9695
  """
9978
9696
  2D table reading command.
9979
-
9980
- Parameters
9981
- ----------
9982
- file_name_1 : str
9983
- File name in 2D table reading.
9984
9697
  """
9985
9698
  def print_table(self):
9986
9699
  """
@@ -10753,20 +10466,10 @@ class fast_charging_table(ListObject[fast_charging_table_child]):
10753
10466
  def write_table(self, file_name: str):
10754
10467
  """
10755
10468
  Writing 3D table command.
10756
-
10757
- Parameters
10758
- ----------
10759
- file_name : str
10760
- Set file name in the 3D table-writing command.
10761
10469
  """
10762
10470
  def read_table(self, file_name: str):
10763
10471
  """
10764
10472
  3D Reading table command.
10765
-
10766
- Parameters
10767
- ----------
10768
- file_name_1 : str
10769
- Set file name in the 3D table-reading command.
10770
10473
  """
10771
10474
  def print_table(self):
10772
10475
  """
@@ -10877,20 +10580,10 @@ class heat_correct_table(Group):
10877
10580
  def write_table(self, file_name: str):
10878
10581
  """
10879
10582
  2D table writting command.
10880
-
10881
- Parameters
10882
- ----------
10883
- file_name : str
10884
- File name in 2D table writting.
10885
10583
  """
10886
10584
  def read_table(self, file_name: str):
10887
10585
  """
10888
10586
  2D table reading command.
10889
-
10890
- Parameters
10891
- ----------
10892
- file_name_1 : str
10893
- File name in 2D table reading.
10894
10587
  """
10895
10588
  def print_table(self):
10896
10589
  """
@@ -10926,20 +10619,10 @@ class table_discharge(Group):
10926
10619
  def write_table(self, file_name: str):
10927
10620
  """
10928
10621
  2D table writting command.
10929
-
10930
- Parameters
10931
- ----------
10932
- file_name : str
10933
- File name in 2D table writting.
10934
10622
  """
10935
10623
  def read_table(self, file_name: str):
10936
10624
  """
10937
10625
  2D table reading command.
10938
-
10939
- Parameters
10940
- ----------
10941
- file_name_1 : str
10942
- File name in 2D table reading.
10943
10626
  """
10944
10627
  def print_table(self):
10945
10628
  """
@@ -10963,20 +10646,10 @@ class table_charge(Group):
10963
10646
  def write_table(self, file_name: str):
10964
10647
  """
10965
10648
  2D table writting command.
10966
-
10967
- Parameters
10968
- ----------
10969
- file_name : str
10970
- File name in 2D table writting.
10971
10649
  """
10972
10650
  def read_table(self, file_name: str):
10973
10651
  """
10974
10652
  2D table reading command.
10975
-
10976
- Parameters
10977
- ----------
10978
- file_name_1 : str
10979
- File name in 2D table reading.
10980
10653
  """
10981
10654
  def print_table(self):
10982
10655
  """
@@ -11216,20 +10889,10 @@ class rate_table(Group):
11216
10889
  def write_table(self, file_name: str):
11217
10890
  """
11218
10891
  2D table writting command.
11219
-
11220
- Parameters
11221
- ----------
11222
- file_name : str
11223
- File name in 2D table writting.
11224
10892
  """
11225
10893
  def read_table(self, file_name: str):
11226
10894
  """
11227
10895
  2D table reading command.
11228
-
11229
- Parameters
11230
- ----------
11231
- file_name_1 : str
11232
- File name in 2D table reading.
11233
10896
  """
11234
10897
  def print_table(self):
11235
10898
  """
@@ -11471,20 +11134,10 @@ class capacity_fade_table(Group):
11471
11134
  def write_table(self, file_name: str):
11472
11135
  """
11473
11136
  2D table writting command.
11474
-
11475
- Parameters
11476
- ----------
11477
- file_name : str
11478
- File name in 2D table writting.
11479
11137
  """
11480
11138
  def read_table(self, file_name: str):
11481
11139
  """
11482
11140
  2D table reading command.
11483
-
11484
- Parameters
11485
- ----------
11486
- file_name_1 : str
11487
- File name in 2D table reading.
11488
11141
  """
11489
11142
  def print_table(self):
11490
11143
  """
@@ -11556,20 +11209,10 @@ class cycle_life_table(Group):
11556
11209
  def write_table(self, file_name: str):
11557
11210
  """
11558
11211
  2D table writting command.
11559
-
11560
- Parameters
11561
- ----------
11562
- file_name : str
11563
- File name in 2D table writting.
11564
11212
  """
11565
11213
  def read_table(self, file_name: str):
11566
11214
  """
11567
11215
  2D table reading command.
11568
-
11569
- Parameters
11570
- ----------
11571
- file_name_1 : str
11572
- File name in 2D table reading.
11573
11216
  """
11574
11217
  def print_table(self):
11575
11218
  """
@@ -12279,21 +11922,6 @@ class rom_data_creator_tool(Group):
12279
11922
  def add_rom_parameter(self, parameter_type: str, entity_list: list[str], group_value: float | str, individual_or_group: bool, individual_value: bool, value_list: list[float | str]):
12280
11923
  """
12281
11924
  Add parameter command.
12282
-
12283
- Parameters
12284
- ----------
12285
- parameter_type : str
12286
- Set parameter type.
12287
- entity_list : List
12288
- Entity list name.
12289
- group_value : real
12290
- Set group value.
12291
- individual_or_group : bool
12292
- Set as-group option.
12293
- individual_value : bool
12294
- Set individual value for different entities in the group.
12295
- value_list : List
12296
- Set values for the different entities in the group.
12297
11925
  """
12298
11926
  def rom_data_creator(self, rom_type: int):
12299
11927
  """
@@ -33826,11 +33454,6 @@ class perforated_wall(Group):
33826
33454
  def read_input_file(self, file_name: str):
33827
33455
  """
33828
33456
  'read_input_file' command.
33829
-
33830
- Parameters
33831
- ----------
33832
- file_name : str
33833
- 'file_name' child.
33834
33457
  """
33835
33458
  class degassing_verbosity(Integer, AllowedValuesMixin):
33836
33459
  version: str
@@ -35033,15 +34656,6 @@ class reference_values(Group):
35033
34656
  def compute(self, from_zone_type: str, from_zone_name: str, phase: str):
35034
34657
  """
35035
34658
  'compute' command.
35036
-
35037
- Parameters
35038
- ----------
35039
- from_zone_type : str
35040
- 'from_zone_type' child.
35041
- from_zone_name : str
35042
- 'from_zone_name' child.
35043
- phase : str
35044
- 'phase' child.
35045
34659
  """
35046
34660
  def list_values(self):
35047
34661
  """
@@ -35403,11 +35017,6 @@ class named_expressions(NamedObject[named_expressions_child]):
35403
35017
  def compute(self, names: list[str]):
35404
35018
  """
35405
35019
  'compute' command.
35406
-
35407
- Parameters
35408
- ----------
35409
- names : List
35410
- 'names' child.
35411
35020
  """
35412
35021
  child_object_type: named_expressions_child
35413
35022
  class enabled_54(Boolean):
@@ -35624,11 +35233,6 @@ class faces(NamedObject[faces_child]):
35624
35233
  def list_face(self, face_name: str):
35625
35234
  """
35626
35235
  'list_face' command.
35627
-
35628
- Parameters
35629
- ----------
35630
- face_name : str
35631
- 'face_name' child.
35632
35236
  """
35633
35237
  child_object_type: faces_child
35634
35238
  class bodies_child(Group):
@@ -40740,28 +40344,10 @@ class profiles(Group):
40740
40344
  def display_profile_surface(self, profile_name: str, field_contour: bool, field_variable: str):
40741
40345
  """
40742
40346
  Display Profile Surface/field rendering command.
40743
-
40744
- Parameters
40745
- ----------
40746
- profile_name : str
40747
- Profile name.
40748
- field_contour : bool
40749
- Field contour?.
40750
- field_variable : str
40751
- Field variable.
40752
40347
  """
40753
40348
  def set_preference_profile_point_cloud_data(self, profile_point_marker: str, profile_point_marker_size: float | str, profile_point_marker_color: str):
40754
40349
  """
40755
40350
  Profile Point attributes command.
40756
-
40757
- Parameters
40758
- ----------
40759
- profile_point_marker : str
40760
- Profile point marker.
40761
- profile_point_marker_size : real
40762
- Profile point marker size.
40763
- profile_point_marker_color : str
40764
- Profile point marker color.
40765
40351
  """
40766
40352
  def overlay_profile_point_cloud_data(self, overlay: bool, profile_name: str, graphics_object: str, display_contour: bool, field_variable: str):
40767
40353
  """
@@ -40804,38 +40390,18 @@ class profiles(Group):
40804
40390
  def list_profile_parameters(self, profile_name: str):
40805
40391
  """
40806
40392
  List-profile-parameters-command.
40807
-
40808
- Parameters
40809
- ----------
40810
- profile_name : str
40811
- Profile name.
40812
40393
  """
40813
40394
  def list_profile_parameters_with_value(self, profile_name: str):
40814
40395
  """
40815
40396
  List-profile-parameters-with-value-command.
40816
-
40817
- Parameters
40818
- ----------
40819
- profile_name : str
40820
- Profile name.
40821
40397
  """
40822
40398
  def list_profile_fields(self, profile_name: str):
40823
40399
  """
40824
40400
  List-profile-fields-command.
40825
-
40826
- Parameters
40827
- ----------
40828
- profile_name : str
40829
- Profile name.
40830
40401
  """
40831
40402
  def delete(self, profile_name: str):
40832
40403
  """
40833
40404
  Delete-profile-command.
40834
-
40835
- Parameters
40836
- ----------
40837
- profile_name : str
40838
- Profile name.
40839
40405
  """
40840
40406
  def delete_all(self):
40841
40407
  """
@@ -47587,58 +47153,26 @@ class execute_commands(Group):
47587
47153
  def enable(self, command_name: str):
47588
47154
  """
47589
47155
  Enable an execute-command.
47590
-
47591
- Parameters
47592
- ----------
47593
- command_name : str
47594
- 'command_name' child.
47595
47156
  """
47596
47157
  def disable(self, command_name: str):
47597
47158
  """
47598
47159
  Disable an execute-command.
47599
-
47600
- Parameters
47601
- ----------
47602
- command_name : str
47603
- 'command_name' child.
47604
47160
  """
47605
47161
  def copy(self, command_name: str):
47606
47162
  """
47607
47163
  Copy an execute-command.
47608
-
47609
- Parameters
47610
- ----------
47611
- command_name : str
47612
- 'command_name' child.
47613
47164
  """
47614
47165
  def delete(self, command_name: str):
47615
47166
  """
47616
47167
  Delete an execute-command.
47617
-
47618
- Parameters
47619
- ----------
47620
- command_name : str
47621
- 'command_name' child.
47622
47168
  """
47623
47169
  def export(self, command_name: list[str], tsv_file_name: str):
47624
47170
  """
47625
47171
  Export execute-commands to a TSV file.
47626
-
47627
- Parameters
47628
- ----------
47629
- command_name : List
47630
- 'command_name' child.
47631
- tsv_file_name : str
47632
- 'tsv_file_name' child.
47633
47172
  """
47634
47173
  def import_(self, tsv_file_name: str):
47635
47174
  """
47636
47175
  Import execute-commands from a TSV file.
47637
-
47638
- Parameters
47639
- ----------
47640
- tsv_file_name_1 : str
47641
- 'tsv_file_name' child.
47642
47176
  """
47643
47177
  class name_17(String):
47644
47178
  version: str
@@ -47970,27 +47504,6 @@ class case_modification(Group):
47970
47504
  def add_edit_modification(self, mod_name: str, mod_exists: bool, mod_active: bool, mod_execution_option: str, mod_iterations: int, mod_timesteps: int, mod_flowtime: float | str, mod_python: bool, mod_command: str):
47971
47505
  """
47972
47506
  Define a single case modification.
47973
-
47974
- Parameters
47975
- ----------
47976
- mod_name : str
47977
- Name of Modification.
47978
- mod_exists : bool
47979
- Modification Exists?.
47980
- mod_active : bool
47981
- Modification is Active?.
47982
- mod_execution_option : str
47983
- Execution Option for Transient.
47984
- mod_iterations : int
47985
- Modification Iterations.
47986
- mod_timesteps : int
47987
- Modification Time Steps.
47988
- mod_flowtime : real
47989
- Modification Flow Time.
47990
- mod_python : bool
47991
- Modification is Python?.
47992
- mod_command : str
47993
- Modification.
47994
47507
  """
47995
47508
  def copy_modification(self, mod_name: str):
47996
47509
  """
@@ -48040,13 +47553,6 @@ class case_modification(Group):
48040
47553
  def export_modifications(self, command_list: list[str], filename: str):
48041
47554
  """
48042
47555
  Export all case modifications to a tsv file.
48043
-
48044
- Parameters
48045
- ----------
48046
- command_list : List
48047
- 'command_list' child.
48048
- filename_1 : str
48049
- 'filename' child.
48050
47556
  """
48051
47557
  def continue_strategy_execution(self):
48052
47558
  """
@@ -54047,11 +53553,6 @@ class picture(Group):
54047
53553
  def save_picture(self, file_name: str):
54048
53554
  """
54049
53555
  'save_picture' command.
54050
-
54051
- Parameters
54052
- ----------
54053
- file_name : str
54054
- 'file_name' child.
54055
53556
  """
54056
53557
  def list_color_mode(self):
54057
53558
  """
@@ -54295,11 +53796,6 @@ class display_states(NamedObject[display_states_child]):
54295
53796
  def use_active(self, state_name: str):
54296
53797
  """
54297
53798
  'use_active' command.
54298
-
54299
- Parameters
54300
- ----------
54301
- state_name : str
54302
- 'state_name' child.
54303
53799
  """
54304
53800
  def restore_state(self, state_name: str):
54305
53801
  """
@@ -55086,15 +54582,6 @@ class pulse(Group):
55086
54582
  def write(self, object_name: str, write_format: str, file_name: str):
55087
54583
  """
55088
54584
  'write' command.
55089
-
55090
- Parameters
55091
- ----------
55092
- object_name : str
55093
- 'object_name' child.
55094
- write_format : str
55095
- 'write_format' child.
55096
- file_name : str
55097
- 'file_name' child.
55098
54585
  """
55099
54586
  class periodic_type(String, AllowedValuesMixin):
55100
54587
  version: str
@@ -56252,11 +55739,6 @@ class scene_animation(Group):
56252
55739
  def read_animation(self, file_name: str):
56253
55740
  """
56254
55741
  'read_animation' command.
56255
-
56256
- Parameters
56257
- ----------
56258
- file_name_1 : str
56259
- 'file_name' child.
56260
55742
  """
56261
55743
  def write_animation(self, format_name: str, file_name: str):
56262
55744
  """
@@ -56518,36 +56000,10 @@ class plot_write_sample(Group):
56518
56000
  def plot_sample(self, sample: str, variable_to_sample: str, weighting_variable: str, correlation_variable: str, file_name: str):
56519
56001
  """
56520
56002
  'plot_sample' command.
56521
-
56522
- Parameters
56523
- ----------
56524
- sample : str
56525
- 'sample' child.
56526
- variable_to_sample : str
56527
- 'variable_to_sample' child.
56528
- weighting_variable : str
56529
- 'weighting_variable' child.
56530
- correlation_variable : str
56531
- 'correlation_variable' child.
56532
- file_name : str
56533
- 'file_name' child.
56534
56003
  """
56535
56004
  def write_sample(self, sample: str, variable_to_sample: str, weighting_variable: str, correlation_variable: str, file_name: str):
56536
56005
  """
56537
56006
  'write_sample' command.
56538
-
56539
- Parameters
56540
- ----------
56541
- sample : str
56542
- 'sample' child.
56543
- variable_to_sample : str
56544
- 'variable_to_sample' child.
56545
- weighting_variable : str
56546
- 'weighting_variable' child.
56547
- correlation_variable : str
56548
- 'correlation_variable' child.
56549
- file_name : str
56550
- 'file_name' child.
56551
56007
  """
56552
56008
  class use_weighting(Boolean):
56553
56009
  version: str
@@ -56601,13 +56057,6 @@ class setup_reduction(Group):
56601
56057
  def set_maximum(self, sample_var: str, max_val: float | str):
56602
56058
  """
56603
56059
  'set_maximum' command.
56604
-
56605
- Parameters
56606
- ----------
56607
- sample_var : str
56608
- 'sample_var' child.
56609
- max_val : real
56610
- 'max_val' child.
56611
56060
  """
56612
56061
  def use_logarithmic(self, sample_var: str, enable_log: bool):
56613
56062
  """
@@ -56697,11 +56146,6 @@ class histogram_1(Group):
56697
56146
  def delete_sample(self, sample: str):
56698
56147
  """
56699
56148
  'delete_sample' command.
56700
-
56701
- Parameters
56702
- ----------
56703
- sample : str
56704
- 'sample' child.
56705
56149
  """
56706
56150
  def list_samples(self):
56707
56151
  """
@@ -56746,44 +56190,10 @@ class sample_trajectories(Group):
56746
56190
  def compute(self, injections: list[str], boundaries: list[str], lines: list[str], planes: list[str], op_udf: str, append_sample: bool, accumulate_rates: bool):
56747
56191
  """
56748
56192
  'compute' command.
56749
-
56750
- Parameters
56751
- ----------
56752
- injections : List
56753
- 'injections' child.
56754
- boundaries : List
56755
- 'boundaries' child.
56756
- lines : List
56757
- Select surface.
56758
- planes : List
56759
- Select surface.
56760
- op_udf : str
56761
- 'op_udf' child.
56762
- append_sample : bool
56763
- 'append_sample' child.
56764
- accumulate_rates : bool
56765
- 'accumulate_rates' child.
56766
56193
  """
56767
56194
  def start_file_write(self, injections: list[str], boundaries: list[str], lines: list[str], planes: list[str], op_udf: str, append_sample: bool, accumulate_rates: bool):
56768
56195
  """
56769
56196
  'start_file_write' command.
56770
-
56771
- Parameters
56772
- ----------
56773
- injections : List
56774
- 'injections' child.
56775
- boundaries : List
56776
- 'boundaries' child.
56777
- lines : List
56778
- Select surface.
56779
- planes : List
56780
- Select surface.
56781
- op_udf : str
56782
- 'op_udf' child.
56783
- append_sample : bool
56784
- 'append_sample' child.
56785
- accumulate_rates : bool
56786
- 'accumulate_rates' child.
56787
56197
  """
56788
56198
  def stop_file_write(self):
56789
56199
  """
@@ -56842,23 +56252,6 @@ class discrete_phase_6(Group):
56842
56252
  def set_per_injection_zone_summaries(self, enable: bool, reset_dpm_summaries: bool):
56843
56253
  """
56844
56254
  Enable per-injection per-zone DPM summary reports.
56845
-
56846
- Parameters
56847
- ----------
56848
- enable : bool
56849
- Specify whether to enable or disable the per-injection per-zone DPM summary reports.
56850
- Enabling them will mean that more memory will be used to hold the data being collected.
56851
- For unsteady tracking, if some data for DPM summary reports have already been collected,
56852
- they will continue to be shown just specific to the zone, not any injection, while
56853
- data collected in the future will be shown both zone- and injection-specific.
56854
- Disabling requires that both the current DPM summary report data are reset
56855
- and all particle parcels currently in the domain are cleared out(!).
56856
- reset_dpm_summaries : bool
56857
- Disabling the per-injection per-zone DPM summary reports requires that
56858
- both the current DPM summary report data are reset and all particle
56859
- parcels currently in the domain are cleared out(!).
56860
- Set this command argument / check this checkbox to
56861
- confirm that you want to proceed as described.
56862
56255
  """
56863
56256
  _child_aliases: dict
56864
56257
  class fluxes(Group):
@@ -58693,21 +58086,6 @@ class report_2(Group):
58693
58086
  def vbm(self, output_quantity: str, rotor_name: str, scale_output: bool, write_to_file: bool, file_name: str, append: bool):
58694
58087
  """
58695
58088
  'vbm' command.
58696
-
58697
- Parameters
58698
- ----------
58699
- output_quantity : str
58700
- 'output_quantity' child.
58701
- rotor_name : str
58702
- 'rotor_name' child.
58703
- scale_output : bool
58704
- 'scale_output' child.
58705
- write_to_file : bool
58706
- 'write_to_file' child.
58707
- file_name : str
58708
- 'file_name' child.
58709
- append : bool
58710
- 'append' child.
58711
58089
  """
58712
58090
  def get_forces(self, option: str, domain: str, wall_zones: list[str], direction_vector: list[float | str], momentum_center: list[float | str], momentum_axis: list[float | str], pressure_coordinate: str, coordinate_value: float | str):
58713
58091
  """
@@ -63572,13 +62950,6 @@ class network_2(Group):
63572
62950
  def kill_node(self, compute_node: int, invalidate_case: bool):
63573
62951
  """
63574
62952
  'kill_node' command.
63575
-
63576
- Parameters
63577
- ----------
63578
- compute_node : int
63579
- 'compute_node' child.
63580
- invalidate_case : bool
63581
- 'invalidate_case' child.
63582
62953
  """
63583
62954
  def spawn_node(self, hostname: str, username: str):
63584
62955
  """