ansys-systemcoupling-core 0.3.0__py3-none-any.whl → 0.4.dev0__py3-none-any.whl

ansys/systemcoupling/core/adaptor/api_23_1/add_interface.py

@@ -0,0 +1,75 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_interface(Command):
+    """
+    Adds an interface based on the participant and region names specified
+    as arguments for each side of the interface. This command requires that you
+    specify participants and regions using their names (see parameter
+    descriptions for details).
+
+    Cannot be run after participants have been started.
+
+    Returns the name of the Interface created.
+
+    Parameters
+    ----------
+    side_one_participant : str
+        String indicating the name of the participant to be associated with
+        side \"One\" of the interface.
+    side_one_regions : typing.List[str]
+        List specifying the name(s) of region(s) to be added to side \"One\" of
+        the interface.
+    side_two_participant : str
+        String indicating the name of the participant to be associated with
+        side \"Two\" of the interface.
+    side_two_regions : typing.List[str]
+        List specifying the name(s) of region(s) to be added to side \"Two\" of
+        the interface.
+
+    """
+
+    syc_name = "AddInterface"
+
+    argument_names = [
+        "side_one_participant",
+        "side_one_regions",
+        "side_two_participant",
+        "side_two_regions",
+    ]
+
+    class side_one_participant(String):
+        """
+        String indicating the name of the participant to be associated with
+        side \"One\" of the interface.
+        """
+
+        syc_name = "SideOneParticipant"
+
+    class side_one_regions(StringList):
+        """
+        List specifying the name(s) of region(s) to be added to side \"One\" of
+        the interface.
+        """
+
+        syc_name = "SideOneRegions"
+
+    class side_two_participant(String):
+        """
+        String indicating the name of the participant to be associated with
+        side \"Two\" of the interface.
+        """
+
+        syc_name = "SideTwoParticipant"
+
+    class side_two_regions(StringList):
+        """
+        List specifying the name(s) of region(s) to be added to side \"Two\" of
+        the interface.
+        """
+
+        syc_name = "SideTwoRegions"

ansys/systemcoupling/core/adaptor/api_23_1/add_interface_by_display_names.py

@@ -0,0 +1,75 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_interface_by_display_names(Command):
+    """
+    Adds an interface based on the participant and region display names specified
+    as arguments for each side of the interface. This command requires that you
+    specify participants and regions using their *display* names (see parameter
+    descriptions for details).
+
+    Cannot be run after participants have been started.
+
+    Returns the name of the Interface created.
+
+    Parameters
+    ----------
+    side_one_participant : str
+        String indicating the name of the participant to be associated with
+        side \"One\" of the interface.
+    side_one_regions : typing.List[str]
+        List specifying the name(s) of region(s) to be added to side \"One\" of
+        the interface.
+    side_two_participant : str
+        String indicating the name of the participant to be associated with
+        side \"Two\" of the interface.
+    side_two_regions : typing.List[str]
+        List specifying the name(s) of region(s) to be added to side \"Two\"
+        of the interface.
+
+    """
+
+    syc_name = "AddInterfaceByDisplayNames"
+
+    argument_names = [
+        "side_one_participant",
+        "side_one_regions",
+        "side_two_participant",
+        "side_two_regions",
+    ]
+
+    class side_one_participant(String):
+        """
+        String indicating the name of the participant to be associated with
+        side \"One\" of the interface.
+        """
+
+        syc_name = "SideOneParticipant"
+
+    class side_one_regions(StringList):
+        """
+        List specifying the name(s) of region(s) to be added to side \"One\" of
+        the interface.
+        """
+
+        syc_name = "SideOneRegions"
+
+    class side_two_participant(String):
+        """
+        String indicating the name of the participant to be associated with
+        side \"Two\" of the interface.
+        """
+
+        syc_name = "SideTwoParticipant"
+
+    class side_two_regions(StringList):
+        """
+        List specifying the name(s) of region(s) to be added to side \"Two\"
+        of the interface.
+        """
+
+        syc_name = "SideTwoRegions"

ansys/systemcoupling/core/adaptor/api_23_1/add_named_expression.py

