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
@@ -501,13 +501,6 @@ class file_name_1(Filename):
501
501
  class read_1(Command):
502
502
  """
503
503
  'read' command.
504
-
505
- Parameters
506
- ----------
507
- file_type : str
508
- 'file_type' child.
509
- file_name : str
510
- 'file_name' child.
511
504
  """
512
505
  version = '231'
513
506
  fluent_name = 'read'
@@ -531,11 +524,6 @@ class report_each_line(Boolean):
531
524
  class chemkin_report_each_line(Command):
532
525
  """
533
526
  'chemkin_report_each_line' command.
534
-
535
- Parameters
536
- ----------
537
- report_each_line : bool
538
- Enable/disable reporting after reading each line.
539
527
  """
540
528
  version = '231'
541
529
  fluent_name = 'chemkin-report-each-line?'
@@ -916,17 +904,6 @@ class lightweight_setup(Boolean):
916
904
  class read(Command):
917
905
  """
918
906
  'read' command.
919
-
920
- Parameters
921
- ----------
922
- file_type : str
923
- 'file_type' child.
924
- file_name : str
925
- 'file_name' child.
926
- pdf_file_name : str
927
- 'pdf_file_name' child.
928
- lightweight_setup : bool
929
- 'lightweight_setup' child.
930
907
  """
931
908
  version = '231'
932
909
  fluent_name = 'read'
@@ -943,17 +920,6 @@ class read(Command):
943
920
  class read_case(Command):
944
921
  """
945
922
  'read_case' command.
946
-
947
- Parameters
948
- ----------
949
- file_type : str
950
- 'file_type' child.
951
- file_name : str
952
- 'file_name' child.
953
- pdf_file_name : str
954
- 'pdf_file_name' child.
955
- lightweight_setup : bool
956
- 'lightweight_setup' child.
957
923
  """
958
924
  version = '231'
959
925
  fluent_name = 'read-case'
@@ -970,17 +936,6 @@ class read_case(Command):
970
936
  class read_case_data(Command):
971
937
  """
972
938
  'read_case_data' command.
973
-
974
- Parameters
975
- ----------
976
- file_type : str
977
- 'file_type' child.
978
- file_name : str
979
- 'file_name' child.
980
- pdf_file_name : str
981
- 'pdf_file_name' child.
982
- lightweight_setup : bool
983
- 'lightweight_setup' child.
984
939
  """
985
940
  version = '231'
986
941
  fluent_name = 'read-case-data'
@@ -997,17 +952,6 @@ class read_case_data(Command):
997
952
  class read_case_setting(Command):
998
953
  """
999
954
  'read_case_setting' command.
1000
-
1001
- Parameters
1002
- ----------
1003
- file_type : str
1004
- 'file_type' child.
1005
- file_name : str
1006
- 'file_name' child.
1007
- pdf_file_name : str
1008
- 'pdf_file_name' child.
1009
- lightweight_setup : bool
1010
- 'lightweight_setup' child.
1011
955
  """
1012
956
  version = '231'
1013
957
  fluent_name = 'read-case-setting'
@@ -1024,17 +968,6 @@ class read_case_setting(Command):
1024
968
  class read_data(Command):
1025
969
  """
1026
970
  'read_data' command.
1027
-
1028
- Parameters
1029
- ----------
1030
- file_type : str
1031
- 'file_type' child.
1032
- file_name : str
1033
- 'file_name' child.
1034
- pdf_file_name : str
1035
- 'pdf_file_name' child.
1036
- lightweight_setup : bool
1037
- 'lightweight_setup' child.
1038
971
  """
1039
972
  version = '231'
1040
973
  fluent_name = 'read-data'
@@ -1051,17 +984,6 @@ class read_data(Command):
1051
984
  class read_mesh(Command):
1052
985
  """
1053
986
  'read_mesh' command.
1054
-
1055
- Parameters
1056
- ----------
1057
- file_type : str
1058
- 'file_type' child.
1059
- file_name : str
1060
- 'file_name' child.
1061
- pdf_file_name : str
1062
- 'pdf_file_name' child.
1063
- lightweight_setup : bool
1064
- 'lightweight_setup' child.
1065
987
  """
1066
988
  version = '231'
1067
989
  fluent_name = 'read-mesh'
@@ -1132,11 +1054,6 @@ class stop_journal(Command):
1132
1054
  class replace_mesh(Command):
1133
1055
  """
1134
1056
  'replace_mesh' command.
1135
-
1136
- Parameters
1137
- ----------
1138
- file_name : str
1139
- 'file_name' child.
1140
1057
  """
1141
1058
  version = '231'
1142
1059
  fluent_name = 'replace-mesh'
@@ -1150,13 +1067,6 @@ class replace_mesh(Command):
1150
1067
  class write(Command):
