ansys-systemcoupling-core 0.1.3__py3-none-any.whl → 0.3.0__py3-none-any.whl

ansys/systemcoupling/core/__init__.py

@@ -21,6 +21,7 @@ def launch(
     working_dir: str = None,
     nprocs: int = None,
     sycnprocs: int = None,
+    version: str = None,
     extra_args: List[str] = [],
 ) -> Session:
     """Start a local instance of System Coupling and connect to it.
@@ -40,6 +41,15 @@ def launch(
     sycnprocs : int, optional
         Number of processes for the System Coupling engine. The default is
         ``None``, in which case the System Coupling server uses its own default.
+    version : str, optional
+        String specifying the version of System Coupling to use. For example,
+        to use System Coupling from the Ansys "2023 R1" release, specify ``"231"``.
+        (The forms ``"23.1"`` and ``"23_1"`` are also acceptable.)
+        The version will be sought in the standard installation location. The
+        default is ``None``, which is equivalent to specifying
+        ``"232"`` ("2023 R2" release), unless either of the environment
+        variables ``SYSC_ROOT`` or ``AWP_ROOT`` has been set. It is considered
+        to be an error if either these is set *and* ``version`` is provided.
     extra_args : List[str]
         List of any additional arguments to specify when the server
         process is launched. The default is ``[]``. If a list of additional
@@ -60,14 +70,17 @@ def launch(
         working_dir=working_dir,
         nprocs=nprocs,
         sycnprocs=sycnprocs,
+        version=version,
         extra_args=extra_args,
     )
-    syc = Session(rpc)
-    return syc
+    return Session(rpc)
 
 
 def launch_container(
-    mounted_from: str = "./", mounted_to: str = "/working", network: str = None
+    mounted_from: str = "./",
+    mounted_to: str = "/working",
+    network: str = None,
+    version: str = None,
 ) -> Session:
     """Start a System Coupling container instance and connect to it.
 
