ansys-systemcoupling-core 0.9.0__py3-none-any.whl → 0.10.0__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.
- ansys/systemcoupling/core/__init__.py +1 -1
- ansys/systemcoupling/core/adaptor/api_25_2/add_data_transfer.py +9 -9
- ansys/systemcoupling/core/adaptor/api_25_2/add_interface.py +1 -1
- ansys/systemcoupling/core/adaptor/api_25_2/add_ordered_data_transfers.py +12 -3
- ansys/systemcoupling/core/adaptor/api_25_2/add_participant.py +27 -12
- ansys/systemcoupling/core/adaptor/api_25_2/add_transformation.py +14 -14
- ansys/systemcoupling/core/adaptor/api_25_2/analysis_control.py +30 -0
- ansys/systemcoupling/core/adaptor/api_25_2/attribute.py +1 -1
- ansys/systemcoupling/core/adaptor/api_25_2/attribute_child.py +12 -2
- ansys/systemcoupling/core/adaptor/api_25_2/case_root.py +1 -1
- ansys/systemcoupling/core/adaptor/api_25_2/create_restart_point.py +4 -5
- ansys/systemcoupling/core/adaptor/api_25_2/data_transfer_child.py +9 -1
- ansys/systemcoupling/core/adaptor/api_25_2/delete_snapshot.py +3 -1
- ansys/systemcoupling/core/adaptor/api_25_2/execution_control.py +10 -0
- ansys/systemcoupling/core/adaptor/api_25_2/generate_input_file.py +12 -0
- ansys/systemcoupling/core/adaptor/api_25_2/get_execution_command.py +1 -1
- ansys/systemcoupling/core/adaptor/api_25_2/get_machines.py +22 -1
- ansys/systemcoupling/core/adaptor/api_25_2/get_region_names_for_participant.py +6 -5
- ansys/systemcoupling/core/adaptor/api_25_2/mapping_control.py +24 -0
- ansys/systemcoupling/core/adaptor/api_25_2/open.py +19 -14
- ansys/systemcoupling/core/adaptor/api_25_2/partition_participants.py +48 -38
- ansys/systemcoupling/core/adaptor/api_25_2/save.py +17 -15
- ansys/systemcoupling/core/adaptor/api_25_2/setup_root.py +1 -17
- ansys/systemcoupling/core/adaptor/api_25_2/solution_control.py +10 -0
- ansys/systemcoupling/core/adaptor/api_25_2/solution_root.py +1 -1
- ansys/systemcoupling/core/adaptor/api_25_2/solve.py +5 -5
- ansys/systemcoupling/core/adaptor/api_25_2/update_participant.py +4 -4
- ansys/systemcoupling/core/adaptor/impl/get_syc_version.py +4 -1
- ansys/systemcoupling/core/adaptor/impl/injected_commands.py +3 -1
- ansys/systemcoupling/core/adaptor/impl/syc_proxy.py +34 -4
- ansys/systemcoupling/core/charts/csv_chartdata.py +4 -3
- ansys/systemcoupling/core/charts/plot_functions.py +12 -4
- ansys/systemcoupling/core/charts/plotter.py +3 -2
- ansys/systemcoupling/core/client/grpc_client.py +11 -2
- ansys/systemcoupling/core/client/syc_container.py +40 -35
- ansys/systemcoupling/core/client/syc_process.py +5 -2
- ansys/systemcoupling/core/native_api/datamodel_metadata.py +3 -2
- ansys/systemcoupling/core/native_api/object_path.py +2 -1
- ansys/systemcoupling/core/syc_version.py +1 -1
- ansys/systemcoupling/core/util/assertion.py +38 -0
- ansys/systemcoupling/core/util/file_transfer.py +2 -1
- ansys/systemcoupling/core/util/state_keys.py +11 -2
- ansys/systemcoupling/core/util/yaml_helper.py +5 -5
- {ansys_systemcoupling_core-0.9.0.dist-info → ansys_systemcoupling_core-0.10.0.dist-info}/METADATA +14 -8
- {ansys_systemcoupling_core-0.9.0.dist-info → ansys_systemcoupling_core-0.10.0.dist-info}/RECORD +47 -48
- {ansys_systemcoupling_core-0.9.0.dist-info → ansys_systemcoupling_core-0.10.0.dist-info}/WHEEL +1 -1
- ansys/systemcoupling/core/adaptor/api_25_2/add_data_transfer_by_display_names.py +0 -191
- ansys/systemcoupling/core/adaptor/api_25_2/add_interface_by_display_names.py +0 -78
- {ansys_systemcoupling_core-0.9.0.dist-info → ansys_systemcoupling_core-0.10.0.dist-info}/licenses/LICENSE +0 -0
|
@@ -72,7 +72,7 @@ def launch(
|
|
|
72
72
|
(The forms ``"24.1"`` and ``"24_1"`` are also acceptable.)
|
|
73
73
|
The version will be sought in the standard installation location. The
|
|
74
74
|
default is ``None``, which is equivalent to specifying
|
|
75
|
-
``"
|
|
75
|
+
``"252"`` ("2025 R2" release), unless either of the environment
|
|
76
76
|
variables ``SYSC_ROOT`` or ``AWP_ROOT`` has been set. It is considered
|
|
77
77
|
to be an error if either these is set *and* ``version`` is provided.
|
|
78
78
|
start_output: bool, optional
|
|
@@ -9,10 +9,10 @@ class add_data_transfer(Command):
|
|
|
9
9
|
"""
|
|
10
10
|
Adds data transfer based on arguments that specify the interface, target
|
|
11
11
|
side, and variables to be associated with each side of the interface.
|
|
12
|
-
The command requires that you specify variables using their names
|
|
13
|
-
|
|
12
|
+
The command requires that you specify variables using their names, as
|
|
13
|
+
described below in Essential Keyword Arguments. Either a variable-based or
|
|
14
14
|
expression-based data transfer may be created with this command based on
|
|
15
|
-
the
|
|
15
|
+
the Optional Keyword Arguments. If a variable-based data transfer argument
|
|
16
16
|
is given, then no expression-based data transfer arguments can be used. If
|
|
17
17
|
an expression-based data transfer argument is given, then no variable-based
|
|
18
18
|
data transfer arguments can be used.
|
|
@@ -36,8 +36,8 @@ class add_data_transfer(Command):
|
|
|
36
36
|
target_variable : str, optional
|
|
37
37
|
String specifying the name of the variable on the target side of
|
|
38
38
|
the data transfer. Must be combined with either ``source_variable`` (when
|
|
39
|
-
creating a variable-based data transfer) or with ``
|
|
40
|
-
|
|
39
|
+
creating a variable-based data transfer) or with ``value_{x|y|z}``
|
|
40
|
+
(when creating an expression-based data transfer).
|
|
41
41
|
value : str, optional
|
|
42
42
|
String specifying the expression to use on the source side of the data
|
|
43
43
|
transfer. Used when creating an expression-based data transfer. If the
|
|
@@ -48,7 +48,7 @@ class add_data_transfer(Command):
|
|
|
48
48
|
String specifying the X component of the expression to use on the
|
|
49
49
|
source side of the data transfer. This may optionally be used when creating
|
|
50
50
|
an expression-based data transfer if the ``target_variable`` is a vector as an
|
|
51
|
-
alternative to specifying a vector-valued expression in ``value
|
|
51
|
+
alternative to specifying a vector-valued expression in ``value``. ``value_y`` and
|
|
52
52
|
``value_z`` are also required if ``value_x`` is used.
|
|
53
53
|
value_y : str, optional
|
|
54
54
|
String specifying the Y component of the expression to use on the
|
|
@@ -119,8 +119,8 @@ class add_data_transfer(Command):
|
|
|
119
119
|
"""
|
|
120
120
|
String specifying the name of the variable on the target side of
|
|
121
121
|
the data transfer. Must be combined with either ``source_variable`` (when
|
|
122
|
-
creating a variable-based data transfer) or with ``
|
|
123
|
-
|
|
122
|
+
creating a variable-based data transfer) or with ``value_{x|y|z}``
|
|
123
|
+
(when creating an expression-based data transfer).
|
|
124
124
|
"""
|
|
125
125
|
|
|
126
126
|
syc_name = "TargetVariable"
|
|
@@ -141,7 +141,7 @@ class add_data_transfer(Command):
|
|
|
141
141
|
String specifying the X component of the expression to use on the
|
|
142
142
|
source side of the data transfer. This may optionally be used when creating
|
|
143
143
|
an expression-based data transfer if the ``target_variable`` is a vector as an
|
|
144
|
-
alternative to specifying a vector-valued expression in ``value
|
|
144
|
+
alternative to specifying a vector-valued expression in ``value``. ``value_y`` and
|
|
145
145
|
``value_z`` are also required if ``value_x`` is used.
|
|
146
146
|
"""
|
|
147
147
|
|
|
@@ -10,7 +10,7 @@ class add_interface(Command):
|
|
|
10
10
|
Adds an interface based on the participant and region names specified
|
|
11
11
|
as arguments for each side of the interface. This command requires that
|
|
12
12
|
you specify participants using their names as described below in
|
|
13
|
-
Essential Keyword Arguments. Non-FMU participants
|
|
13
|
+
Essential Keyword Arguments. Non-FMU participants can provide a list
|
|
14
14
|
of regions as described below in Optional Keyword Arguments. For FMU
|
|
15
15
|
interfaces, specifying the regions are not allowed.
|
|
16
16
|
|
|
@@ -7,9 +7,18 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
|
|
|
7
7
|
|
|
8
8
|
class add_ordered_data_transfers(Command):
|
|
9
9
|
"""
|
|
10
|
-
Adds data transfer for each ordered pair of variables in an
|
|
11
|
-
|
|
12
|
-
|
|
10
|
+
Adds data transfer for each ordered pair of variables in an
|
|
11
|
+
FMU-FMU interface. Requires the FMU-FMU interface. Requires
|
|
12
|
+
that the target FMU has the same number of input variables
|
|
13
|
+
as the source FMU has output variables.
|
|
14
|
+
The transfers are added in order. That is, the n-th output
|
|
15
|
+
variable for side one will be connected to the n-th input
|
|
16
|
+
variable for side two. This is only available for interfaces
|
|
17
|
+
with FMUs on both side one and side two.
|
|
18
|
+
|
|
19
|
+
Data transfers will be created in both directions, if possible.
|
|
20
|
+
|
|
21
|
+
Returns the name of the data transfers created.
|
|
13
22
|
|
|
14
23
|
Parameters
|
|
15
24
|
----------
|
|
@@ -31,13 +31,8 @@ class add_participant(InjectedCommand):
|
|
|
31
31
|
|
|
32
32
|
The remainder of the documentation describes the more usual non-session mode.
|
|
33
33
|
|
|
34
|
-
Adds a coupling participant to the
|
|
35
|
-
|
|
36
|
-
When executed, this command adds the new participant to the analysis
|
|
37
|
-
without removing any interfaces or data transfers created previously.
|
|
38
|
-
|
|
34
|
+
Adds a coupling participant to the setup.
|
|
39
35
|
Cannot be called after participants have been started.
|
|
40
|
-
|
|
41
36
|
Returns the name of the participant.
|
|
42
37
|
|
|
43
38
|
There are several options that can be selected to add the
|
|
@@ -76,8 +71,8 @@ class add_participant(InjectedCommand):
|
|
|
76
71
|
input_file : str, optional
|
|
77
72
|
Name of the input file for the participant to be added.
|
|
78
73
|
Currently supported formats are SCP files, Forte input (FTSIM)
|
|
79
|
-
files,
|
|
80
|
-
FMU (\*.fmu) files, and System Coupling
|
|
74
|
+
files, Mechanical Server (\*.rst) files, CFD Server (\*.csv) files,
|
|
75
|
+
FMU (\*.fmu) files, and System Coupling Data Server (\*.scdt/axdt/csv) files.
|
|
81
76
|
executable : str, optional
|
|
82
77
|
Path to the executable file for the participant to be added.
|
|
83
78
|
additional_arguments : str, optional
|
|
@@ -87,7 +82,17 @@ class add_participant(InjectedCommand):
|
|
|
87
82
|
python_script : str, optional
|
|
88
83
|
Instead of the executable, use a Python script and wrap it with
|
|
89
84
|
System Coupling-provided .bat/.sh scripts to set up the environment
|
|
90
|
-
correctly before calling this Python script.
|
|
85
|
+
correctly before calling this Python script. On Windows, a few
|
|
86
|
+
lines will need to be included near the top of the Python script to
|
|
87
|
+
add the required dll directories as follows:
|
|
88
|
+
|
|
89
|
+
.. code-block:: python
|
|
90
|
+
|
|
91
|
+
import os
|
|
92
|
+
import sys
|
|
93
|
+
if sys.platform.startswith("win"):
|
|
94
|
+
for p in os.environ["PYTHON_DLL_PATH"].split(os.pathsep):
|
|
95
|
+
os.add_dll_directory(p)
|
|
91
96
|
|
|
92
97
|
"""
|
|
93
98
|
|
|
@@ -125,8 +130,8 @@ class add_participant(InjectedCommand):
|
|
|
125
130
|
"""
|
|
126
131
|
Name of the input file for the participant to be added.
|
|
127
132
|
Currently supported formats are SCP files, Forte input (FTSIM)
|
|
128
|
-
files,
|
|
129
|
-
FMU (\*.fmu) files, and System Coupling
|
|
133
|
+
files, Mechanical Server (\*.rst) files, CFD Server (\*.csv) files,
|
|
134
|
+
FMU (\*.fmu) files, and System Coupling Data Server (\*.scdt/axdt/csv) files.
|
|
130
135
|
"""
|
|
131
136
|
|
|
132
137
|
syc_name = "InputFile"
|
|
@@ -156,7 +161,17 @@ class add_participant(InjectedCommand):
|
|
|
156
161
|
"""
|
|
157
162
|
Instead of the executable, use a Python script and wrap it with
|
|
158
163
|
System Coupling-provided .bat/.sh scripts to set up the environment
|
|
159
|
-
correctly before calling this Python script.
|
|
164
|
+
correctly before calling this Python script. On Windows, a few
|
|
165
|
+
lines will need to be included near the top of the Python script to
|
|
166
|
+
add the required dll directories as follows:
|
|
167
|
+
|
|
168
|
+
.. code-block:: python
|
|
169
|
+
|
|
170
|
+
import os
|
|
171
|
+
import sys
|
|
172
|
+
if sys.platform.startswith("win"):
|
|
173
|
+
for p in os.environ["PYTHON_DLL_PATH"].split(os.pathsep):
|
|
174
|
+
os.add_dll_directory(p)
|
|
160
175
|
"""
|
|
161
176
|
|
|
162
177
|
syc_name = "PythonScript"
|
|
@@ -28,22 +28,22 @@ class add_transformation(Command):
|
|
|
28
28
|
reference_frame : str
|
|
29
29
|
Name of the reference frame to which the transformation will be added.
|
|
30
30
|
transformation_type : str
|
|
31
|
-
Type of transformation to be added. Available options are
|
|
32
|
-
|
|
31
|
+
Type of transformation to be added. Available options are Rotation or
|
|
32
|
+
Translation
|
|
33
33
|
|
|
34
34
|
Required Parameters for Transformation Types:
|
|
35
35
|
Rotation: ``angle``, ``axis``, ``vector`` (if ``axis`` is \"UserDefined\")
|
|
36
36
|
Translation: ``vector``
|
|
37
37
|
angle : real, optional
|
|
38
|
-
Angle to rotate a reference frame. Used with
|
|
38
|
+
Angle to rotate a reference frame. Used with Rotation
|
|
39
39
|
``transformation_type``. Default unit is Radians.
|
|
40
40
|
axis : str, optional
|
|
41
41
|
Axis about which a rotation is applied. Used with
|
|
42
|
-
Rotation ``transformation_type``. Available options are:
|
|
43
|
-
|
|
42
|
+
Rotation ``transformation_type``. Available options are: "XAxis", "YAxis",
|
|
43
|
+
"ZAxis", and "UserDefined".
|
|
44
44
|
vector : Tuple, optional
|
|
45
|
-
A vector for use with
|
|
46
|
-
``transformation_type`` if the ``axis`` is
|
|
45
|
+
A vector for use with Translation ``transformation_type`` or Rotation
|
|
46
|
+
``transformation_type`` if the ``axis`` is "UserDefined".
|
|
47
47
|
|
|
48
48
|
"""
|
|
49
49
|
|
|
@@ -66,8 +66,8 @@ class add_transformation(Command):
|
|
|
66
66
|
|
|
67
67
|
class transformation_type(String):
|
|
68
68
|
"""
|
|
69
|
-
Type of transformation to be added. Available options are
|
|
70
|
-
|
|
69
|
+
Type of transformation to be added. Available options are Rotation or
|
|
70
|
+
Translation
|
|
71
71
|
|
|
72
72
|
Required Parameters for Transformation Types:
|
|
73
73
|
Rotation: ``angle``, ``axis``, ``vector`` (if ``axis`` is \"UserDefined\")
|
|
@@ -78,7 +78,7 @@ class add_transformation(Command):
|
|
|
78
78
|
|
|
79
79
|
class angle(Real):
|
|
80
80
|
"""
|
|
81
|
-
Angle to rotate a reference frame. Used with
|
|
81
|
+
Angle to rotate a reference frame. Used with Rotation
|
|
82
82
|
``transformation_type``. Default unit is Radians.
|
|
83
83
|
"""
|
|
84
84
|
|
|
@@ -87,16 +87,16 @@ class add_transformation(Command):
|
|
|
87
87
|
class axis(String):
|
|
88
88
|
"""
|
|
89
89
|
Axis about which a rotation is applied. Used with
|
|
90
|
-
Rotation ``transformation_type``. Available options are:
|
|
91
|
-
|
|
90
|
+
Rotation ``transformation_type``. Available options are: "XAxis", "YAxis",
|
|
91
|
+
"ZAxis", and "UserDefined".
|
|
92
92
|
"""
|
|
93
93
|
|
|
94
94
|
syc_name = "Axis"
|
|
95
95
|
|
|
96
96
|
class vector(RealVector):
|
|
97
97
|
"""
|
|
98
|
-
A vector for use with
|
|
99
|
-
``transformation_type`` if the ``axis`` is
|
|
98
|
+
A vector for use with Translation ``transformation_type`` or Rotation
|
|
99
|
+
``transformation_type`` if the ``axis`` is "UserDefined".
|
|
100
100
|
"""
|
|
101
101
|
|
|
102
102
|
syc_name = "Vector"
|
|
@@ -79,6 +79,9 @@ class analysis_control(Container):
|
|
|
79
79
|
("check_for_input_files_changes", "CheckForInputFilesChanges", "str"),
|
|
80
80
|
("is_user_friendly_mapping", "IsUserFriendlyMapping", "bool"),
|
|
81
81
|
("reduce_informational_output", "ReduceInformationalOutput", "bool"),
|
|
82
|
+
("participant_precision", "ParticipantPrecision", "str"),
|
|
83
|
+
("avoid_rbf", "AvoidRBF", "str"),
|
|
84
|
+
("interactive_initialization", "InteractiveInitialization", "bool"),
|
|
82
85
|
]
|
|
83
86
|
|
|
84
87
|
@property
|
|
@@ -301,3 +304,30 @@ class analysis_control(Container):
|
|
|
301
304
|
@reduce_informational_output.setter
|
|
302
305
|
def reduce_informational_output(self, value: bool):
|
|
303
306
|
self.set_property_state("reduce_informational_output", value)
|
|
307
|
+
|
|
308
|
+
@property
|
|
309
|
+
def participant_precision(self) -> str:
|
|
310
|
+
"""Set global option for participant precision"""
|
|
311
|
+
return self.get_property_state("participant_precision")
|
|
312
|
+
|
|
313
|
+
@participant_precision.setter
|
|
314
|
+
def participant_precision(self, value: str):
|
|
315
|
+
self.set_property_state("participant_precision", value)
|
|
316
|
+
|
|
317
|
+
@property
|
|
318
|
+
def avoid_rbf(self) -> str:
|
|
319
|
+
"""UNDOCUMENTED"""
|
|
320
|
+
return self.get_property_state("avoid_rbf")
|
|
321
|
+
|
|
322
|
+
@avoid_rbf.setter
|
|
323
|
+
def avoid_rbf(self, value: str):
|
|
324
|
+
self.set_property_state("avoid_rbf", value)
|
|
325
|
+
|
|
326
|
+
@property
|
|
327
|
+
def interactive_initialization(self) -> bool:
|
|
328
|
+
"""Controls whether using interactive initialization for cosim"""
|
|
329
|
+
return self.get_property_state("interactive_initialization")
|
|
330
|
+
|
|
331
|
+
@interactive_initialization.setter
|
|
332
|
+
def interactive_initialization(self, value: bool):
|
|
333
|
+
self.set_property_state("interactive_initialization", value)
|
|
@@ -9,7 +9,7 @@ from .dimensionality import dimensionality
|
|
|
9
9
|
|
|
10
10
|
class attribute_child(Container):
|
|
11
11
|
"""
|
|
12
|
-
Configure
|
|
12
|
+
Configure an attribute.
|
|
13
13
|
"""
|
|
14
14
|
|
|
15
15
|
syc_name = "child_object_type"
|
|
@@ -25,11 +25,12 @@ class attribute_child(Container):
|
|
|
25
25
|
("modifiable", "Modifiable", "bool"),
|
|
26
26
|
("real_value", "RealValue", "RealType"),
|
|
27
27
|
("integer_value", "IntegerValue", "int"),
|
|
28
|
+
("string_value", "StringValue", "str"),
|
|
28
29
|
]
|
|
29
30
|
|
|
30
31
|
@property
|
|
31
32
|
def attribute_type(self) -> str:
|
|
32
|
-
"""The type of the attribute (\"Real\" or \"
|
|
33
|
+
"""The type of the attribute (\"Real\", \"Integer\", or \"String\")."""
|
|
33
34
|
return self.get_property_state("attribute_type")
|
|
34
35
|
|
|
35
36
|
@attribute_type.setter
|
|
@@ -62,3 +63,12 @@ class attribute_child(Container):
|
|
|
62
63
|
@integer_value.setter
|
|
63
64
|
def integer_value(self, value: int):
|
|
64
65
|
self.set_property_state("integer_value", value)
|
|
66
|
+
|
|
67
|
+
@property
|
|
68
|
+
def string_value(self) -> str:
|
|
69
|
+
"""String attribute value."""
|
|
70
|
+
return self.get_property_state("string_value")
|
|
71
|
+
|
|
72
|
+
@string_value.setter
|
|
73
|
+
def string_value(self, value: str):
|
|
74
|
+
self.set_property_state("string_value", value)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
# This is an auto-generated file. DO NOT EDIT!
|
|
3
3
|
#
|
|
4
4
|
|
|
5
|
-
SHASH = "
|
|
5
|
+
SHASH = "959d876aeac97f5477abdc73030965f3b5cf57f93648d88535c634374191caa8"
|
|
6
6
|
|
|
7
7
|
from ansys.systemcoupling.core.adaptor.impl.types import *
|
|
8
8
|
|
|
@@ -13,17 +13,16 @@ class create_restart_point(Command):
|
|
|
13
13
|
Signals the System Coupling service and all coupling participants that a
|
|
14
14
|
restart point should be created before the next coupling step begins. The
|
|
15
15
|
restart point is created in addition to restart points created by the
|
|
16
|
-
``output_control`` setting in the data model.
|
|
16
|
+
'``output_control`` setting in the data model.
|
|
17
17
|
|
|
18
18
|
Note that some participants write their restart files only when the
|
|
19
19
|
coupling run resumes, so their files will not be available immediately
|
|
20
20
|
after the command is issued.
|
|
21
21
|
|
|
22
22
|
Results information for the coupling step is written to a file named
|
|
23
|
-
according to the convention ``
|
|
24
|
-
the coupling step
|
|
25
|
-
directory, which is automatically created by
|
|
26
|
-
when restart points are created.
|
|
23
|
+
according to the convention ``Results_step<#>|iter<#>.h5``, where ``#`` is the number of
|
|
24
|
+
the coupling step or iteration. The restart files are written to the "SyC"
|
|
25
|
+
directory, which is automatically created by System Coupling.
|
|
27
26
|
"""
|
|
28
27
|
|
|
29
28
|
syc_name = "CreateRestartPoint"
|
|
@@ -170,7 +170,15 @@ class data_transfer_child(Container):
|
|
|
170
170
|
|
|
171
171
|
@property
|
|
172
172
|
def unmapped_value_option(self) -> str:
|
|
173
|
-
"""Option to fill target values not mapped by the regular mapping algorithm
|
|
173
|
+
"""Option to fill target values not mapped by the regular mapping algorithm.
|
|
174
|
+
|
|
175
|
+
Possible values:
|
|
176
|
+
|
|
177
|
+
- \"ProgramControlled\" - Program decides the best algorithm depending on the data topologies and locations.
|
|
178
|
+
- \"Nearest Value\" - Copy the data from the nearest mapped target location.
|
|
179
|
+
- \"Interpolation\" - Smoothly interpolate the data based on nearby mapped target locations.
|
|
180
|
+
- \"Extrapolation\" - Smoothly extrapolate the data based on nearby mapped target locations.
|
|
181
|
+
"""
|
|
174
182
|
return self.get_property_state("unmapped_value_option")
|
|
175
183
|
|
|
176
184
|
@unmapped_value_option.setter
|
|
@@ -7,7 +7,9 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
|
|
|
7
7
|
|
|
8
8
|
class delete_snapshot(Command):
|
|
9
9
|
"""
|
|
10
|
-
Deletes
|
|
10
|
+
Deletes the specified snapshot.
|
|
11
|
+
If the snapshot does not exist, an error will
|
|
12
|
+
be raised.
|
|
11
13
|
|
|
12
14
|
Parameters
|
|
13
15
|
----------
|
|
@@ -47,6 +47,7 @@ class execution_control(Container):
|
|
|
47
47
|
("mass_normalized", "MassNormalized", "bool"),
|
|
48
48
|
("write_output", "WriteOutput", "bool"),
|
|
49
49
|
("environment_variables", "EnvironmentVariables", "StringListType"),
|
|
50
|
+
("precision", "Precision", "str"),
|
|
50
51
|
]
|
|
51
52
|
|
|
52
53
|
@property
|
|
@@ -254,3 +255,12 @@ class execution_control(Container):
|
|
|
254
255
|
@environment_variables.setter
|
|
255
256
|
def environment_variables(self, value: StringListType):
|
|
256
257
|
self.set_property_state("environment_variables", value)
|
|
258
|
+
|
|
259
|
+
@property
|
|
260
|
+
def precision(self) -> str:
|
|
261
|
+
"""Set precision for this participant"""
|
|
262
|
+
return self.get_property_state("precision")
|
|
263
|
+
|
|
264
|
+
@precision.setter
|
|
265
|
+
def precision(self, value: str):
|
|
266
|
+
self.set_property_state("precision", value)
|
|
@@ -9,6 +9,18 @@ class generate_input_file(Command):
|
|
|
9
9
|
"""
|
|
10
10
|
Generates the input journal file for a given Fluent participant.
|
|
11
11
|
|
|
12
|
+
Available for Fluent participants when ``fluent_input.option`` is not
|
|
13
|
+
set to ``journal_file``.
|
|
14
|
+
|
|
15
|
+
Given the participant's name and a file name, generates a Fluent
|
|
16
|
+
journal script which may be set as the value for the ``journal_file``
|
|
17
|
+
setting.
|
|
18
|
+
|
|
19
|
+
System Coupling uses the generated scrkpt for the coupled analysis.
|
|
20
|
+
|
|
21
|
+
Scripts generated using this method may be edited before the
|
|
22
|
+
coupled analysis is started.
|
|
23
|
+
|
|
12
24
|
Parameters
|
|
13
25
|
----------
|
|
14
26
|
participant_name : str
|
|
@@ -7,7 +7,7 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
|
|
|
7
7
|
|
|
8
8
|
class get_execution_command(Command):
|
|
9
9
|
"""
|
|
10
|
-
Gets the execution command needed to start the specified participant
|
|
10
|
+
Gets the execution command needed to start the specified participant.
|
|
11
11
|
|
|
12
12
|
Parameters
|
|
13
13
|
----------
|
|
@@ -7,7 +7,28 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
|
|
|
7
7
|
|
|
8
8
|
class get_machines(Command):
|
|
9
9
|
"""
|
|
10
|
-
Get
|
|
10
|
+
Get a list of dictionaries with machine names and core counts for
|
|
11
|
+
the machines available for parallel processing.
|
|
12
|
+
|
|
13
|
+
Returns information in the following format::
|
|
14
|
+
|
|
15
|
+
[
|
|
16
|
+
{
|
|
17
|
+
'machine-name' : <machine-name-1 (str)>,
|
|
18
|
+
'core-count' : <core-count-1 (int)>
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
'machine-name' : <machine-name-2 (str)>,
|
|
22
|
+
'core-count' : <core-count-2 (int)>
|
|
23
|
+
},
|
|
24
|
+
...
|
|
25
|
+
]
|
|
26
|
+
|
|
27
|
+
Returns an empty list when machines and core counts are not
|
|
28
|
+
provided to System Coupling. You may specify those
|
|
29
|
+
by providing --cnf command-line option when starting System
|
|
30
|
+
Coupling. You can also specify those via the Parallel
|
|
31
|
+
Partitioning dialog box in the System Coupling GUI.
|
|
11
32
|
"""
|
|
12
33
|
|
|
13
34
|
syc_name = "GetMachines"
|
|
@@ -7,15 +7,16 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
|
|
|
7
7
|
|
|
8
8
|
class get_region_names_for_participant(Command):
|
|
9
9
|
"""
|
|
10
|
-
|
|
10
|
+
This query is deprecated and will be deleted in future releases.
|
|
11
|
+
To get region names for a participant, you can use ``get_child_names``
|
|
12
|
+
query, for example:
|
|
11
13
|
|
|
12
|
-
|
|
13
|
-
display names as values.
|
|
14
|
+
``setup.coupling_participant[name].region.get_child_names()```
|
|
14
15
|
|
|
15
16
|
Parameters
|
|
16
17
|
----------
|
|
17
18
|
participant_name : str
|
|
18
|
-
|
|
19
|
+
Name of the participant.
|
|
19
20
|
|
|
20
21
|
"""
|
|
21
22
|
|
|
@@ -25,7 +26,7 @@ class get_region_names_for_participant(Command):
|
|
|
25
26
|
|
|
26
27
|
class participant_name(String):
|
|
27
28
|
"""
|
|
28
|
-
|
|
29
|
+
Name of the participant.
|
|
29
30
|
"""
|
|
30
31
|
|
|
31
32
|
syc_name = "ParticipantName"
|
|
@@ -44,6 +44,12 @@ class mapping_control(Container):
|
|
|
44
44
|
("rbf_clipping_scale", "RBFClippingScale", "RealType"),
|
|
45
45
|
("rbf_max_extrapolation_factor", "RBFMaxExtrapolationFactor", "RealType"),
|
|
46
46
|
("clipping", "Clipping", "bool"),
|
|
47
|
+
("max_search_radius", "MaxSearchRadius", "RealType"),
|
|
48
|
+
(
|
|
49
|
+
"extensive_data_unmapped_value_option",
|
|
50
|
+
"ExtensiveDataUnmappedValueOption",
|
|
51
|
+
"str",
|
|
52
|
+
),
|
|
47
53
|
]
|
|
48
54
|
|
|
49
55
|
@property
|
|
@@ -247,3 +253,21 @@ class mapping_control(Container):
|
|
|
247
253
|
@clipping.setter
|
|
248
254
|
def clipping(self, value: bool):
|
|
249
255
|
self.set_property_state("clipping", value)
|
|
256
|
+
|
|
257
|
+
@property
|
|
258
|
+
def max_search_radius(self) -> RealType:
|
|
259
|
+
"""Maximum search radius to use for point cloud mapping. The value is non-dimensionalized relative to the average spacing between source points."""
|
|
260
|
+
return self.get_property_state("max_search_radius")
|
|
261
|
+
|
|
262
|
+
@max_search_radius.setter
|
|
263
|
+
def max_search_radius(self, value: RealType):
|
|
264
|
+
self.set_property_state("max_search_radius", value)
|
|
265
|
+
|
|
266
|
+
@property
|
|
267
|
+
def extensive_data_unmapped_value_option(self) -> str:
|
|
268
|
+
"""Option for handling of unmapped extensive data on target mesh. Allowed values are ProgramControlled, Interpolate, or ZeroFill."""
|
|
269
|
+
return self.get_property_state("extensive_data_unmapped_value_option")
|
|
270
|
+
|
|
271
|
+
@extensive_data_unmapped_value_option.setter
|
|
272
|
+
def extensive_data_unmapped_value_option(self, value: str):
|
|
273
|
+
self.set_property_state("extensive_data_unmapped_value_option", value)
|
|
@@ -15,35 +15,38 @@ class open(Command):
|
|
|
15
15
|
correspond either to coupling iterations or coupling steps, depending on
|
|
16
16
|
the analysis type and the types of participants involved.
|
|
17
17
|
|
|
18
|
-
By default
|
|
19
|
-
|
|
20
|
-
|
|
18
|
+
By default, this command looks for the "SyC" directory in the current
|
|
19
|
+
working directory. By default, if multiple results files exist, the
|
|
20
|
+
most recent one is opened.
|
|
21
21
|
|
|
22
|
-
If given optional arguments,
|
|
22
|
+
If given optional arguments, behaves as described below in "Optional
|
|
23
|
+
Keyword Arguments".
|
|
23
24
|
|
|
24
25
|
Cannot be run after the participants have been started.
|
|
25
26
|
|
|
26
27
|
Parameters
|
|
27
28
|
----------
|
|
28
29
|
file_path : str, optional
|
|
29
|
-
|
|
30
|
-
|
|
30
|
+
Directory containing the .h5 file(s) to be read. When used, the
|
|
31
|
+
System Coupling Service looks for files in the specified directory.
|
|
32
|
+
Default is 'SyC'. It is recommend to not use anything other than
|
|
33
|
+
a default directory for the ``file_path``.
|
|
31
34
|
coupling_step : int, optional
|
|
32
35
|
Integer specifying the coupling step at which the coupled analysis is
|
|
33
36
|
restarted. When used, System Coupling reads the corresponding
|
|
34
|
-
|
|
37
|
+
Results_step<#>.h5 file in the specified directory and restarts the
|
|
35
38
|
analysis at the end of the specified coupling step. When this argument
|
|
36
39
|
is used, System Coupling automatically removes the output files related
|
|
37
40
|
to all later coupling steps. If the files cannot be removed, then
|
|
38
41
|
System Coupling generates an exception message instructing you to free
|
|
39
42
|
up the files and reissue the ``open`` command with the ``coupling_step``
|
|
40
|
-
argument. If the simulation's results files are associated with
|
|
43
|
+
argument. If the simulation's ``results`` files are associated with
|
|
41
44
|
coupling iterations, then System Coupling prints an error message
|
|
42
45
|
indicating this.
|
|
43
46
|
coupling_iteration : int, optional
|
|
44
47
|
Integer specifying the coupling iteration at which the coupled analysis
|
|
45
48
|
is restarted. When used, System Coupling reads the corresponding
|
|
46
|
-
|
|
49
|
+
Results_iter<#>.h5 file in the specified directory and restarts the
|
|
47
50
|
analysis at the end of the specified coupling iteration. When this
|
|
48
51
|
argument is used, System Coupling automatically removes the output
|
|
49
52
|
files related to all later coupling iterations. If the files cannot be
|
|
@@ -61,8 +64,10 @@ class open(Command):
|
|
|
61
64
|
|
|
62
65
|
class file_path(String):
|
|
63
66
|
"""
|
|
64
|
-
|
|
65
|
-
|
|
67
|
+
Directory containing the .h5 file(s) to be read. When used, the
|
|
68
|
+
System Coupling Service looks for files in the specified directory.
|
|
69
|
+
Default is 'SyC'. It is recommend to not use anything other than
|
|
70
|
+
a default directory for the ``file_path``.
|
|
66
71
|
"""
|
|
67
72
|
|
|
68
73
|
syc_name = "FilePath"
|
|
@@ -71,13 +76,13 @@ class open(Command):
|
|
|
71
76
|
"""
|
|
72
77
|
Integer specifying the coupling step at which the coupled analysis is
|
|
73
78
|
restarted. When used, System Coupling reads the corresponding
|
|
74
|
-
|
|
79
|
+
Results_step<#>.h5 file in the specified directory and restarts the
|
|
75
80
|
analysis at the end of the specified coupling step. When this argument
|
|
76
81
|
is used, System Coupling automatically removes the output files related
|
|
77
82
|
to all later coupling steps. If the files cannot be removed, then
|
|
78
83
|
System Coupling generates an exception message instructing you to free
|
|
79
84
|
up the files and reissue the ``open`` command with the ``coupling_step``
|
|
80
|
-
argument. If the simulation's results files are associated with
|
|
85
|
+
argument. If the simulation's ``results`` files are associated with
|
|
81
86
|
coupling iterations, then System Coupling prints an error message
|
|
82
87
|
indicating this.
|
|
83
88
|
"""
|
|
@@ -88,7 +93,7 @@ class open(Command):
|
|
|
88
93
|
"""
|
|
89
94
|
Integer specifying the coupling iteration at which the coupled analysis
|
|
90
95
|
is restarted. When used, System Coupling reads the corresponding
|
|
91
|
-
|
|
96
|
+
Results_iter<#>.h5 file in the specified directory and restarts the
|
|
92
97
|
analysis at the end of the specified coupling iteration. When this
|
|
93
98
|
argument is used, System Coupling automatically removes the output
|
|
94
99
|
files related to all later coupling iterations. If the files cannot be
|