@@ -0,0 +1,42 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_named_expression(Command):
+    """
+    Creates a named expression object in the data model.
+    If there is already an object in the data model whose ``expression_name``
+    matches the provided ``expression_name``, its ``expression_string`` will be
+    overwritten with the provided ``expression_string``
+
+    Parameters
+    ----------
+    expression_name : str
+        The name by which this expression should be referenced when used in
+        another expression.
+    expression_string : str
+        String containing the definition of the expression.
+
+    """
+
+    syc_name = "AddNamedExpression"
+
+    argument_names = ["expression_name", "expression_string"]
+
+    class expression_name(String):
+        """
+        The name by which this expression should be referenced when used in
+        another expression.
+        """
+
+        syc_name = "ExpressionName"
+
+    class expression_string(String):
+        """
+        String containing the definition of the expression.
+        """
+
+        syc_name = "ExpressionString"

ansys/systemcoupling/core/adaptor/api_23_1/add_participant.py

@@ -0,0 +1,160 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+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
+    without removing any interfaces or data transfers created previously.
+
+    Cannot be called after participants have been started.
+
+    Returns the name of the participant.
+
+    There are two options to add the participant - via a file, or via a
+    participant executable.
+
+    Option 1: Using an input file
+        Given an input file containing participant coupling information, reads the
+        specified file, pushes the participant's information to the data model.
+
+    Option 2: Using a participant executable
+        Given the path to the executable for this participant (and optionally,
+        additional arguments and/or working directory), start the participant
+        executable, connect to the participant using the socket connection,
+        and get the participant's information and add it to the data model.
+
+    Parameters
+    ----------
+    participant_session : ParticipantProtocol, optional
+        Participant session object conforming to the ``ParticipantProtocol`` protocol class.
+    participant_type : str, optional
+        Participant type. Currently supported types are:
+
+        - \"DEFAULT\"
+        - \"CFX\"
+        - \"FLUENT\"
+        - \"MAPDL\"
+        - \"AEDT\"
+        - \"FMU\"
+        - \"FORTE\"
+        - \"DEFAULT-SRV\"
+        - \"MECH-SRV\"
+        - \"CFD-SRV\"
+
+        If unspecified, ``add_participant`` will attempt to deduce
+        the type from ``input_file``.
+    input_file : str, optional
+        Name of the input file for the participant to be added.
+        Currently supported formats are SCP files, Forte input (FTSIM)
+        files, mechanical server (*.rst) files, cfd server (*.csv) files,
+        and FMU (.fmu) files (Beta).
+    executable : str, optional
+        Path to the executable file for the participant to be added.
+    additional_arguments : str, optional
+        Any additional arguments to be passed to the participant's executable.
+    working_directory : str, optional
+        Path to the working directory for this participant.
+
+    """
+
+    syc_name = "add_participant"
+
+    cmd_name = "add_participant"
+
+    argument_names = [
+        "participant_session",
+        "participant_type",
+        "input_file",
+        "executable",
+        "additional_arguments",
+        "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:
+
+        - \"DEFAULT\"
+        - \"CFX\"
+        - \"FLUENT\"
+        - \"MAPDL\"
+        - \"AEDT\"
+        - \"FMU\"
+        - \"FORTE\"
+        - \"DEFAULT-SRV\"
+        - \"MECH-SRV\"
+        - \"CFD-SRV\"
+
+        If unspecified, ``add_participant`` will attempt to deduce
+        the type from ``input_file``.
+        """
+
+        syc_name = "ParticipantType"
+
+    class input_file(String):
+        """
+        Name of the input file for the participant to be added.
+        Currently supported formats are SCP files, Forte input (FTSIM)
+        files, mechanical server (*.rst) files, cfd server (*.csv) files,
+        and FMU (.fmu) files (Beta).
+        """
+
+        syc_name = "InputFile"
+
+    class executable(String):
+        """
+        Path to the executable file for the participant to be added.
+        """
+
+        syc_name = "Executable"
+
+    class additional_arguments(String):
+        """
+        Any additional arguments to be passed to the participant's executable.
+        """
+
+        syc_name = "AdditionalArguments"
+
+    class working_directory(String):
+        """
+        Path to the working directory for this participant.
+        """
+
+        syc_name = "WorkingDirectory"

ansys/systemcoupling/core/adaptor/api_23_1/add_reference_frame.py