@@ -82,9 +95,8 @@ def launch_container(
         remote System Coupling instance.
     """
     rpc = SycGrpc()
-    rpc.start_container_and_connect(mounted_from, mounted_to, network)
-    syc = Session(rpc)
-    return syc
+    rpc.start_container_and_connect(mounted_from, mounted_to, network, version=version)
+    return Session(rpc)
 
 
 def connect(host: str, port: int) -> Session:  # pragma: no cover
@@ -110,16 +122,14 @@ def connect(host: str, port: int) -> Session:  # pragma: no cover
 
 
 # Set up data directory
-try:
-    USER_DATA_PATH = appdirs.user_data_dir("ansys_systemcoupling_core")
-    if not os.path.exists(USER_DATA_PATH):  # pragma: no cover
-        os.makedirs(USER_DATA_PATH)
-
-    EXAMPLES_PATH = os.path.join(USER_DATA_PATH, "examples")
-    if not os.path.exists(EXAMPLES_PATH):  # pragma: no cover
-        os.makedirs(EXAMPLES_PATH)
-
-except:  # pragma: no cover
-    pass
+USER_DATA_PATH = appdirs.user_data_dir(
+    appname="ansys_systemcoupling_core", appauthor="Ansys"
+)
+if not os.path.exists(USER_DATA_PATH):  # pragma: no cover
+    os.makedirs(USER_DATA_PATH)
+
+EXAMPLES_PATH = os.path.join(USER_DATA_PATH, "examples")
+if not os.path.exists(EXAMPLES_PATH):  # pragma: no cover
+    os.makedirs(EXAMPLES_PATH)
 
 BUILDING_GALLERY = False

ansys/systemcoupling/core/adaptor/api_23_2/_add_participant.py

@@ -0,0 +1,70 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class _add_participant(Command):
+    """
+    For internal use only.
+
+    Parameters
+    ----------
+    participant_type : str, optional
+        ...
+    input_file : str, optional
+        ...
+    executable : str, optional
+        ...
+    additional_arguments : str, optional
+        ...
+    working_directory : str, optional
+        ...
+
+    """
+
+    syc_name = "AddParticipant"
+
+    argument_names = [
+        "participant_type",
+        "input_file",
+        "executable",
+        "additional_arguments",
+        "working_directory",
+    ]
+
+    class participant_type(String):
+        """
+        ...
+        """
+
+        syc_name = "ParticipantType"
+
+    class input_file(String):
+        """
+        ...
+        """
+
+        syc_name = "InputFile"
+
+    class executable(String):
+        """
+        ...
+        """
+
+        syc_name = "Executable"
+
+    class additional_arguments(String):
+        """
+        ...
+        """
+
+        syc_name = "AdditionalArguments"
+
+    class working_directory(String):
+        """
+        ...
+        """
+
+        syc_name = "WorkingDirectory"

ansys/systemcoupling/core/adaptor/api_23_2/_solve.py

@@ -0,0 +1,13 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class _solve(Command):
+    """
+    For internal use only.
+    """
+
+    syc_name = "Solve"

ansys/systemcoupling/core/adaptor/{api_23_1 → api_23_2}/add_participant.py

@@ -5,8 +5,32 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 
-class add_participant(Command):
+class add_participant(InjectedCommand):
     """
+    This command operates in one of two modes, depending on how it is called.
+    *Either* a single argument, ``participant_session``, should be provided, *or* some
+    combination of the other optional arguments not including ``participant_session``
+    should be provided.
+
+    In the ``participant_session`` mode, the session object is queried to
+    extract the information needed to define a new ``coupling_participant``
+    object in the setup datamodel. A reference to the session is also retained,
+    and this will play a further role if ``solve`` is called later. In that case,
+    the participant solver will be driven from the Python environment in which the
+    participant and PySystemCoupling sessions are active and System Coupling will
+    regard the participant solver as "externally managed" (see the `execution_control`
+    settings in `coupling_participant` for details of this mode).
+
+    .. note::
+        The ``participant_session`` mode currently has limited support in the
+        broader Ansys Python ecosystem - at present, only PyFluent supports
+        the API required of the session object and product versions of Fluent and
+        System Coupling need to be at least 24.1. This capability should be
+        regarded as *Beta* as it may be subject to revision when extended to other
+        products.
+
+    The remainder of the documentation describes the more usual non-session mode.
+
     Adds a coupling participant to the data model.
 
     When executed, this command adds the new participant to the analysis
@@ -31,6 +55,8 @@ class add_participant(Command):
 
     Parameters
     ----------
+    participant_session : ParticipantProtocol, optional
+        Participant session object conforming to the ``ParticipantProtocol`` protocol class.
     participant_type : str, optional
         Participant type. Currently supported types are:
 
@@ -61,9 +87,12 @@ class add_participant(Command):
 
     """
 
-    syc_name = "AddParticipant"
+    syc_name = "add_participant"
+
+    cmd_name = "add_participant"
 
     argument_names = [
+        "participant_session",
         "participant_type",
         "input_file",
         "executable",
@@ -71,6 +100,13 @@ class add_participant(Command):
         "working_directory",
     ]
 
+    class participant_session(ParticipantSession):
+        """
+        Participant session object conforming to the ``ParticipantProtocol`` protocol class.
+        """
+
+        syc_name = "participant_session"
+
     class participant_type(String):
         """
         Participant type. Currently supported types are:

ansys/systemcoupling/core/adaptor/{api_23_1 → api_23_2}/analysis_control.py

@@ -5,6 +5,7 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 from .apip import apip
+from .automatic_alignment_options import automatic_alignment_options
 from .avoid_data_reconstruction import avoid_data_reconstruction
 from .global_stabilization import global_stabilization
 from .unmapped_value_options import unmapped_value_options
@@ -22,6 +23,7 @@ class analysis_control(Container):
         "apip",
         "avoid_data_reconstruction",
         "unmapped_value_options",
+        "automatic_alignment_options",
     ]
 
     global_stabilization: global_stabilization = global_stabilization
@@ -40,6 +42,12 @@ class analysis_control(Container):
     """
     unmapped_value_options child of analysis_control.
     """
