ansys-systemcoupling-core 0.9.0__py3-none-any.whl → 0.9.1__py3-none-any.whl

ansys/systemcoupling/core/adaptor/api_25_2/setup_root.py

@@ -1,259 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-SHASH = "bb3a306a5f61f6aa15db0778cc94815e9d4f8176d4c372d9c4eb2c2664921947"
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-from ._add_participant import _add_participant
-from .activate_hidden import activate_hidden
-from .add_aerodamping_data_transfers import add_aerodamping_data_transfers
-from .add_data_transfer import add_data_transfer
-from .add_data_transfer_by_display_names import add_data_transfer_by_display_names
-from .add_expression_function import add_expression_function
-from .add_flow_boundary_data_transfers import add_flow_boundary_data_transfers
-from .add_fsi_data_transfers import add_fsi_data_transfers
-from .add_interface import add_interface
-from .add_interface_by_display_names import add_interface_by_display_names
-from .add_named_expression import add_named_expression
-from .add_ordered_data_transfers import add_ordered_data_transfers
-from .add_participant import add_participant
-from .add_reference_frame import add_reference_frame
-from .add_thermal_data_transfers import add_thermal_data_transfers
-from .add_transformation import add_transformation
-from .analysis_control import analysis_control
-from .coupling_interface import coupling_interface
-from .coupling_participant import coupling_participant
-from .delete_transformation import delete_transformation
-from .generate_input_file import generate_input_file
-from .get_add_data_transfer_group_commands import get_add_data_transfer_group_commands
-from .get_execution_command import get_execution_command
-from .get_mode_shape_variables import get_mode_shape_variables
-from .get_region_names_for_participant import get_region_names_for_participant
-from .get_setup_summary import get_setup_summary
-from .get_status_messages import get_status_messages
-from .get_supported_participant_types import get_supported_participant_types
-from .get_thermal_data_transfer_options import get_thermal_data_transfer_options
-from .has_input_file_changed import has_input_file_changed
-from .import_system_coupling_input_file import import_system_coupling_input_file
-from .library import library
-from .output_control import output_control
-from .reload_expression_function_modules import reload_expression_function_modules
-from .solution_control import solution_control
-from .update_participant import update_participant
-
-
-class setup_root(Container):
-    """
-    'root' object
-    """
-
-    syc_name = "SystemCoupling"
-
-    child_names = [
-        "activate_hidden",
-        "library",
-        "coupling_participant",
-        "analysis_control",
-        "coupling_interface",
-        "solution_control",
-        "output_control",
-    ]
-
-    activate_hidden: activate_hidden = activate_hidden
-    """
-    activate_hidden child of setup_root.
-    """
-    library: library = library
-    """
-    library child of setup_root.
-    """
-    coupling_participant: coupling_participant = coupling_participant
-    """
-    coupling_participant child of setup_root.
-    """
-    analysis_control: analysis_control = analysis_control
-    """
-    analysis_control child of setup_root.
-    """
-    coupling_interface: coupling_interface = coupling_interface
-    """
-    coupling_interface child of setup_root.
-    """
-    solution_control: solution_control = solution_control
-    """
-    solution_control child of setup_root.
-    """
-    output_control: output_control = output_control
-    """
-    output_control child of setup_root.
-    """
-    command_names = [
-        "_add_participant",
-        "add_aerodamping_data_transfers",
-        "add_data_transfer",
-        "add_data_transfer_by_display_names",
-        "add_expression_function",
-        "add_flow_boundary_data_transfers",
-        "add_fsi_data_transfers",
-        "add_interface",
-        "add_interface_by_display_names",
-        "add_named_expression",
-        "add_ordered_data_transfers",
-        "add_participant",
-        "add_reference_frame",
-        "add_thermal_data_transfers",
-        "add_transformation",
-        "delete_transformation",
-        "generate_input_file",
-        "get_add_data_transfer_group_commands",
-        "get_execution_command",
-        "get_mode_shape_variables",
-        "get_region_names_for_participant",
-        "get_setup_summary",
-        "get_status_messages",
-        "get_supported_participant_types",
-        "get_thermal_data_transfer_options",
-        "has_input_file_changed",
-        "import_system_coupling_input_file",
-        "reload_expression_function_modules",
-        "update_participant",
-    ]
-
-    _add_participant: _add_participant = _add_participant
-    """
-    _add_participant command of setup_root.
-    """
-    add_aerodamping_data_transfers: add_aerodamping_data_transfers = (
-        add_aerodamping_data_transfers
-    )
-    """
-    add_aerodamping_data_transfers command of setup_root.
-    """
-    add_data_transfer: add_data_transfer = add_data_transfer
-    """
-    add_data_transfer command of setup_root.
-    """
-    add_data_transfer_by_display_names: add_data_transfer_by_display_names = (
-        add_data_transfer_by_display_names
-    )
-    """
-    add_data_transfer_by_display_names command of setup_root.
-    """
-    add_expression_function: add_expression_function = add_expression_function
-    """
-    add_expression_function command of setup_root.
-    """
-    add_flow_boundary_data_transfers: add_flow_boundary_data_transfers = (
-        add_flow_boundary_data_transfers
-    )
-    """
-    add_flow_boundary_data_transfers command of setup_root.
-    """
-    add_fsi_data_transfers: add_fsi_data_transfers = add_fsi_data_transfers
-    """
-    add_fsi_data_transfers command of setup_root.
-    """
-    add_interface: add_interface = add_interface
-    """
-    add_interface command of setup_root.
-    """
-    add_interface_by_display_names: add_interface_by_display_names = (
-        add_interface_by_display_names
-    )
-    """
-    add_interface_by_display_names command of setup_root.
-    """
-    add_named_expression: add_named_expression = add_named_expression
-    """
-    add_named_expression command of setup_root.
-    """
-    add_ordered_data_transfers: add_ordered_data_transfers = add_ordered_data_transfers
-    """
-    add_ordered_data_transfers command of setup_root.
-    """
-    add_participant: add_participant = add_participant
-    """
-    add_participant command of setup_root.
-    """
-    add_reference_frame: add_reference_frame = add_reference_frame
-    """
-    add_reference_frame command of setup_root.
-    """
-    add_thermal_data_transfers: add_thermal_data_transfers = add_thermal_data_transfers
-    """
-    add_thermal_data_transfers command of setup_root.
-    """
-    add_transformation: add_transformation = add_transformation
-    """
-    add_transformation command of setup_root.
-    """
-    delete_transformation: delete_transformation = delete_transformation
-    """
-    delete_transformation command of setup_root.
-    """
-    generate_input_file: generate_input_file = generate_input_file
-    """
-    generate_input_file command of setup_root.
-    """
-    get_add_data_transfer_group_commands: get_add_data_transfer_group_commands = (
-        get_add_data_transfer_group_commands
-    )
-    """
-    get_add_data_transfer_group_commands command of setup_root.
-    """
-    get_execution_command: get_execution_command = get_execution_command
-    """
-    get_execution_command command of setup_root.
-    """
-    get_mode_shape_variables: get_mode_shape_variables = get_mode_shape_variables
-    """
-    get_mode_shape_variables command of setup_root.
-    """
-    get_region_names_for_participant: get_region_names_for_participant = (
-        get_region_names_for_participant
-    )
-    """
-    get_region_names_for_participant command of setup_root.
-    """
-    get_setup_summary: get_setup_summary = get_setup_summary
-    """
-    get_setup_summary command of setup_root.
-    """
-    get_status_messages: get_status_messages = get_status_messages
-    """
-    get_status_messages command of setup_root.
-    """
-    get_supported_participant_types: get_supported_participant_types = (
-        get_supported_participant_types
-    )
-    """
-    get_supported_participant_types command of setup_root.
-    """
-    get_thermal_data_transfer_options: get_thermal_data_transfer_options = (
-        get_thermal_data_transfer_options
-    )
-    """
-    get_thermal_data_transfer_options command of setup_root.
-    """
-    has_input_file_changed: has_input_file_changed = has_input_file_changed
-    """
-    has_input_file_changed command of setup_root.
-    """
-    import_system_coupling_input_file: import_system_coupling_input_file = (
-        import_system_coupling_input_file
-    )
-    """
-    import_system_coupling_input_file command of setup_root.
-    """
-    reload_expression_function_modules: reload_expression_function_modules = (
-        reload_expression_function_modules
-    )
-    """
-    reload_expression_function_modules command of setup_root.
-    """
-    update_participant: update_participant = update_participant
-    """
-    update_participant command of setup_root.
-    """

