ansys-systemcoupling-core 0.3.1__py3-none-any.whl → 0.4.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-systemcoupling-core might be problematic. Click here for more details.

Files changed (165) hide show
  1. ansys/systemcoupling/core/__init__.py +23 -1
  2. ansys/systemcoupling/core/_version.py +22 -0
  3. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/add_data_transfer_by_display_names.py +0 -3
  4. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/add_interface.py +21 -23
  5. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/add_interface_by_display_names.py +0 -3
  6. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/add_participant.py +40 -20
  7. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/analysis_control.py +0 -42
  8. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/avoid_data_reconstruction.py +0 -10
  9. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/case_root.py +7 -1
  10. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/coupling_participant_child.py +2 -97
  11. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/execution_control.py +1 -31
  12. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/fluent_input.py +0 -10
  13. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/fmu_parameter_child.py +0 -30
  14. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/has_input_file_changed.py +2 -2
  15. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/mapping_control.py +0 -10
  16. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/open_results_in_ensight.py +0 -28
  17. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/output_control.py +1 -6
  18. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/region_child.py +3 -2
  19. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/setup_root.py +1 -49
  20. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/solution_control.py +0 -24
  21. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/solution_root.py +1 -7
  22. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/start_participants.py +1 -1
  23. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/update_participant.py +8 -8
  24. ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/variable_child.py +1 -31
  25. ansys/systemcoupling/core/adaptor/api_24_1/add_data_transfer_by_display_names.py +3 -0
  26. ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/add_fsi_data_transfers.py +1 -12
  27. ansys/systemcoupling/core/adaptor/api_24_1/add_interface.py +23 -21
  28. ansys/systemcoupling/core/adaptor/api_24_1/add_interface_by_display_names.py +3 -0
  29. ansys/systemcoupling/core/adaptor/api_24_1/add_participant.py +20 -40
  30. ansys/systemcoupling/core/adaptor/api_24_1/analysis_control.py +42 -0
  31. ansys/systemcoupling/core/adaptor/api_24_1/avoid_data_reconstruction.py +10 -0
  32. ansys/systemcoupling/core/adaptor/api_24_1/case_root.py +1 -7
  33. ansys/systemcoupling/core/adaptor/api_24_1/coupling_participant_child.py +85 -2
  34. ansys/systemcoupling/core/adaptor/api_24_1/execution_control.py +11 -1
  35. ansys/systemcoupling/core/adaptor/api_24_1/fmu_parameter_child.py +30 -0
  36. ansys/systemcoupling/core/adaptor/api_24_1/has_input_file_changed.py +2 -2
  37. ansys/systemcoupling/core/adaptor/api_24_1/mapping_control.py +10 -0
  38. ansys/systemcoupling/core/adaptor/api_24_1/open_results_in_ensight.py +28 -0
  39. ansys/systemcoupling/core/adaptor/api_24_1/output_control.py +6 -1
  40. ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/record_interactions.py +0 -10
  41. ansys/systemcoupling/core/adaptor/api_24_1/region_child.py +2 -2
  42. ansys/systemcoupling/core/adaptor/api_24_1/setup_root.py +49 -1
  43. ansys/systemcoupling/core/adaptor/api_24_1/solution_control.py +24 -0
  44. ansys/systemcoupling/core/adaptor/api_24_1/solution_root.py +7 -1
  45. ansys/systemcoupling/core/adaptor/api_24_1/start_participants.py +1 -1
  46. ansys/systemcoupling/core/adaptor/api_24_1/update_participant.py +8 -8
  47. ansys/systemcoupling/core/adaptor/api_24_1/variable_child.py +31 -1
  48. ansys/systemcoupling/core/adaptor/impl/get_status_messages.py +22 -0
  49. ansys/systemcoupling/core/adaptor/impl/get_syc_version.py +26 -2
  50. ansys/systemcoupling/core/adaptor/impl/injected_commands.py +29 -0
  51. ansys/systemcoupling/core/adaptor/impl/root_source.py +22 -1
  52. ansys/systemcoupling/core/adaptor/impl/static_info.py +22 -0
  53. ansys/systemcoupling/core/adaptor/impl/syc_proxy.py +22 -0
  54. ansys/systemcoupling/core/adaptor/impl/syc_proxy_interface.py +22 -0
  55. ansys/systemcoupling/core/adaptor/impl/types.py +23 -0
  56. ansys/systemcoupling/core/client/grpc_client.py +22 -0
  57. ansys/systemcoupling/core/client/services/command_query.py +22 -0
  58. ansys/systemcoupling/core/client/services/output_stream.py +22 -0
  59. ansys/systemcoupling/core/client/services/process.py +22 -0
  60. ansys/systemcoupling/core/client/services/solution.py +22 -0
  61. ansys/systemcoupling/core/client/syc_container.py +22 -0
  62. ansys/systemcoupling/core/client/syc_process.py +22 -0
  63. ansys/systemcoupling/core/client/variant.py +22 -0
  64. ansys/systemcoupling/core/examples/__init__.py +22 -0
  65. ansys/systemcoupling/core/examples/downloads.py +23 -0
  66. ansys/systemcoupling/core/native_api/__init__.py +22 -0
  67. ansys/systemcoupling/core/native_api/command_metadata.py +23 -0
  68. ansys/systemcoupling/core/native_api/datamodel_metadata.py +22 -0
  69. ansys/systemcoupling/core/native_api/meta_wrapper.py +23 -0
  70. ansys/systemcoupling/core/native_api/native_api.py +22 -0
  71. ansys/systemcoupling/core/native_api/object_path.py +22 -0
  72. ansys/systemcoupling/core/participant/manager.py +22 -0
  73. ansys/systemcoupling/core/participant/mapdl.py +298 -0
  74. ansys/systemcoupling/core/participant/protocol.py +22 -0
  75. ansys/systemcoupling/core/session.py +22 -0
  76. ansys/systemcoupling/core/syc_version.py +22 -0
  77. ansys/systemcoupling/core/util/logging.py +22 -0
  78. ansys/systemcoupling/core/util/name_util.py +22 -0
  79. ansys/systemcoupling/core/util/pathstr.py +23 -1
  80. ansys/systemcoupling/core/util/state_keys.py +22 -0
  81. ansys/systemcoupling/core/util/yaml_helper.py +22 -0
  82. {ansys_systemcoupling_core-0.3.1.dist-info → ansys_systemcoupling_core-0.4.dev0.dist-info}/METADATA +19 -18
  83. {ansys_systemcoupling_core-0.3.1.dist-info → ansys_systemcoupling_core-0.4.dev0.dist-info}/RECORD +165 -164
  84. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/_add_participant.py +0 -0
  85. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/_solve.py +0 -0
  86. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/abort.py +0 -0
  87. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/activate_hidden.py +0 -0
  88. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/add_data_transfer.py +0 -0
  89. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/add_expression_function.py +0 -0
  90. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/add_named_expression.py +0 -0
  91. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/add_reference_frame.py +0 -0
  92. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/add_transformation.py +0 -0
  93. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/apip.py +0 -0
  94. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/ascii_output.py +0 -0
  95. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/attribute.py +0 -0
  96. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/attribute_child.py +0 -0
  97. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/available_ports.py +0 -0
  98. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/clear_state.py +0 -0
  99. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/coupling_interface.py +0 -0
  100. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/coupling_interface_child.py +0 -0
  101. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/coupling_participant.py +0 -0
  102. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/create_restart_point.py +0 -0
  103. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/data_transfer.py +0 -0
  104. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/data_transfer_child.py +0 -0
  105. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/delete_snapshot.py +0 -0
  106. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/delete_transformation.py +0 -0
  107. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/dimensionality.py +0 -0
  108. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/expression.py +0 -0
  109. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/expression_child.py +0 -0
  110. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/expression_function.py +0 -0
  111. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/expression_function_child.py +0 -0
  112. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/external_data_file.py +0 -0
  113. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/fmu_parameter.py +0 -0
  114. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/generate_input_file.py +0 -0
  115. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/get_execution_command.py +0 -0
  116. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/get_machines.py +0 -0
  117. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/get_region_names_for_participant.py +0 -0
  118. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/get_setup_summary.py +0 -0
  119. /ansys/systemcoupling/core/adaptor/{api_24_1 → api_23_1}/get_snapshots.py +0 -0
  120. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/get_status_messages.py +0 -0
  121. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/global_stabilization.py +0 -0
  122. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/import_system_coupling_input_file.py +0 -0
  123. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/initialize.py +0 -0
  124. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/instancing.py +0 -0
  125. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/instancing_child.py +0 -0
  126. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/interrupt.py +0 -0
  127. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/library.py +0 -0
  128. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/open.py +0 -0
  129. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/open_snapshot.py +0 -0
  130. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/partition_participants.py +0 -0
  131. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/reference_frame.py +0 -0
  132. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/reference_frame_child.py +0 -0
  133. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/region.py +0 -0
  134. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/reload_expression_function_modules.py +0 -0
  135. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/results.py +0 -0
  136. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/save.py +0 -0
  137. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/save_snapshot.py +0 -0
  138. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/shutdown.py +0 -0
  139. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/side.py +0 -0
  140. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/side_child.py +0 -0
  141. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/solve.py +0 -0
  142. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/stabilization.py +0 -0
  143. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/step.py +0 -0
  144. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/transformation.py +0 -0
  145. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/transformation_child.py +0 -0
  146. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/type.py +0 -0
  147. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/unmapped_value_options.py +0 -0
  148. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/update_control.py +0 -0
  149. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/variable.py +0 -0
  150. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/write_csv_chart_files.py +0 -0
  151. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/write_ensight.py +0 -0
  152. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/add_aerodamping_data_transfers.py +0 -0
  153. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/add_ordered_data_transfers.py +0 -0
  154. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/add_thermal_data_transfers.py +0 -0
  155. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/automatic_alignment_options.py +0 -0
  156. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/get_add_data_transfer_group_commands.py +0 -0
  157. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/get_mode_shape_variables.py +0 -0
  158. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/get_thermal_data_transfer_options.py +0 -0
  159. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/get_transformation.py +0 -0
  160. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/live_visualization.py +0 -0
  161. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/live_visualization_child.py +0 -0
  162. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/parameter.py +0 -0
  163. /ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/parameter_child.py +0 -0
  164. {ansys_systemcoupling_core-0.3.1.dist-info → ansys_systemcoupling_core-0.4.dev0.dist-info}/LICENSE +0 -0
  165. {ansys_systemcoupling_core-0.3.1.dist-info → ansys_systemcoupling_core-0.4.dev0.dist-info}/WHEEL +0 -0