+    automatic_alignment_options: automatic_alignment_options = (
+        automatic_alignment_options
+    )
+    """
+    automatic_alignment_options child of analysis_control.
+    """
     property_names_types = [
         ("analysis_type", "AnalysisType", "str"),
         ("optimize_if_one_way", "OptimizeIfOneWay", "bool"),

ansys/systemcoupling/core/adaptor/api_23_2/automatic_alignment_options.py

@@ -0,0 +1,46 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class automatic_alignment_options(Container):
+    """
+    Automatic alignment settings.
+    """
+
+    syc_name = "AutomaticAlignmentOptions"
+
+    property_names_types = [
+        ("alignment_type", "AlignmentType", "str"),
+        ("singular_value_tolerance", "SingularValueTolerance", "RealType"),
+        ("verbosity", "Verbosity", "int"),
+    ]
+
+    @property
+    def alignment_type(self) -> str:
+        """Alignment type (\"Covariance\" or \"Moment Covariance\" or \"Inertial Axes\")."""
+        return self.get_property_state("alignment_type")
+
+    @alignment_type.setter
+    def alignment_type(self, value: str):
+        self.set_property_state("alignment_type", value)
+
+    @property
+    def singular_value_tolerance(self) -> RealType:
+        """Tolerance used to compare singular values"""
+        return self.get_property_state("singular_value_tolerance")
+
+    @singular_value_tolerance.setter
+    def singular_value_tolerance(self, value: RealType):
+        self.set_property_state("singular_value_tolerance", value)
+
+    @property
+    def verbosity(self) -> int:
+        """Set to 1 to print additional information about the alignment"""
+        return self.get_property_state("verbosity")
+
+    @verbosity.setter
+    def verbosity(self, value: int):
+        self.set_property_state("verbosity", value)

ansys/systemcoupling/core/adaptor/{api_23_1 → api_23_2}/avoid_data_reconstruction.py

@@ -15,6 +15,7 @@ class avoid_data_reconstruction(Container):
     property_names_types = [
         ("volume_mapping", "VolumeMapping", "bool"),
         ("surface_mapping", "SurfaceMapping", "bool"),
+        ("surface_volume_mapping", "SurfaceVolumeMapping", "bool"),
     ]
 
     @property
@@ -34,3 +35,12 @@ class avoid_data_reconstruction(Container):
     @surface_mapping.setter
     def surface_mapping(self, value: bool):
         self.set_property_state("surface_mapping", value)
+
+    @property
+    def surface_volume_mapping(self) -> bool:
+        """UNDOCUMENTED"""
+        return self.get_property_state("surface_volume_mapping")
+
+    @surface_volume_mapping.setter
+    def surface_volume_mapping(self, value: bool):
+        self.set_property_state("surface_volume_mapping", value)

ansys/systemcoupling/core/adaptor/{api_23_1 → api_23_2}/coupling_participant_child.py

@@ -147,7 +147,7 @@ class coupling_participant_child(Container):
 
     @property
     def use_new_apis(self) -> bool:
-        """Controls whether a Fluent or MAPDL participant should communicate using new APIs."""
+        """Controls whether Fluent/MAPDL/AEDT participant should communicate using new APIs."""
         return self.get_property_state("use_new_apis")
 
     @use_new_apis.setter

ansys/systemcoupling/core/adaptor/{api_23_1 → api_23_2}/fmu_parameter_child.py

@@ -24,6 +24,9 @@ class fmu_parameter_child(Container):
         ("integer_max", "IntegerMax", "int"),
         ("logical_value", "LogicalValue", "bool"),
         ("string_value", "StringValue", "str"),
+        ("enumeration_value", "EnumerationValue", "int"),
+        ("enumeration_min", "EnumerationMin", "int"),
+        ("enumeration_max", "EnumerationMax", "int"),
     ]
 
     @property
@@ -124,3 +127,30 @@ class fmu_parameter_child(Container):
     @string_value.setter
     def string_value(self, value: str):
         self.set_property_state("string_value", value)
+
+    @property
+    def enumeration_value(self) -> int:
+        """Enumeration data start value."""
+        return self.get_property_state("enumeration_value")
+
+    @enumeration_value.setter
+    def enumeration_value(self, value: int):
+        self.set_property_state("enumeration_value", value)
+
+    @property
+    def enumeration_min(self) -> int:
+        """Enumeration data minimum value."""
+        return self.get_property_state("enumeration_min")
+
+    @enumeration_min.setter
+    def enumeration_min(self, value: int):
+        self.set_property_state("enumeration_min", value)
+
+    @property
+    def enumeration_max(self) -> int:
+        """Enumeration data maximum value."""
+        return self.get_property_state("enumeration_max")
+
+    @enumeration_max.setter
+    def enumeration_max(self, value: int):
+        self.set_property_state("enumeration_max", value)

ansys/systemcoupling/core/adaptor/api_23_2/get_transformation.py

@@ -0,0 +1,43 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_transformation(Command):
+    """
+    Given an interface and side, returns the resultant transformation, in
+    the form of a Python dictionary and formatted as a DataModel
+    reference_frame object. If multiple transformations are aplied to the
+    interface side, the composite transformation is returned.
+
+    This command can only be invoked after the analysis
+    is initialized.
+
+    Parameters
+    ----------
+    interface_name : str
+        Name of the interface
+    side : str
+        Interface side. Can be "One" or "Two".
+
+    """
+
+    syc_name = "GetTransformation"
+
+    argument_names = ["interface_name", "side"]
+
+    class interface_name(String):
+        """
+        Name of the interface
+        """
+
+        syc_name = "InterfaceName"
+
+    class side(String):
+        """
+        Interface side. Can be "One" or "Two".
+        """
+
+        syc_name = "Side"

ansys/systemcoupling/core/adaptor/api_23_2/live_visualization.py

@@ -0,0 +1,20 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .live_visualization_child import live_visualization_child
+
+
+class live_visualization(NamedContainer[live_visualization_child]):
+    """
+    Configures live visualization via EnSight DVS.
+    """
+
+    syc_name = "LiveVisualization"
+
+    child_object_type: live_visualization_child = live_visualization_child
+    """
+    child_object_type of live_visualization.
+    """