ansys/systemcoupling/core/adaptor/api_25_2/show_plot.py

@@ -1,75 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-
-class show_plot(InjectedCommand):
-    """
-    Shows plots of transfer values and convergence for data transfers
-    of a coupling interface.
-
-    Parameters
-    ----------
-    interface_name : str
-        Specification of which interface to plot.
-    transfer_names : List, optional
-        Specification of which data transfers to plot. Defaults
-        to ``None``, which means plot all data transfers.
-    working_dir : str, optional
-        Working directory (defaults = ".").
-    show_convergence : bool, optional
-        Whether to show convergence plots (defaults to ``True``).
-    show_transfer_values : bool, optional
-        Whether to show transfer value plots (defaults to ``True``).
-
-    """
-
-    syc_name = "show_plot"
-
-    cmd_name = "show_plot"
-
-    argument_names = [
-        "interface_name",
-        "transfer_names",
-        "working_dir",
-        "show_convergence",
-        "show_transfer_values",
-    ]
-
-    class interface_name(String):
-        """
-        Specification of which interface to plot.
-        """
-
-        syc_name = "interface_name"
-
-    class transfer_names(StringList):
-        """
-        Specification of which data transfers to plot. Defaults
-        to ``None``, which means plot all data transfers.
-        """
-
-        syc_name = "transfer_names"
-
-    class working_dir(String):
-        """
-        Working directory (defaults = ".").
-        """
-
-        syc_name = "working_dir"
-
-    class show_convergence(Boolean):
-        """
-        Whether to show convergence plots (defaults to ``True``).
-        """
-
-        syc_name = "show_convergence"
-
-    class show_transfer_values(Boolean):
-        """
-        Whether to show transfer value plots (defaults to ``True``).
-        """
-
-        syc_name = "show_transfer_values"