@@ -1,3 +1,25 @@
1
+ # Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
2
+ # SPDX-License-Identifier: MIT
3
+ #
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ # of this software and associated documentation files (the "Software"), to deal
7
+ # in the Software without restriction, including without limitation the rights
8
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ # copies of the Software, and to permit persons to whom the Software is
10
+ # furnished to do so, subject to the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be included in all
13
+ # copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
22
+
1
23
  import os
2
24
  from typing import List
3
25
 
@@ -47,7 +69,7 @@ def launch(
47
69
  (The forms ``"23.1"`` and ``"23_1"`` are also acceptable.)
48
70
  The version will be sought in the standard installation location. The
49
71
  default is ``None``, which is equivalent to specifying
50
- ``"232"`` ("2023 R2" release), unless either of the environment
72
+ ``"241"`` ("2024 R1" release), unless either of the environment
51
73
  variables ``SYSC_ROOT`` or ``AWP_ROOT`` has been set. It is considered
52
74
  to be an error if either these is set *and* ``version`` is provided.
53
75
  extra_args : List[str]
@@ -1,3 +1,25 @@
1
+ # Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
2
+ # SPDX-License-Identifier: MIT
3
+ #
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ # of this software and associated documentation files (the "Software"), to deal
7
+ # in the Software without restriction, including without limitation the rights
8
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ # copies of the Software, and to permit persons to whom the Software is
10
+ # furnished to do so, subject to the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be included in all
13
+ # copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
22
+
1
23
  """Version of ansys-systemcoupling-core library.
2
24
 
3
25
  On the ``main`` branch, use 'dev0' to denote a development version.
@@ -7,9 +7,6 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
7
7
 
8
8
  class add_data_transfer_by_display_names(Command):
9
9
  """
10
- Important: This command is deprecated. To add an interface, use the
11
- ``add_data_transfer`` command instead.
12
-
13
10
  Adds data transfer based on arguments that specify the interface, target
14
11
  side, and variables to be associated with each side of the interface.
15
12
  The command requires that you specify variables using their display names
@@ -8,11 +8,9 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
8
8
  class add_interface(Command):
9
9
  """
10
10
  Adds an interface based on the participant and region names specified
11
- as arguments for each side of the interface. This command requires that
12
- you specify participants using their names as described below in
13
- Essential Keyword Arguments. Non-FMU participants must provide a list
14
- of regions as described below in Optional Keyword Arguments. For FMU
15
- interfaces, specifying the regions are not allowed.
11
+ as arguments for each side of the interface. This command requires that you
12
+ specify participants and regions using their names (see parameter
13
+ descriptions for details).
16
14
 
17
15
  Cannot be run after participants have been started.
18
16
 
@@ -23,15 +21,15 @@ class add_interface(Command):
23
21
  side_one_participant : str
24
22
  String indicating the name of the participant to be associated with
25
23
  side \"One\" of the interface.
24
+ side_one_regions : typing.List[str]
25
+ List specifying the name(s) of region(s) to be added to side \"One\" of
26
+ the interface.
26
27
  side_two_participant : str
27
28
  String indicating the name of the participant to be associated with
28
- side \"Two"\ of the interface.
29
- side_one_regions : typing.List[str], optional
30
- List specifying the name(s) of region(s) to be added to side One of
31
- the interface. Must be provided if ``side_one_participant`` is not an FMU.
32
- side_two_regions : typing.List[str], optional
33
- List specifying the name(s) of region(s) to be added to side Two of
34
- the interface. Must be provided if ``side_one_participant`` is not an FMU.
29
+ side \"Two\" of the interface.
30
+ side_two_regions : typing.List[str]
31
+ List specifying the name(s) of region(s) to be added to side \"Two\" of
32
+ the interface.
35
33
 
36
34
  """
37
35
 
@@ -39,8 +37,8 @@ class add_interface(Command):
39
37
 
40
38
  argument_names = [
41
39
  "side_one_participant",
42
- "side_two_participant",
43
40
  "side_one_regions",
41
+ "side_two_participant",
44
42
  "side_two_regions",
45
43
  ]
46
44
 
@@ -52,26 +50,26 @@ class add_interface(Command):
52
50
 
53
51
  syc_name = "SideOneParticipant"
54
52
 
55
- class side_two_participant(String):
53
+ class side_one_regions(StringList):
56
54
  """
57
- String indicating the name of the participant to be associated with
58
- side \"Two"\ of the interface.
55
+ List specifying the name(s) of region(s) to be added to side \"One\" of
56
+ the interface.
59
57
  """
60
58
 
61
- syc_name = "SideTwoParticipant"
59
+ syc_name = "SideOneRegions"
62
60
 
63
- class side_one_regions(StringList):
61
+ class side_two_participant(String):
64
62
  """
65
- List specifying the name(s) of region(s) to be added to side One of
66
- the interface. Must be provided if ``side_one_participant`` is not an FMU.
63
+ String indicating the name of the participant to be associated with
64
+ side \"Two\" of the interface.
67
65
  """
68
66
 
69
- syc_name = "SideOneRegions"
67
+ syc_name = "SideTwoParticipant"
70
68
 
71
69
  class side_two_regions(StringList):
72
70
  """
73
- List specifying the name(s) of region(s) to be added to side Two of
74
- the interface. Must be provided if ``side_one_participant`` is not an FMU.
71
+ List specifying the name(s) of region(s) to be added to side \"Two\" of
72
+ the interface.
75
73
  """
76
74
 
77
75
  syc_name = "SideTwoRegions"
@@ -7,9 +7,6 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
7
7
 
8
8
  class add_interface_by_display_names(Command):
9
9
  """
10
- Important: This command is deprecated. To add an interface, use the
11
- ``add_interface`` command instead.
12
-
13
10
  Adds an interface based on the participant and region display names specified
14
11
  as arguments for each side of the interface. This command requires that you
15
12
  specify participants and regions using their *display* names (see parameter
@@ -44,31 +44,40 @@ class add_participant(InjectedCommand):
44
44
  participant executable.
45
45
 
46
46
  Option 1: Using an input file
47
-
48
- Given an input file containing participant coupling information, reads the
49
- specified file, pushes the participant's information to the data model.
47
+ Given an input file containing participant coupling information, reads the
48
+ specified file, pushes the participant's information to the data model.
50
49
 
51
50
  Option 2: Using a participant executable
52
-
53
- Given the path to the executable for this participant (and optionally,
54
- additional arguments and/or working directory), start the participant
55
- executable, connect to the participant using the socket connection,
56
- and get the participant's information and add it to the data model.
51
+ Given the path to the executable for this participant (and optionally,
52
+ additional arguments and/or working directory), start the participant
53
+ executable, connect to the participant using the socket connection,
54
+ and get the participant's information and add it to the data model.
57
55
 
58
56
  Parameters
59
57
  ----------
60
58
  participant_session : ParticipantProtocol, optional
61
59
  Participant session object conforming to the ``ParticipantProtocol`` protocol class.
62
60
  participant_type : str, optional
63
- Participant type. Currently supported types are DEFAULT, CFX,
64
- FLUENT, MAPDL, AEDT, FMU, FORTE, DEFAULT-SRV, CFD-SRV, MECH-SRV, and SCDT-SRV.
65
- If unspecified, AddParticipant will attempt to deduce the type from
66
- Input_file.
61
+ Participant type. Currently supported types are:
62
+
63
+ - \"DEFAULT\"
64
+ - \"CFX\"
65
+ - \"FLUENT\"
66
+ - \"MAPDL\"
67
+ - \"AEDT\"
68
+ - \"FMU\"
69
+ - \"FORTE\"
70
+ - \"DEFAULT-SRV\"
71
+ - \"MECH-SRV\"
72
+ - \"CFD-SRV\"
73
+
74
+ If unspecified, ``add_participant`` will attempt to deduce
75
+ the type from ``input_file``.
67
76
  input_file : str, optional
68
77
  Name of the input file for the participant to be added.
69
78
  Currently supported formats are SCP files, Forte input (FTSIM)
70
- files, mechanical server (\*.rst) files, cfd server (\*.csv) files,
71
- FMU (.fmu) files (Beta), and system coupling data server (\*.scdt/axdt/csv) files.
79
+ files, mechanical server (*.rst) files, cfd server (*.csv) files,
80
+ and FMU (.fmu) files (Beta).
72
81
  executable : str, optional
73
82
  Path to the executable file for the participant to be added.
74
83
  additional_arguments : str, optional
@@ -100,10 +109,21 @@ class add_participant(InjectedCommand):
100
109
 
101
110
  class participant_type(String):
102
111
  """
103
- Participant type. Currently supported types are DEFAULT, CFX,
104
- FLUENT, MAPDL, AEDT, FMU, FORTE, DEFAULT-SRV, CFD-SRV, MECH-SRV, and SCDT-SRV.
105
- If unspecified, AddParticipant will attempt to deduce the type from
106
- Input_file.
112
+ Participant type. Currently supported types are:
113
+
114
+ - \"DEFAULT\"
115
+ - \"CFX\"
116
+ - \"FLUENT\"
117
+ - \"MAPDL\"
118
+ - \"AEDT\"
119
+ - \"FMU\"
120
+ - \"FORTE\"
121
+ - \"DEFAULT-SRV\"
122
+ - \"MECH-SRV\"
123
+ - \"CFD-SRV\"
124
+
125
+ If unspecified, ``add_participant`` will attempt to deduce
126
+ the type from ``input_file``.
107
127
  """
108
128
 
109
129
  syc_name = "ParticipantType"
@@ -112,8 +132,8 @@ class add_participant(InjectedCommand):
112
132
  """
113
133
  Name of the input file for the participant to be added.
114
134
  Currently supported formats are SCP files, Forte input (FTSIM)
115
- files, mechanical server (\*.rst) files, cfd server (\*.csv) files,
116
- FMU (.fmu) files (Beta), and system coupling data server (\*.scdt/axdt/csv) files.
135
+ files, mechanical server (*.rst) files, cfd server (*.csv) files,
136
+ and FMU (.fmu) files (Beta).
117
137
  """
118
138
 
119
139
  syc_name = "InputFile"
@@ -5,7 +5,6 @@
5
5
  from ansys.systemcoupling.core.adaptor.impl.types import *
6
6
 
7
7
  from .apip import apip
8
- from .automatic_alignment_options import automatic_alignment_options
9
8
  from .avoid_data_reconstruction import avoid_data_reconstruction
10
9
  from .global_stabilization import global_stabilization
11
10
  from .unmapped_value_options import unmapped_value_options
@@ -23,7 +22,6 @@ class analysis_control(Container):
23
22
  "apip",
24
23
  "avoid_data_reconstruction",
25
24
  "unmapped_value_options",
26
- "automatic_alignment_options",
27
25
  ]
28
26
 
29
27
  global_stabilization: global_stabilization = global_stabilization
@@ -42,26 +40,13 @@ class analysis_control(Container):
42
40
  """
43
41
  unmapped_value_options child of analysis_control.
44
42
  """
45
- automatic_alignment_options: automatic_alignment_options = (
46
- automatic_alignment_options
47
- )
48
- """
49
- automatic_alignment_options child of analysis_control.
50
- """
51
43
  property_names_types = [
52
44
  ("analysis_type", "AnalysisType", "str"),
53
45
  ("optimize_if_one_way", "OptimizeIfOneWay", "bool"),
54
46
  ("warped_face_tolerance", "WarpedFaceTolerance", "RealType"),
55
47
  ("allow_simultaneous_update", "AllowSimultaneousUpdate", "bool"),
56
48
  ("simultaneous_participants", "SimultaneousParticipants", "str"),
57
- (
58
- "allow_simultaneous_initialization",
59
- "AllowSimultaneousInitialization",
60
- "bool",
61
- ),
62
- ("mpi_pause_timeout", "MpiPauseTimeout", "RealType"),
63
49
  ("partitioning_algorithm", "PartitioningAlgorithm", "str"),
64
- ("cleanup_inflated_fm_us", "CleanupInflatedFMUs", "bool"),
65
50
  ("allow_iterations_only_mode", "AllowIterationsOnlyMode", "bool"),
66
51
  ("target_initialization_option", "TargetInitializationOption", "str"),
67
52
  ("fluent_region_update_at_step", "FluentRegionUpdateAtStep", "bool"),
@@ -129,24 +114,6 @@ class analysis_control(Container):
129
114
  def simultaneous_participants(self, value: str):
130
115
  self.set_property_state("simultaneous_participants", value)
131
116
 
132
- @property
133
- def allow_simultaneous_initialization(self) -> bool:
134
- """Allow simultaneous initialization of participants."""
135
- return self.get_property_state("allow_simultaneous_initialization")
136
-
137
- @allow_simultaneous_initialization.setter
138
- def allow_simultaneous_initialization(self, value: bool):
139
- self.set_property_state("allow_simultaneous_initialization", value)
140
-
141
- @property
142
- def mpi_pause_timeout(self) -> RealType:
143
- """Specify MPI pause time (in seconds) to wait for other participants to finish solving"""
144
- return self.get_property_state("mpi_pause_timeout")
145
-
146
- @mpi_pause_timeout.setter
147
- def mpi_pause_timeout(self, value: RealType):
148
- self.set_property_state("mpi_pause_timeout", value)
149
-
150
117
  @property
151
118
  def partitioning_algorithm(self) -> str:
152
119
  """Partitioning algorithm used when participants are running in parallel.
@@ -168,15 +135,6 @@ class analysis_control(Container):
168
135
  def partitioning_algorithm(self, value: str):
169
136
  self.set_property_state("partitioning_algorithm", value)
170
137
 
171
- @property
172
- def cleanup_inflated_fm_us(self) -> bool:
173
- """Controls whether System Coupling will cleanup inflated FMUs at end of analysis."""
174
- return self.get_property_state("cleanup_inflated_fm_us")
175
-
176
- @cleanup_inflated_fm_us.setter
177
- def cleanup_inflated_fm_us(self, value: bool):
178
- self.set_property_state("cleanup_inflated_fm_us", value)
179
-
180
138
  @property
181
139
  def allow_iterations_only_mode(self) -> bool:
182
140
  """Explicitly set whether iterations-only mode is allowed."""
@@ -15,7 +15,6 @@ class avoid_data_reconstruction(Container):
15
15
  property_names_types = [
16
16
  ("volume_mapping", "VolumeMapping", "bool"),
17
17
  ("surface_mapping", "SurfaceMapping", "bool"),
18
- ("surface_volume_mapping", "SurfaceVolumeMapping", "bool"),
19
18
  ]
20
19
 
21
20
  @property
@@ -35,12 +34,3 @@ class avoid_data_reconstruction(Container):
35
34
  @surface_mapping.setter
36
35
  def surface_mapping(self, value: bool):
37
36
  self.set_property_state("surface_mapping", value)
38
-
39
- @property
40
- def surface_volume_mapping(self) -> bool:
41
- """UNDOCUMENTED"""
42
- return self.get_property_state("surface_volume_mapping")
43
-
44
- @surface_volume_mapping.setter
45
- def surface_volume_mapping(self, value: bool):
46
- self.set_property_state("surface_volume_mapping", value)
@@ -2,12 +2,13 @@
2
2
  # This is an auto-generated file. DO NOT EDIT!
3
3
  #
4
4
 
5
- SHASH = "430648f7df949b91819d62a5c2d5a5c49d1d67217fb3474ee31e0c78e5ffbd43"
5
+ SHASH = "0fbfd3e7593591d8e52193a6e92828c6174e531b26437aee17285b3d0d114664"
6
6
 
7
7
  from ansys.systemcoupling.core.adaptor.impl.types import *
8
8
 
9
9
  from .clear_state import clear_state
10
10
  from .delete_snapshot import delete_snapshot
11
+ from .get_snapshots import get_snapshots
11
12
  from .open import open
12
13
  from .open_snapshot import open_snapshot
13
14
  from .save import save
@@ -24,6 +25,7 @@ class case_root(Container):
24
25
  command_names = [
25
26
  "clear_state",
26
27
  "delete_snapshot",
28
+ "get_snapshots",
27
29
  "open",
28
30
  "open_snapshot",
29
31
  "save",
@@ -38,6 +40,10 @@ class case_root(Container):
38
40
  """
39
41
  delete_snapshot command of case_root.
40
42
  """
43
+ get_snapshots: get_snapshots = get_snapshots
44
+ """
45
+ get_snapshots command of case_root.
46
+ """
41
47
  open: open = open
42
48
  """
43
49
  open command of case_root.
@@ -7,8 +7,6 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
7
7
  from .execution_control import execution_control
8
8
  from .external_data_file import external_data_file
9
9
  from .fmu_parameter import fmu_parameter
10
- from .parameter import parameter
11
- from .record_interactions import record_interactions
12
10
  from .region import region
13
11
  from .update_control import update_control
14
12
  from .variable import variable
@@ -26,23 +24,17 @@ class coupling_participant_child(Container):
26
24
 
27
25
  child_names = [
28
26
  "variable",
29
- "parameter",
30
27
  "region",
31
28
  "update_control",
32
29
  "fmu_parameter",
33
30
  "execution_control",
34
31
  "external_data_file",
35
- "record_interactions",
36
32
  ]
37
33
 
38
34
  variable: variable = variable
39
35
  """
40
36
  variable child of coupling_participant_child.
41
37
  """
42
- parameter: parameter = parameter
43
- """
44
- parameter child of coupling_participant_child.
45
- """
46
38
  region: region = region
47
39
  """
48
40
  region child of coupling_participant_child.
@@ -63,29 +55,17 @@ class coupling_participant_child(Container):
63
55
  """
64
56
  external_data_file child of coupling_participant_child.
65
57
  """
66
- record_interactions: record_interactions = record_interactions
67
- """
68
- record_interactions child of coupling_participant_child.
69
- """
70
58
  property_names_types = [
71
59
  ("participant_type", "ParticipantType", "str"),
72
60
  ("participant_display_name", "ParticipantDisplayName", "str"),
73
61
  ("display_name", "DisplayName", "str"),
74
62
  ("dimension", "Dimension", "str"),
75
- ("input_variables", "InputVariables", "StringListType"),
76
- ("output_variables", "OutputVariables", "StringListType"),
77
- ("input_parameters", "InputParameters", "StringListType"),
78
- ("output_parameters", "OutputParameters", "StringListType"),
79
63
  ("participant_file_loaded", "ParticipantFileLoaded", "str"),
80
64
  ("logging_on", "LoggingOn", "bool"),
81
65
  ("participant_analysis_type", "ParticipantAnalysisType", "str"),
82
66
  ("use_new_apis", "UseNewAPIs", "bool"),
83
67
  ("restarts_supported", "RestartsSupported", "bool"),
84
- ("can_serialize_fmu_state", "CanSerializeFmuState", "bool"),
85
- ("can_get_and_set_fmu_state", "CanGetAndSetFmuState", "bool"),
86
- ("free_fmu_state", "FreeFmuState", "bool"),
87
68
  ("instancing", "Instancing", "str"),
88
- ("accepts_new_inputs", "AcceptsNewInputs", "bool"),
89
69
  ]
90
70
 
91
71
  @property
@@ -103,10 +83,7 @@ class coupling_participant_child(Container):
103
83
  - \"FORTE\"
104
84
  - \"DEFAULT-SRV\"
105
85
  - \"MECH-SRV\"
106
- - \"CFD-SRV\"
107
- - \"SCDT-SRV\"
108
- - \"THERMAL-DESKTOP\"
109
- - \"LS-DYNA\" """
86
+ - \"CFD-SRV\" """
110
87
  return self.get_property_state("participant_type")
111
88
 
112
89
  @participant_type.setter
@@ -141,42 +118,6 @@ class coupling_participant_child(Container):
141
118
  def dimension(self, value: str):
142
119
  self.set_property_state("dimension", value)
143
120
 
144
- @property
145
- def input_variables(self) -> StringListType:
146
- """Input variables for the region or FMU."""
147
- return self.get_property_state("input_variables")
148
-
149
- @input_variables.setter
150
- def input_variables(self, value: StringListType):
151
- self.set_property_state("input_variables", value)
152
-
153
- @property
154
- def output_variables(self) -> StringListType:
155
- """Output variables for the region or FMU."""
156
- return self.get_property_state("output_variables")
157
-
158
- @output_variables.setter
159
- def output_variables(self, value: StringListType):
160
- self.set_property_state("output_variables", value)
161
-
162
- @property
163
- def input_parameters(self) -> StringListType:
164
- """Input parameters for the solver."""
165
- return self.get_property_state("input_parameters")
166
-
167
- @input_parameters.setter
168
- def input_parameters(self, value: StringListType):
169
- self.set_property_state("input_parameters", value)
170
-
171
- @property
172
- def output_parameters(self) -> StringListType:
173
- """Output parameters for the solver."""
174
- return self.get_property_state("output_parameters")
175
-
176
- @output_parameters.setter
177
- def output_parameters(self, value: StringListType):
178
- self.set_property_state("output_parameters", value)
179
-
180
121
  @property
181
122
  def participant_file_loaded(self) -> str:
182
123
  """File used to generate the participant."""
@@ -206,7 +147,7 @@ class coupling_participant_child(Container):
206
147
 
207
148
  @property
208
149
  def use_new_apis(self) -> bool:
209
- """Controls whether Fluent/MAPDL/AEDT/CFX participant should communicate using new APIs."""
150
+ """Controls whether a Fluent or MAPDL participant should communicate using new APIs."""
210
151
  return self.get_property_state("use_new_apis")
211
152
 
212
153
  @use_new_apis.setter
@@ -222,33 +163,6 @@ class coupling_participant_child(Container):
222
163
  def restarts_supported(self, value: bool):
223
164
  self.set_property_state("restarts_supported", value)
224
165
 
225
- @property
226
- def can_serialize_fmu_state(self) -> bool:
227
- """Indicates whether the FMU can state can be serialized."""
228
- return self.get_property_state("can_serialize_fmu_state")
229
-
230
- @can_serialize_fmu_state.setter
231
- def can_serialize_fmu_state(self, value: bool):
232
- self.set_property_state("can_serialize_fmu_state", value)
233
-
234
- @property
235
- def can_get_and_set_fmu_state(self) -> bool:
236
- """Indicates whether the FMU can get and set its state."""
237
- return self.get_property_state("can_get_and_set_fmu_state")
238
-
239
- @can_get_and_set_fmu_state.setter
240
- def can_get_and_set_fmu_state(self, value: bool):
241
- self.set_property_state("can_get_and_set_fmu_state", value)
242
-
243
- @property
244
- def free_fmu_state(self) -> bool:
245
- """Optionally Frees the FMU state prior to calling CanGetAndSetFmuState"""
246
- return self.get_property_state("free_fmu_state")
247
-
248
- @free_fmu_state.setter
249
- def free_fmu_state(self, value: bool):
250
- self.set_property_state("free_fmu_state", value)
251
-
252
166
  @property
253
167
  def instancing(self) -> str:
254
168
  """Set instancing on the participant."""
@@ -257,12 +171,3 @@ class coupling_participant_child(Container):
257
171
  @instancing.setter
258
172
  def instancing(self, value: str):
259
173
  self.set_property_state("instancing", value)
260
-
261
- @property
262
- def accepts_new_inputs(self) -> bool:
263
- """Controls whether participant accept new input variables or parameters."""
264
- return self.get_property_state("accepts_new_inputs")
265
-
266
- @accepts_new_inputs.setter
267
- def accepts_new_inputs(self, value: bool):
268
- self.set_property_state("accepts_new_inputs", value)
@@ -25,8 +25,6 @@ class execution_control(Container):
25
25
  ("working_directory", "WorkingDirectory", "str"),
26
26
  ("executable", "Executable", "str"),
27
27
  ("auto_distribution_settings", "AutoDistributionSettings", "bool"),
28
- ("use_ls_dyna_custom_executable", "UseLsDynaCustomExecutable", "bool"),
29
- ("ls_dyna_custom_executable", "LsDynaCustomExecutable", "str"),
30
28
  (
31
29
  "include_hpc_distribution_types",
32
30
  "IncludeHPCDistributionTypes",
@@ -42,7 +40,6 @@ class execution_control(Container):
42
40
  ("base_output_file_name", "BaseOutputFileName", "str"),
43
41
  ("overwrite_existing_files", "OverwriteExistingFiles", "bool"),
44
42
  ("mass_normalized", "MassNormalized", "bool"),
45
- ("write_output", "WriteOutput", "bool"),
46
43
  ]
47
44
 
48
45
  @property
@@ -89,24 +86,6 @@ class execution_control(Container):
89
86
  def auto_distribution_settings(self, value: bool):
90
87
  self.set_property_state("auto_distribution_settings", value)
91
88
 
92
- @property
93
- def use_ls_dyna_custom_executable(self) -> bool:
94
- """Specify whether to use custom executable for LS-DYNA."""
95
- return self.get_property_state("use_ls_dyna_custom_executable")
96
-
97
- @use_ls_dyna_custom_executable.setter
98
- def use_ls_dyna_custom_executable(self, value: bool):
99
- self.set_property_state("use_ls_dyna_custom_executable", value)
100
-
101
- @property
102
- def ls_dyna_custom_executable(self) -> str:
103
- """Path to LS-DYNA executable."""
104
- return self.get_property_state("ls_dyna_custom_executable")
105
-
106
- @ls_dyna_custom_executable.setter
107
- def ls_dyna_custom_executable(self, value: str):
108
- self.set_property_state("ls_dyna_custom_executable", value)
109
-
110
89
  @property
111
90
  def include_hpc_distribution_types(self) -> StringListType:
112
91
  """Include HPC distribution types for the distributed AEDT runs."""
@@ -181,7 +160,7 @@ class execution_control(Container):
181
160
 
182
161
  @property
183
162
  def base_output_file_name(self) -> str:
184
- """Base output file name for the CFD Server or SCDT Server."""
163
+ """Base output file name for the CFD Server."""
185
164
  return self.get_property_state("base_output_file_name")
186
165
 
187
166
  @base_output_file_name.setter
@@ -205,12 +184,3 @@ class execution_control(Container):
205
184
  @mass_normalized.setter
206
185
  def mass_normalized(self, value: bool):
207
186
  self.set_property_state("mass_normalized", value)
208
-
209
- @property
210
- def write_output(self) -> bool:
211
- """Controls whether export scdt files for the SCDT Server"""
212
- return self.get_property_state("write_output")
213
-
214
- @write_output.setter
215
- def write_output(self, value: bool):
216
- self.set_property_state("write_output", value)
@@ -16,7 +16,6 @@ class fluent_input(Container):
16
16
  ("option", "Option", "str"),
17
17
  ("case_file", "CaseFile", "str"),
18
18
  ("data_file", "DataFile", "str"),
19
- ("enable_autosave", "EnableAutosave", "bool"),
20
19
  ("journal_file", "JournalFile", "str"),
21
20
  ]
22
21
 
@@ -58,15 +57,6 @@ class fluent_input(Container):
58
57
  def data_file(self, value: str):
59
58
  self.set_property_state("data_file", value)
60
59
 
61
- @property
62
- def enable_autosave(self) -> bool:
63
- """Set Fluent autosave frequency to System Coupling output control frequency to generate .flprj file."""
64
- return self.get_property_state("enable_autosave")
65
-
66
- @enable_autosave.setter
67
- def enable_autosave(self, value: bool):
68
- self.set_property_state("enable_autosave", value)
69
-
70
60
  @property
71
61
  def journal_file(self) -> str:
72
62
  """Set Fluent journal file."""