ansys/systemcoupling/core/adaptor/api_23_2/live_visualization_child.py

@@ -0,0 +1,72 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class live_visualization_child(Container):
+    """
+    Configures live visualization via EnSight DVS.
+    """
+
+    syc_name = "child_object_type"
+
+    property_names_types = [
+        ("option", "Option", "str"),
+        ("write_results", "WriteResults", "bool"),
+        ("output_frequency", "OutputFrequency", "int"),
+    ]
+
+    @property
+    def option(self) -> str:
+        """Specifies live visualization working process
+
+        Allowed values:
+
+        - \"ProgramControlled\" - Generation of postprocessing results is disabled for now.
+
+        -  \"Off\" - Generation of postprocessing results is disabled.
+
+        Allowed values for step-based analyses:
+
+        - \"LastStep\" - Generate results only for the last coupling step completed.
+
+        - \"EveryStep\" - Generate results at the end of every coupling step.
+
+        - \"StepInterval\" - Generate results at the end of coupling steps at
+          the interval specified by the output frequency setting.
+
+        Allowed values for iteration-based analyses:
+
+        - \"LastIteration\" - Generate results only for the last coupling
+          iteration completed.
+
+        - \"EveryIteration\" - Generate results at the end of every coupling
+          iteration.
+
+        - \"IterationInterval\" - Generate results at the end of coupling
+          iterations at the interval specified by the output frequency setting."""
+        return self.get_property_state("option")
+
+    @option.setter
+    def option(self, value: str):
+        self.set_property_state("option", value)
+
+    @property
+    def write_results(self) -> bool:
+        """Write results to files when conducting live visualization."""
+        return self.get_property_state("write_results")
+
+    @write_results.setter
+    def write_results(self, value: bool):
+        self.set_property_state("write_results", value)
+
+    @property
+    def output_frequency(self) -> int:
+        """Specify output frequency."""
+        return self.get_property_state("output_frequency")
+
+    @output_frequency.setter
+    def output_frequency(self, value: int):
+        self.set_property_state("output_frequency", value)

ansys/systemcoupling/core/adaptor/api_23_2/open_results_in_en_sight.py

@@ -0,0 +1,56 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class open_results_in_en_sight(Command):
+    """
+    Allows for System Coupling results to be postprocessed in EnSight.
+
+    When this command is issued, System Coupling looks for the ``results.enc``
+    file in the ``SyC/results`` subdirectory of the current working directory.
+
+    When System Coupling finds the file, it loads the file into EnSight and
+    generates a confirmation message indicating that results are being opened.
+
+    If System Coupling is unable to find the ``results.enc`` file and/or the
+    EnSight executable, then it raises an error.
+
+    The ``open_results_in_ensight`` command may be issued multiple times from the same
+    instance of System Coupling. Each time the command is issued, a new
+    instance of the EnSight application is opened. Any existing instances of
+    EnSight remain open, both when additional instances are created and when
+    System Coupling exits.
+
+    Parameters
+    ----------
+    file_name : str, optional
+        The basename of the EnSight case file if using a non-standard file
+        name. Overrides the default file name ``results.enc``.
+    file_path : str, optional
+        The path to the EnSight case if using a non-standard location.
+        Overrides the default path of ``SyC/results``.
+
+    """
+
+    syc_name = "OpenResultsInEnSight"
+
+    argument_names = ["file_name", "file_path"]
+
+    class file_name(String):
+        """
+        The basename of the EnSight case file if using a non-standard file
+        name. Overrides the default file name ``results.enc``.
+        """
+
+        syc_name = "FileName"
+
+    class file_path(String):
+        """
+        The path to the EnSight case if using a non-standard location.
+        Overrides the default path of ``SyC/results``.
+        """
+
+        syc_name = "FilePath"

ansys/systemcoupling/core/adaptor/{api_23_1 → api_23_2}/output_control.py

@@ -5,6 +5,7 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 from .ascii_output import ascii_output
+from .live_visualization import live_visualization
 from .results import results
 
 
@@ -15,7 +16,7 @@ class output_control(Container):
 
     syc_name = "OutputControl"
 
-    child_names = ["results", "ascii_output"]
+    child_names = ["results", "ascii_output", "live_visualization"]
 
     results: results = results
     """
@@ -25,6 +26,10 @@ class output_control(Container):
     """
     ascii_output child of output_control.
     """
+    live_visualization: live_visualization = live_visualization
+    """
+    live_visualization child of output_control.
+    """
     property_names_types = [
         ("option", "Option", "str"),
         ("generate_csv_chart_output", "GenerateCSVChartOutput", "bool"),