1151
1068
  """
1152
1069
  'write' command.
1153
-
1154
- Parameters
1155
- ----------
1156
- file_type : str
1157
- 'file_type' child.
1158
- file_name : str
1159
- 'file_name' child.
1160
1070
  """
1161
1071
  version = '231'
1162
1072
  fluent_name = 'write'
@@ -1999,15 +1909,6 @@ class convert_skewed_cells_1(Boolean):
1999
1909
  class convert_skewed_cells(Command):
2000
1910
  """
2001
1911
  'convert_skewed_cells' command.
2002
-
2003
- Parameters
2004
- ----------
2005
- cell_thread_list : List
2006
- Set zones where cells should be converted.
2007
- max_cell_skewness : real
2008
- Set target maximum cell skewness.
2009
- convert_skewed_cells : bool
2010
- 'convert_skewed_cells' child.
2011
1912
  """
2012
1913
  version = '231'
2013
1914
  fluent_name = 'convert-skewed-cells'
@@ -2077,11 +1978,6 @@ class print_level(Integer):
2077
1978
  class mesh_info(Command):
2078
1979
  """
2079
1980
  'mesh_info' command.
2080
-
2081
- Parameters
2082
- ----------
2083
- print_level : int
2084
- Print zone information size.
2085
1981
  """
2086
1982
  version = '231'
2087
1983
  fluent_name = 'mesh-info'
@@ -2182,15 +2078,6 @@ class z_scale(Real):
2182
2078
  class scale(Command):
2183
2079
  """
2184
2080
  'scale' command.
2185
-
2186
- Parameters
2187
- ----------
2188
- x_scale : real
2189
- 'x_scale' child.
2190
- y_scale : real
2191
- 'y_scale' child.
2192
- z_scale : real
2193
- 'z_scale' child.
2194
2081
  """
2195
2082
  version = '231'
2196
2083
  fluent_name = 'scale'
@@ -2449,13 +2336,6 @@ class port(Integer):
2449
2336
  class start(Command):
2450
2337
  """
2451
2338
  'start' command.
2452
-
2453
- Parameters
2454
- ----------
2455
- address : str
2456
- 'address' child.
2457
- port : int
2458
- 'port' child.
2459
2339
  """
2460
2340
  version = '231'
2461
2341
  fluent_name = 'start'
@@ -6915,19 +6795,6 @@ class avg_time_steps(Integer):
6915
6795
  class statistics_controls(Command):
6916
6796
  """
6917
6797
  'statistics_controls' command.
6918
-
6919
- Parameters
6920
- ----------
6921
- method : int
6922
- 'method' child.
6923
- samp_time_period : real
6924
- 'samp_time_period' child.
6925
- samp_time_steps : int
6926
- 'samp_time_steps' child.
6927
- avg_time_period : real
6928
- 'avg_time_period' child.
6929
- avg_time_steps : int
6930
- 'avg_time_steps' child.
6931
6798
  """
6932
6799
  version = '231'
6933
6800
  fluent_name = 'statistics-controls'
@@ -7069,12 +6936,10 @@ class rotor_speed(Real):
7069
6936
  class basic_info(Group):
7070
6937
  """
7071
6938
  Menu to define the rotor basic informations:
7072
-
7073
6939
  - Number of Blades
7074
6940
  - Tip Radius
7075
6941
  - Root Radius ,
7076
6942
  - Rotor Speed ,
7077
-
7078
6943
  For more details please consult the help option of the corresponding menu or TUI command.
7079
6944
  """
7080
6945
  version = '231'
@@ -7135,10 +7000,8 @@ class disk_origin(Group):
7135
7000
  class terminology(Integer):
7136
7001
  """
7137
7002
  Select Rotor Disk Orientation Terminology:
7138
-
7139
7003
  - Enter 0 if using Rotor Disk Angles
7140
7004
  - Enter 1 if using Rotor Disk Normal
7141
-
7142
7005
  For more details please consult the help option of the corresponding menu or TUI command.
7143
7006
  """
7144
7007
  version = '231'
@@ -7194,12 +7057,10 @@ class disk_bank_angle(Real):
7194
7057
  class disk_orientation(Group):
7195
7058
  """
7196
7059
  Menu to define the rotor disk orientation.
7197
-
7198
7060
  - terminology : the terminology to specify the rotor disk orientation: rotor-disk-angles / rotor-disk-normal,
7199
7061
  - disk-normal-x/yz : rotor-disk-normal components,
7200
7062
  - disk-pitch-angle : ,
7201
7063
  - disk-bank-angle : ,
7202
-
7203
7064
  For more details please consult the help option of the corresponding menu or TUI command.
7204
7065
  """
7205
7066
  version = '231'
