setup_root

class ansys.systemcoupling.core.adaptor.api_24_2.setup_root.setup_root(name=None, parent=None)

Bases: Container

‘root’ object

Children

Child	Summary
activate_hidden	Contains settings to control exposure of hidden features.
library	Contains objects that can be referenced from elsewhere in the data model.
coupling_participant	Configure a coupling participant.
analysis_control	Configure coupling controls.
coupling_interface	Configure a coupling interface.
solution_control	Configure solution controls.
output_control	Configure output controls.

Commands

Command	Summary
add_aerodamping_data_transfers	Adds data transfer for each specified mode shape.
add_data_transfer	Adds data transfer based on arguments that specify the interface, target
add_data_transfer_by_display_names	Important: This command is deprecated. To add an interface, use the
add_expression_function	Creates an expression function object in the data model that makes
add_fsi_data_transfers	Adds group of data transfers for FSI physics.
add_interface	Adds an interface based on the participant and region names specified
add_interface_by_display_names	Important: This command is deprecated. To add an interface, use the
add_named_expression	Creates a named expression object in the data model.
add_ordered_data_transfers	Adds data transfer for each ordered pair of variables in an FMU-FMU interface.
add_participant	This command operates in one of two modes, depending on how it is called.
add_reference_frame	Add a reference frame to the datamodel
add_thermal_data_transfers	Adds group of data transfers for thermal physics.
add_transformation	Add a transformation to a reference frame defined in the datamodel
delete_transformation	Delete a transformation from a reference frame
generate_input_file	Generates the input journal file for a given Fluent participant.
get_add_data_transfer_group_commands	Given an interface name, returns a list with possible commands
get_execution_command	Gets the execution command needed to start the specified participant
get_mode_shape_variables	Given an interface name, returns a list of mode shape variables available
get_region_names_for_participant	Gets all of the specified participant’s regions.
get_setup_summary	Returns a string containing a formatted summary of the
get_status_messages	Provides information relating to the current state of the analysis setup.
get_supported_participant_types	Returns a list of participant types that are supported by System Coupling.
get_thermal_data_transfer_options	Given an interface name, returns a list of available possible options for
has_input_file_changed	Given the name of a participant, checks whether the input file has changed.
import_system_coupling_input_file	Reads the specified System Coupling SCI file and pushes its information
reload_expression_function_modules	This may be called to force a reload of expression function modules
update_participant	Given the name of a server participant, updates the state of the participant.