ansys/systemcoupling/core/adaptor/api_25_2/shutdown.py

@@ -1,25 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-
-class shutdown(Command):
-    """
-    Interactive command that shuts down a coupled analysis.
-
-    ``shutdown`` includes ending the coupling run and signaling participants
-    to end the run. This produces a clean shutdown, generating the final
-    restart point and corresponding results file before disconnecting
-    from participants.
-
-    After participants are disconnected, the coupling service writes
-    timing details to the transcript. If participants were started
-    automatically, it ends participant processes.
-
-    When System Coupling disconnects from the analysis and shuts down, the GUI
-    Server file is removed from the working directory.
-    """
-
-    syc_name = "Shutdown"

ansys/systemcoupling/core/adaptor/api_25_2/side.py

@@ -1,20 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-from .side_child import side_child
-
-
-class side(NamedContainer[side_child]):
-    """
-    Configure one side of a coupling interface.
-    """
-
-    syc_name = "Side"
-
-    child_object_type: side_child = side_child
-    """
-    child_object_type of side.
-    """

ansys/systemcoupling/core/adaptor/api_25_2/side_child.py

@@ -1,56 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-
-class side_child(Container):
-    """
-    Configure one side of a coupling interface.
-    """
-
-    syc_name = "child_object_type"
-
-    property_names_types = [
-        ("coupling_participant", "CouplingParticipant", "str"),
-        ("region_list", "RegionList", "StringListType"),
-        ("reference_frame", "ReferenceFrame", "str"),
-        ("instancing", "Instancing", "str"),
-    ]
-
-    @property
-    def coupling_participant(self) -> str:
-        """Name of the participant on this interface side."""
-        return self.get_property_state("coupling_participant")
-
-    @coupling_participant.setter
-    def coupling_participant(self, value: str):
-        self.set_property_state("coupling_participant", value)
-
-    @property
-    def region_list(self) -> StringListType:
-        """List of participant regions involved in this interface side."""
-        return self.get_property_state("region_list")
-
-    @region_list.setter
-    def region_list(self, value: StringListType):
-        self.set_property_state("region_list", value)
-
-    @property
-    def reference_frame(self) -> str:
-        """Reference frame of this side."""
-        return self.get_property_state("reference_frame")
-
-    @reference_frame.setter
-    def reference_frame(self, value: str):
-        self.set_property_state("reference_frame", value)
-
-    @property
-    def instancing(self) -> str:
-        """Instancing name for this side (leave unset if not required)."""
-        return self.get_property_state("instancing")
-
-    @instancing.setter
-    def instancing(self, value: str):
-        self.set_property_state("instancing", value)