@@ -0,0 +1,40 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_reference_frame(Command):
+    """
+    Add a reference frame to the datamodel
+
+    The function will add a blank reference frame to the datamodel. Any
+    transformations must be added separately.
+
+    Reference frame name will be "Frame-#" where # is the first positive
+    integer which yields a unique frame name.
+
+    Returns the name of the reference frame.
+
+    Parameters
+    ----------
+    parent_reference_frame : str, optional
+        Name of a reference frame that the added frame should use as the
+        parent. If the argument is not provided, the default parent reference
+        frame "GlobalReferenceFrame" will be added.
+
+    """
+
+    syc_name = "AddReferenceFrame"
+
+    argument_names = ["parent_reference_frame"]
+
+    class parent_reference_frame(String):
+        """
+        Name of a reference frame that the added frame should use as the
+        parent. If the argument is not provided, the default parent reference
+        frame "GlobalReferenceFrame" will be added.
+        """
+
+        syc_name = "ParentReferenceFrame"

ansys/systemcoupling/core/adaptor/api_23_1/add_transformation.py

@@ -0,0 +1,102 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_transformation(Command):
+    """
+    Add a transformation to a reference frame defined in the datamodel
+
+    Given the reference frame to add to the transform to, the type of transform
+    to be added, and any required information for the transformation, add the
+    transformation to the referenceFrame. Not all parameters are required for
+    every transformation.
+
+    The name of the transformation will be based on the type of transformation.
+    The name will be of the form ``<transformation_type>-#`` where ``#`` is the first
+    positive integer which yields a unique frame name.
+
+    The transformation will also be added to the end of the ``transformation_order``
+    list for the reference frame.
+
+    Returns the name of the transformation.
+
+    Parameters
+    ----------
+    reference_frame : str
+        Name of the reference frame to which the transformation will be added.
+    transformation_type : str
+        Type of transformation to be added. Available options are \"Rotation\" or
+        \"Translation\".
+
+        Required Parameters for Transformation Types:
+            Rotation: ``angle``, ``axis``, ``vector`` (if ``axis`` is \"UserDefined\")
+            Translation: ``vector``
+    angle : real, optional
+        Angle to rotate a reference frame. Used with \"Rotation\"
+        ``transformation_type``. Default unit is Radians.
+    axis : str, optional
+        Axis about which a rotation is applied. Used with
+        Rotation ``transformation_type``. Available options are: \"XAxis\", \"YAxis\",
+        \"ZAxis\", and \"UserDefined\".
+    vector : typing.Tuple[real, real, real], optional
+        A vector for use with \"Translation\" ``transformation_type`` or \"Rotation\"
+        ``transformation_type`` if the ``axis`` is \"UserDefined\".
+
+    """
+
+    syc_name = "AddTransformation"
+
+    argument_names = [
+        "reference_frame",
+        "transformation_type",
+        "angle",
+        "axis",
+        "vector",
+    ]
+
+    class reference_frame(String):
+        """
+        Name of the reference frame to which the transformation will be added.
+        """
+
+        syc_name = "ReferenceFrame"
+
+    class transformation_type(String):
+        """
+        Type of transformation to be added. Available options are \"Rotation\" or
+        \"Translation\".
+
+        Required Parameters for Transformation Types:
+            Rotation: ``angle``, ``axis``, ``vector`` (if ``axis`` is \"UserDefined\")
+            Translation: ``vector``
+        """
+
+        syc_name = "TransformationType"
+
+    class angle(Real):
+        """
+        Angle to rotate a reference frame. Used with \"Rotation\"
+        ``transformation_type``. Default unit is Radians.
+        """
+
+        syc_name = "Angle"
+
+    class axis(String):
+        """
+        Axis about which a rotation is applied. Used with
+        Rotation ``transformation_type``. Available options are: \"XAxis\", \"YAxis\",
+        \"ZAxis\", and \"UserDefined\".
+        """
+
+        syc_name = "Axis"
+
+    class vector(RealVector):
+        """
+        A vector for use with \"Translation\" ``transformation_type`` or \"Rotation\"
+        ``transformation_type`` if the ``axis`` is \"UserDefined\".
+        """
+
+        syc_name = "Vector"