@@ -7237,10 +7098,8 @@ class floating_surface(String, AllowedValuesMixin):
7237
7098
  class disk_id(Group):
7238
7099
  """
7239
7100
  Menu to define the disk face/surface name:
7240
-
7241
7101
  - embedded-face-zone: select embedded-face-zone name,
7242
7102
  - floating-disk : select floating-surface name,
7243
-
7244
7103
  For more details please consult the help option of the corresponding menu or TUI command.
7245
7104
  """
7246
7105
  version = '231'
@@ -7283,11 +7142,9 @@ class blade_pitch_cyclic_cos(Real):
7283
7142
  class blade_pitch_angles(Group):
7284
7143
  """
7285
7144
  Menu to define the rotor pitch and flapping angles.
7286
-
7287
7145
  - blade-pitch-collective : ,
7288
7146
  - blade-pitch-cyclic-sin : ,
7289
7147
  - blade-pitch-cyclic-cos : ,
7290
-
7291
7148
  For more details please consult the help option of the corresponding menu or TUI command.
7292
7149
  """
7293
7150
  version = '231'
@@ -7331,11 +7188,9 @@ class blade_flapping_cyclic_cos(Real):
7331
7188
  class blade_flap_angles(Group):
7332
7189
  """
7333
7190
  Menu to define the rotor pitch angles.
7334
-
7335
7191
  - blade-flapping-cone : ,
7336
7192
  - blade-flapping-cyclic-sin : ,
7337
7193
  - blade-flapping-cyclic-cos : ,
7338
-
7339
7194
  For more details please consult the help option of the corresponding menu or TUI command.
7340
7195
  """
7341
7196
  version = '231'
@@ -7352,10 +7207,8 @@ class blade_flap_angles(Group):
7352
7207
  class model_tip_loss(Integer):
7353
7208
  """
7354
7209
  Select Tip Loss Model:
7355
-
7356
7210
  - Enter 1 if using Quadratic model
7357
7211
  - Enter 2 if using modified Prandtl model
7358
-
7359
7212
  For more details please consult the help option of the corresponding menu or TUI command.
7360
7213
  """
7361
7214
  version = '231'
@@ -7384,11 +7237,9 @@ class prandtl_tuning_coefficient(Real):
7384
7237
  class tip_loss(Group):
7385
7238
  """
7386
7239
  Menu to define the rotor tip loss model.
7387
-
7388
7240
  - method : define the method to model rotor tip loss, quadratic-tip-loss, prandtl-tip-loss
7389
7241
  - tip-loss-limit : tip-loss-limit,
7390
7242
  - prandtl-tuning-coefficient: prandtl-tuning-coefficient,
7391
-
7392
7243
  For more details please consult the help option of the corresponding menu or TUI command.
7393
7244
  """
7394
7245
  version = '231'