ansys/systemcoupling/core/adaptor/api_25_2/solution_control.py

@@ -1,117 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-from .available_ports import available_ports
-
-
-class solution_control(Container):
-    """
-    Configure solution controls.
-    """
-
-    syc_name = "SolutionControl"
-
-    child_names = ["available_ports"]
-
-    available_ports: available_ports = available_ports
-    """
-    available_ports child of solution_control.
-    """
-    property_names_types = [
-        ("duration_option", "DurationOption", "str"),
-        ("end_time", "EndTime", "RealType"),
-        ("number_of_steps", "NumberOfSteps", "int"),
-        ("time_step_size", "TimeStepSize", "RealType"),
-        ("minimum_iterations", "MinimumIterations", "int"),
-        ("maximum_iterations", "MaximumIterations", "int"),
-        ("use_ip_address_when_possible", "UseIPAddressWhenPossible", "str"),
-        ("use_local_host_when_possible", "UseLocalHostWhenPossible", "str"),
-    ]
-
-    @property
-    def duration_option(self) -> str:
-        """Determine how the analysis duration is specified.
-
-        Allowed values:
-
-        - \"EndTime\" - Available for transient analyses. Execute coupling
-          steps until the analysis reaches the specified end time.
-        - \"NumberOfSteps\" - Perform coupling steps until the specified
-          number of steps is reached."""
-        return self.get_property_state("duration_option")
-
-    @duration_option.setter
-    def duration_option(self, value: str):
-        self.set_property_state("duration_option", value)
-
-    @property
-    def end_time(self) -> RealType:
-        """Set co-simulation end time."""
-        return self.get_property_state("end_time")
-
-    @end_time.setter
-    def end_time(self, value: RealType):
-        self.set_property_state("end_time", value)
-
-    @property
-    def number_of_steps(self) -> int:
-        """Set number of coupling steps."""
-        return self.get_property_state("number_of_steps")
-
-    @number_of_steps.setter
-    def number_of_steps(self, value: int):
-        self.set_property_state("number_of_steps", value)
-
-    @property
-    def time_step_size(self) -> RealType:
-        """Set coupling time step size."""
-        return self.get_property_state("time_step_size")
-
-    @time_step_size.setter
-    def time_step_size(self, value: RealType):
-        self.set_property_state("time_step_size", value)
-
-    @property
-    def minimum_iterations(self) -> int:
-        """Set minimum iterations within coupling step."""
-        return self.get_property_state("minimum_iterations")
-
-    @minimum_iterations.setter
-    def minimum_iterations(self, value: int):
-        self.set_property_state("minimum_iterations", value)
-
-    @property
-    def maximum_iterations(self) -> int:
-        """Set maximum iterations within coupling step."""
-        return self.get_property_state("maximum_iterations")
-
-    @maximum_iterations.setter
-    def maximum_iterations(self, value: int):
-        self.set_property_state("maximum_iterations", value)
-
-    @property
-    def use_ip_address_when_possible(self) -> str:
-        """If True (the default), prefer to use IPv4 address rather than hostname for
-        participant server connections. There is no guarantee that this request
-        can be satisfied for all participants."""
-        return self.get_property_state("use_ip_address_when_possible")
-
-    @use_ip_address_when_possible.setter
-    def use_ip_address_when_possible(self, value: str):
-        self.set_property_state("use_ip_address_when_possible", value)
-
-    @property
-    def use_local_host_when_possible(self) -> str:
-        """If ProgramControlled, use the default behavior for the platform. See
-        the user documentation. A value of ON attempts to use the local host
-        address rather than network address for participant server connections.
-        There is no guarantee that this request can be satisfied for
-        all participants."""
-        return self.get_property_state("use_local_host_when_possible")
-
-    @use_local_host_when_possible.setter
-    def use_local_host_when_possible(self, value: str):
-        self.set_property_state("use_local_host_when_possible", value)