@@ -7491,12 +7342,10 @@ class geometry_1(NamedObject[geometry_1_child], CreatableNamedObjectMixinOld[geo
7491
7342
  class trim_option(Integer):
7492
7343
  """
7493
7344
  Select Trimming Option:
7494
-
7495
7345
  - Enter 0 if no trimming is required
7496
7346
  - Enter 1 if trimming of collective pitch is required
7497
7347
  - Enter 2 if trimming of cyclic pitch angles are required
7498
7348
  - Enter 3 if trimming of both collective and cyclic pitch angles are required
7499
-
7500
7349
  For more details please consult the help option of the corresponding menu or TUI command.
7501
7350
  """
7502
7351
  version = '231'
@@ -7552,14 +7401,12 @@ class y_moment_coefficient(Real):
7552
7401
  class trimming(Group):
7553
7402
  """
7554
7403
  Menu to define rotor trimming set-up.
7555
-
7556
7404
  - trim-option : to define collective and cyclic pitches to trim,
7557
7405
  - update-frequency : the number of solver iterations that pitch angle will be updated each time,
7558
7406
  - damping-factor : relaxation factor for pitch angles,
7559
7407
  - thrust-coef : desired thrust coefficient to set pitch for
7560
7408
  - moment-coef-x : desired x-moment coefficient to set pitch for,
7561
7409
  - moment-coef-y : desired y-moment coefficient to set pitch for,
7562
-
7563
7410
  For more details please consult the help option of the corresponding menu or TUI command.
7564
7411
  """
7565
7412
  version = '231'
@@ -15077,13 +14924,6 @@ class new_type(String, AllowedValuesMixin):
15077
14924
  class change_type(Command):
15078
14925
  """
15079
14926
  'change_type' command.
15080
-
15081
- Parameters
15082
- ----------
15083
- zone_list : List
15084
- 'zone_list' child.
15085
- new_type : str
15086
- 'new_type' child.
15087
14927
  """
15088
14928
  version = '231'
15089
14929
  fluent_name = 'change-type'
@@ -15107,11 +14947,6 @@ class cell_zone_list(StringList, AllowedValuesMixin):
15107
14947
  class activate_cell_zone(Command):
15108
14948
  """
15109
14949
  'activate_cell_zone' command.
15110
-
15111
- Parameters
15112
- ----------
15113
- cell_zone_list : List
15114
- 'cell_zone_list' child.
15115
14950
  """
15116
14951
  version = '231'
15117
14952
  fluent_name = 'activate-cell-zone'
@@ -28028,15 +27863,6 @@ class phase_25(String):
28028
27863
  class compute(Command):
28029
27864
  """
28030
27865
  'compute' command.
28031
-
28032
- Parameters
28033
- ----------
28034
- from_zone_type : str
28035
- 'from_zone_type' child.
28036
- from_zone_name : str
28037
- 'from_zone_name' child.
28038
- phase : str
28039
- 'phase' child.
28040
27866
  """
28041
27867
  version = '231'
28042
27868
  fluent_name = 'compute'
@@ -33407,11 +33233,6 @@ class report_defs(StringList, AllowedValuesMixin):
33407
33233
  class compute_1(Command):
33408
33234
  """
33409
33235
  'compute' command.
33410
-
33411
- Parameters
33412
- ----------
33413
- report_defs : List
33414
- 'report_defs' child.
33415
33236
  """
33416
33237
  version = '231'
33417
33238
  fluent_name = 'compute'
@@ -33443,13 +33264,6 @@ class copy_to(String):
33443
33264
  class copy_1(Command):
33444
33265
  """
33445
33266
  'copy' command.
33446
-
33447
- Parameters
33448
- ----------
33449
- copy_from : str
33450
- 'copy_from' child.
33451
- copy_to : str
33452
- 'copy_to' child.
33453
33267
  """
33454
33268
  version = '231'
33455
33269
  fluent_name = 'copy'
@@ -35246,15 +35060,6 @@ class cycle_count(RealList):
35246
35060
  class customize_fmg_initialization(Command):
35247
35061
  """
35248
35062
  'customize_fmg_initialization' command.
35249
-
35250
- Parameters
35251
- ----------
35252
- multi_level_grid : int
35253
- 'multi_level_grid' child.
35254
- residual_reduction_level : List
35255
- 'residual_reduction_level' child.
35256
- cycle_count : List
35257
- 'cycle_count' child.
35258
35063
  """
35259
35064
  version = '231'
35260
35065
  fluent_name = 'customize-fmg-initialization'
@@ -35322,11 +35127,6 @@ class init_type(String, AllowedValuesMixin):
35322
35127
  class initialize(Command):
35323
35128
  """
35324
35129
  'initialize' command.
35325
-
35326
- Parameters
35327
- ----------
35328
- init_type : str
35329
- 'init_type' child.
35330
35130
  """
35331
35131
  version = '231'
35332
35132
  fluent_name = 'initialize'
@@ -35385,13 +35185,6 @@ class time_step_count(Integer):
35385
35185
  class init_acoustics_options(Command):
35386
35186
  """
35387
35187
  'init_acoustics_options' command.
35388
-
35389
- Parameters
35390
- ----------
35391
- set_ramping_length : bool
35392
- Enable/Disable ramping length and initialize acoustics.
35393
- time_step_count : int
35394
- Set number of timesteps for ramping of sources.
35395
35188
  """
35396
35189
  version = '231'
35397
35190
  fluent_name = 'init-acoustics-options'
@@ -35495,11 +35288,6 @@ class command_name(String):
35495
35288
  class enable_9(Command):
35496
35289
  """
35497
35290
  Enable an execute-command.
35498
-
35499
- Parameters
35500
- ----------
35501
- command_name : str
35502
- 'command_name' child.
35503
35291
  """
35504
35292
  version = '231'
35505
35293
  fluent_name = 'enable'
@@ -35513,11 +35301,6 @@ class enable_9(Command):
35513
35301
  class disable_1(Command):
35514
35302
  """
35515
35303
  Disable an execute-command.
35516
-
35517
- Parameters
35518
- ----------
35519
- command_name : str
35520
- 'command_name' child.
35521
35304
  """
35522
35305
  version = '231'
35523
35306
  fluent_name = 'disable'
@@ -35531,11 +35314,6 @@ class disable_1(Command):
35531
35314
  class copy_2(Command):
35532
35315
  """
35533
35316
  Copy an execute-command.
35534
-
35535
- Parameters
35536
- ----------
35537
- command_name : str
35538
- 'command_name' child.
35539
35317
  """
35540
35318
  version = '231'
35541
35319
  fluent_name = 'copy'
@@ -35549,11 +35327,6 @@ class copy_2(Command):
35549
35327
  class delete_1(CommandWithPositionalArgs):
35550
35328
  """
35551
35329
  Delete an execute-command.
35552
-
35553
- Parameters
35554
- ----------
35555
- command_name : str
35556
- 'command_name' child.
35557
35330
  """
35558
35331
  version = '231'
35559
35332
  fluent_name = 'delete'
@@ -35585,13 +35358,6 @@ class tsv_file_name(Filename):
35585
35358
  class export_1(Command):
35586
35359
  """
35587
35360
  Export execute-commands to a TSV file.
35588
-
35589
- Parameters
35590
- ----------
35591
- command_name : List
35592
- 'command_name' child.
35593
- tsv_file_name : str
35594
- 'tsv_file_name' child.
35595
35361
  """
35596
35362
  version = '231'
35597
35363
  fluent_name = 'export'
@@ -35606,11 +35372,6 @@ class export_1(Command):
35606
35372
  class import__1(Command):
35607
35373
  """
35608
35374
  Import execute-commands from a TSV file.
35609
-
35610
- Parameters
35611
- ----------
35612
- tsv_file_name : str
35613
- 'tsv_file_name' child.
35614
35375
  """
35615
35376
  version = '231'
35616
35377
  fluent_name = 'import'
@@ -36102,13 +35863,6 @@ class command_list(StringList):
36102
35863
  class export_modifications(Command):
36103
35864
  """
36104
35865
  Export all case modifications to a tsv file.
36105
-
36106
- Parameters
36107
- ----------
36108
- command_list : List
36109
- 'command_list' child.
36110
- filename : str
36111
- 'filename' child.
36112
35866
  """
36113
35867
  version = '231'
36114
35868
  fluent_name = 'export-modifications'
@@ -36434,11 +36188,6 @@ class udf_cf_names(StringList, AllowedValuesMixin):
36434
36188
  class setup_unsteady_statistics(Command):
36435
36189
  """
36436
36190
  'setup_unsteady_statistics' command.
36437
-
36438
- Parameters
36439
- ----------
36440
- udf_cf_names : List
36441
- 'udf_cf_names' child.
36442
36191
  """
36443
36192
  version = '231'
36444
36193
  fluent_name = 'setup-unsteady-statistics'
@@ -40277,11 +40026,6 @@ class rgb_vector(RealVector):
40277
40026
  class set_ambient_color(Command):
40278
40027
  """
40279
40028
  'set_ambient_color' command.
40280
-
40281
- Parameters
40282
- ----------
40283
- rgb_vector : Tuple
40284
- 'rgb_vector' child.
40285
40029
  """
40286
40030
  version = '231'
40287
40031
  fluent_name = 'set-ambient-color'
@@ -40340,21 +40084,6 @@ class direction_vector_1(RealVector):
40340
40084
  class set_light(Command):
40341
40085
  """
40342
40086
  'set_light' command.
40343
-
40344
- Parameters
40345
- ----------
40346
- light_number : int
40347
- 'light_number' child.
40348
- light_on : bool
40349
- 'light_on' child.
40350
- rgb_vector : Tuple
40351
- 'rgb_vector' child.
40352
- use_view_factor : bool
40353
- 'use_view_factor' child.
40354
- change_light_direction : bool
40355
- 'change_light_direction' child.
40356
- direction_vector : Tuple
40357
- 'direction_vector' child.
40358
40087
  """
40359
40088
  version = '231'
40360
40089
  fluent_name = 'set-light'
@@ -40545,11 +40274,6 @@ class preview(Command):
40545
40274
  class save_picture(Command):
40546
40275
  """
40547
40276
  'save_picture' command.
40548
-
40549
- Parameters
40550
- ----------
40551
- file_name : str
40552
- 'file_name' child.
40553
40277
  """
40554
40278
  version = '231'
40555
40279
  fluent_name = 'save-picture'
@@ -40887,11 +40611,6 @@ class state_name(String, AllowedValuesMixin):
40887
40611
  class use_active(Command):
40888
40612
  """
40889
40613
  'use_active' command.
40890
-
40891
- Parameters
40892
- ----------
40893
- state_name : str
40894
- 'state_name' child.
40895
40614
  """
40896
40615
  version = '231'
40897
40616
  fluent_name = 'use-active'
@@ -43053,11 +42772,6 @@ class file_name_path_1(String):
43053
42772
  class write_simulation_report_template_file(Command):
43054
42773
  """
43055
42774
  'write_simulation_report_template_file' command.
43056
-
43057
- Parameters
43058
- ----------
43059
- file_name_path : str
43060
- 'file_name_path' child.
43061
42775
  """
43062
42776
  version = '231'
43063
42777
  fluent_name = 'write-simulation-report-template-file'
@@ -43305,21 +43019,6 @@ class read_fn(Filename):
43305
43019
  class plot_sample(Command):
43306
43020
  """
43307
43021
  'plot_sample' command.
43308
-
43309
- Parameters
43310
- ----------
43311
- loaded_samples : str
43312
- 'loaded_samples' child.
43313
- variable_to_sampled : str
43314
- 'variable_to_sampled' child.
43315
- weighting_var : str
43316
- 'weighting_var' child.
43317
- correlation_var : str
43318
- 'correlation_var' child.
43319
- read_fn : str
43320
- 'read_fn' child.
43321
- overwrite : bool
43322
- 'overwrite' child.
43323
43022
  """
43324
43023
  version = '231'
43325
43024
  fluent_name = 'plot-sample'
@@ -43338,21 +43037,6 @@ class plot_sample(Command):
43338
43037
  class write_sample(Command):
43339
43038
  """
43340
43039
  'write_sample' command.
43341
-
43342
- Parameters
43343
- ----------
43344
- loaded_samples : str
43345
- 'loaded_samples' child.
43346
- variable_to_sampled : str
43347
- 'variable_to_sampled' child.
43348
- weighting_var : str
43349
- 'weighting_var' child.
43350
- correlation_var : str
43351
- 'correlation_var' child.
43352
- read_fn : str
43353
- 'read_fn' child.
43354
- overwrite : bool
43355
- 'overwrite' child.
43356
43040
  """
43357
43041
  version = '231'
43358
43042
  fluent_name = 'write-sample'
@@ -43520,13 +43204,6 @@ class max_val(Real):
43520
43204
  class set_maximum(Command):
43521
43205
  """
43522
43206
  'set_maximum' command.
43523
-
43524
- Parameters
43525
- ----------
43526
- sample_var : str
43527
- 'sample_var' child.
43528
- max_val : real
43529
- 'max_val' child.
43530
43207
  """
43531
43208
  version = '231'
43532
43209
  fluent_name = 'set-maximum'
@@ -43794,11 +43471,6 @@ class compute_sample(Command):
43794
43471
  class delete_sample(Command):
43795
43472
  """
43796
43473
  'delete_sample' command.
43797
-
43798
- Parameters
43799
- ----------
43800
- sample : str
43801
- 'sample' child.
43802
43474
  """
43803
43475
  version = '231'
43804
43476
  fluent_name = 'delete-sample'
@@ -43951,23 +43623,6 @@ class accumulate_rates(Boolean):
43951
43623
  class sample_1(Command):
43952
43624
  """
43953
43625
  'sample' command.
43954
-
43955
- Parameters
43956
- ----------
43957
- injections : List
43958
- 'injections' child.
43959
- boundaries : List
43960
- 'boundaries' child.
43961
- lines : List
43962
- 'lines' child.
43963
- planes : List
43964
- 'planes' child.
43965
- op_udf : str
43966
- 'op_udf' child.
43967
- append_sample : bool
43968
- 'append_sample' child.
43969
- accumulate_rates : bool
43970
- 'accumulate_rates' child.
43971
43626
  """
43972
43627
  version = '231'
43973
43628
  fluent_name = 'sample'
@@ -44488,11 +44143,6 @@ class fluxes(Group):
44488
44143
  class species_mass_flow(Command):
44489
44144
  """
44490
44145
  'species_mass_flow' command.
44491
-
44492
- Parameters
44493
- ----------
44494
- domain_val : str
44495
- 'domain_val' child.
44496
44146
  """
44497
44147
  version = '231'
44498
44148
  fluent_name = 'species-mass-flow'
@@ -44506,11 +44156,6 @@ class species_mass_flow(Command):
44506
44156
  class element_mass_flow(Command):
44507
44157
  """
44508
44158
  'element_mass_flow' command.
44509
-
44510
- Parameters
44511
- ----------
44512
- domain_val : str
44513
- 'domain_val' child.
44514
44159
  """
44515
44160
  version = '231'
44516
44161
  fluent_name = 'element-mass-flow'
@@ -44524,11 +44169,6 @@ class element_mass_flow(Command):
44524
44169
  class uds_flow(Command):
44525
44170
  """
44526
44171
  'uds_flow' command.
44527
-
44528
- Parameters
44529
- ----------
44530
- domain_val : str
44531
- 'domain_val' child.
44532
44172
  """
44533
44173
  version = '231'
44534
44174
  fluent_name = 'uds-flow'
@@ -44724,29 +44364,6 @@ class dia_upper_limit(Real):
44724
44364
  class number_density(Command):
44725
44365
  """
44726
44366
  'number_density' command.
44727
-
44728
- Parameters
44729
- ----------
44730
- report_type : str
44731
- 'report_type' child.
44732
- disc_output_type : str
44733
- 'disc_output_type' child.
44734
- qmom_output_type : str
44735
- 'qmom_output_type' child.
44736
- smm_output_type : str
44737
- 'smm_output_type' child.
44738
- surface_list : List
44739
- 'surface_list' child.
44740
- volume_list : List
44741
- 'volume_list' child.
44742
- num_dens_func : str
44743
- 'num_dens_func' child.
44744
- dia_upper_limit : real
44745
- 'dia_upper_limit' child.
44746
- file_name : str
44747
- 'file_name' child.
44748
- overwrite : bool
44749
- 'overwrite' child.
44750
44367
  """
44751
44368
  version = '231'
44752
44369
  fluent_name = 'number-density'
@@ -44819,25 +44436,6 @@ class append_file(Boolean):
44819
44436
  class computed_heat_rejection(Command):
44820
44437
  """
44821
44438
  'computed_heat_rejection' command.
44822
-
44823
- Parameters
44824
- ----------
44825
- heat_exchanger : str
44826
- 'heat_exchanger' child.
44827
- fluid_zone : str
44828
- 'fluid_zone' child.
44829
- boundary_zone : str
44830
- 'boundary_zone' child.
44831
- report_type : str
44832
- 'report_type' child.
44833
- write_to_file : bool
44834
- 'write_to_file' child.
44835
- file_name : str
44836
- 'file_name' child.
44837
- append_file : bool
44838
- 'append_file' child.
44839
- overwrite : bool
44840
- 'overwrite' child.
44841
44439
  """
44842
44440
  version = '231'
44843
44441
  fluent_name = 'computed-heat-rejection'
@@ -44858,25 +44456,6 @@ class computed_heat_rejection(Command):
44858
44456
  class inlet_temperature(Command):
44859
44457
  """
44860
44458
  'inlet_temperature' command.
44861
-
44862
- Parameters
44863
- ----------
44864
- heat_exchanger : str
44865
- 'heat_exchanger' child.
44866
- fluid_zone : str
44867
- 'fluid_zone' child.
44868
- boundary_zone : str
44869
- 'boundary_zone' child.
44870
- report_type : str
44871
- 'report_type' child.
44872
- write_to_file : bool
44873
- 'write_to_file' child.
44874
- file_name : str
44875
- 'file_name' child.
44876
- append_file : bool
44877
- 'append_file' child.
44878
- overwrite : bool
44879
- 'overwrite' child.
44880
44459
  """
44881
44460
  version = '231'
44882
44461
  fluent_name = 'inlet-temperature'
@@ -44897,25 +44476,6 @@ class inlet_temperature(Command):
44897
44476
  class outlet_temperature(Command):
44898
44477
  """
44899
44478
  'outlet_temperature' command.
44900
-
44901
- Parameters
44902
- ----------
44903
- heat_exchanger : str
44904
- 'heat_exchanger' child.
44905
- fluid_zone : str
44906
- 'fluid_zone' child.
44907
- boundary_zone : str
44908
- 'boundary_zone' child.
44909
- report_type : str
44910
- 'report_type' child.
44911
- write_to_file : bool
44912
- 'write_to_file' child.
44913
- file_name : str
44914
- 'file_name' child.
44915
- append_file : bool
44916
- 'append_file' child.
44917
- overwrite : bool
44918
- 'overwrite' child.
44919
44479
  """
44920
44480
  version = '231'
44921
44481
  fluent_name = 'outlet-temperature'
@@ -44936,25 +44496,6 @@ class outlet_temperature(Command):
44936
44496
  class mass_flow_rate(Command):
44937
44497
  """
44938
44498
  'mass_flow_rate' command.
44939
-
44940
- Parameters
44941
- ----------
44942
- heat_exchanger : str
44943
- 'heat_exchanger' child.
44944
- fluid_zone : str
44945
- 'fluid_zone' child.
44946
- boundary_zone : str
44947
- 'boundary_zone' child.
44948
- report_type : str
44949
- 'report_type' child.
44950
- write_to_file : bool
44951
- 'write_to_file' child.
44952
- file_name : str
44953
- 'file_name' child.
44954
- append_file : bool
44955
- 'append_file' child.
44956
- overwrite : bool
44957
- 'overwrite' child.
44958
44499
  """
44959
44500
  version = '231'
44960
44501
  fluent_name = 'mass-flow-rate'
@@ -44975,25 +44516,6 @@ class mass_flow_rate(Command):
44975
44516
  class specific_heat_5(Command):
44976
44517
  """
44977
44518
  'specific_heat' command.
44978
-
44979
- Parameters
44980
- ----------
44981
- heat_exchanger : str
44982
- 'heat_exchanger' child.
44983
- fluid_zone : str
44984
- 'fluid_zone' child.
44985
- boundary_zone : str
44986
- 'boundary_zone' child.
44987
- report_type : str
44988
- 'report_type' child.
44989
- write_to_file : bool
44990
- 'write_to_file' child.
44991
- file_name : str
44992
- 'file_name' child.
44993
- append_file : bool
44994
- 'append_file' child.
44995
- overwrite : bool
44996
- 'overwrite' child.
44997
44519
  """
44998
44520
  version = '231'
44999
44521
  fluent_name = 'specific-heat'
@@ -45289,35 +44811,6 @@ class coord_val(Real):
45289
44811
  class forces(Command):
45290
44812
  """
45291
44813
  'forces' command.
45292
-
45293
- Parameters
45294
- ----------
45295
- options : str
45296
- 'options' child.
45297
- domain_val : str
45298
- 'domain_val' child.
45299
- all_wall_zones : bool
45300
- Select all wall zones available.
45301
- wall_thread_list : List
45302
- 'wall_thread_list' child.
45303
- direction_vector : Tuple
45304
- 'direction_vector' child.
45305
- momentum_center : Tuple
45306
- 'momentum_center' child.
45307
- momentum_axis : Tuple
45308
- 'momentum_axis' child.
45309
- pressure_coordinate : str
45310
- 'pressure_coordinate' child.
45311
- coord_val : real
45312
- 'coord_val' child.
45313
- write_to_file : bool
45314
- 'write_to_file' child.
45315
- file_name : str
45316
- 'file_name' child.
45317
- append_data : bool
45318
- 'append_data' child.
45319
- overwrite : bool
45320
- 'overwrite' child.
45321
44814
  """
45322
44815
  version = '231'
45323
44816
  fluent_name = 'forces'
@@ -45598,45 +45091,6 @@ class current_domain(String, AllowedValuesMixin):
45598
45091
  class surface_integrals(Command):
45599
45092
  """
45600
45093
  'surface_integrals' command.
45601
-
45602
- Parameters
45603
- ----------
45604
- report_type : str
45605
- 'report_type' child.
45606
- surface_id : List
45607
- 'surface_id' child.
45608
- add_custome_vector : bool
45609
- 'add_custome_vector' child.
45610
- cust_vec_name : str
45611
- 'cust_vec_name' child.
45612
- domain_cx : str
45613
- 'domain_cx' child.
45614
- cell_cx : str
45615
- 'cell_cx' child.
45616
- domain_cy : str
45617
- 'domain_cy' child.
45618
- cell_cy : str
45619
- 'cell_cy' child.
45620
- domain_cz : str
45621
- 'domain_cz' child.
45622
- cell_cz : str
45623
- 'cell_cz' child.
45624
- cust_vec_func : str
45625
- 'cust_vec_func' child.
45626
- domain_report : str
45627
- 'domain_report' child.
45628
- cell_report : str
45629
- 'cell_report' child.
45630
- current_domain : str
45631
- 'current_domain' child.
45632
- write_to_file : bool
45633
- 'write_to_file' child.
45634
- file_name : str
45635
- 'file_name' child.
45636
- append_data : bool
45637
- 'append_data' child.
45638
- overwrite : bool
45639
- 'overwrite' child.
45640
45094
  """
45641
45095
  version = '231'
45642
45096
  fluent_name = 'surface-integrals'
@@ -45676,27 +45130,6 @@ class thread_id_list(StringList):
45676
45130
  class volume_integrals(Command):
45677
45131
  """
45678
45132
  'volume_integrals' command.
45679
-
45680
- Parameters
45681
- ----------
45682
- report_type : str
45683
- 'report_type' child.
45684
- thread_id_list : List
45685
- 'thread_id_list' child.
45686
- domain : str
45687
- 'domain' child.
45688
- cell_function : str
45689
- 'cell_function' child.
45690
- current_domain : str
45691
- 'current_domain' child.
45692
- write_to_file : bool
45693
- 'write_to_file' child.
45694
- file_name : str
45695
- 'file_name' child.
45696
- append_data : bool
45697
- 'append_data' child.
45698
- overwrite : bool
45699
- 'overwrite' child.
45700
45133
  """
45701
45134
  version = '231'
45702
45135
  fluent_name = 'volume-integrals'
@@ -47459,13 +46892,6 @@ class compute_node(Integer):
47459
46892
  class kill_node(Command):
47460
46893
  """
47461
46894
  'kill_node' command.
47462
-
47463
- Parameters
47464
- ----------
47465
- compute_node : int
47466
- 'compute_node' child.
47467
- invalidate_case : bool
47468
- 'invalidate_case' child.
47469
46895
  """
47470
46896
  version = '231'
47471
46897
  fluent_name = 'kill-node'