ansys/systemcoupling/core/adaptor/api_25_2/solution_root.py

@@ -1,134 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-SHASH = "5a1ce2bf8c6b59f120413651ed283c65b2593ebac9c4b8485e0817e00ecbd1e6"
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-from ._solve import _solve
-from .abort import abort
-from .connect_ensight_dvs import connect_ensight_dvs
-from .create_restart_point import create_restart_point
-from .get_machines import get_machines
-from .get_transformation import get_transformation
-from .initialize import initialize
-from .interrupt import interrupt
-from .map import map
-from .open_results_in_ensight import open_results_in_ensight
-from .partition_participants import partition_participants
-from .show_plot import show_plot
-from .shutdown import shutdown
-from .solve import solve
-from .step import step
-from .update_interfaces import update_interfaces
-from .write_csv_chart_files import write_csv_chart_files
-from .write_ensight import write_ensight
-from .write_target_data import write_target_data
-
-
-class solution_root(Container):
-    """
-    'root' object
-    """
-
-    syc_name = "SolutionCommands"
-
-    command_names = [
-        "_solve",
-        "abort",
-        "connect_ensight_dvs",
-        "create_restart_point",
-        "get_machines",
-        "get_transformation",
-        "initialize",
-        "interrupt",
-        "map",
-        "open_results_in_ensight",
-        "partition_participants",
-        "show_plot",
-        "shutdown",
-        "solve",
-        "step",
-        "update_interfaces",
-        "write_csv_chart_files",
-        "write_ensight",
-        "write_target_data",
-    ]
-
-    _solve: _solve = _solve
-    """
-    _solve command of solution_root.
-    """
-    abort: abort = abort
-    """
-    abort command of solution_root.
-    """
-    connect_ensight_dvs: connect_ensight_dvs = connect_ensight_dvs
-    """
-    connect_ensight_dvs command of solution_root.
-    """
-    create_restart_point: create_restart_point = create_restart_point
-    """
-    create_restart_point command of solution_root.
-    """
-    get_machines: get_machines = get_machines
-    """
-    get_machines command of solution_root.
-    """
-    get_transformation: get_transformation = get_transformation
-    """
-    get_transformation command of solution_root.
-    """
-    initialize: initialize = initialize
-    """
-    initialize command of solution_root.
-    """
-    interrupt: interrupt = interrupt
-    """
-    interrupt command of solution_root.
-    """
-    map: map = map
-    """
-    map command of solution_root.
-    """
-    open_results_in_ensight: open_results_in_ensight = open_results_in_ensight
-    """
-    open_results_in_ensight command of solution_root.
-    """
-    partition_participants: partition_participants = partition_participants
-    """
-    partition_participants command of solution_root.
-    """
-    show_plot: show_plot = show_plot
-    """
-    show_plot command of solution_root.
-    """
-    shutdown: shutdown = shutdown
-    """
-    shutdown command of solution_root.
-    """
-    solve: solve = solve
-    """
-    solve command of solution_root.
-    """
-    step: step = step
-    """
-    step command of solution_root.
-    """
-    update_interfaces: update_interfaces = update_interfaces
-    """
-    update_interfaces command of solution_root.
-    """
-    write_csv_chart_files: write_csv_chart_files = write_csv_chart_files
-    """
-    write_csv_chart_files command of solution_root.
-    """
-    write_ensight: write_ensight = write_ensight
-    """
-    write_ensight command of solution_root.
-    """
-    write_target_data: write_target_data = write_target_data
-    """
-    write_target_data command of solution_root.
-    """