partition_participants

class ansys.systemcoupling.core.adaptor.api_25_2.partition_participants.partition_participants(name=None, parent=None)

Bases: Command

Provide a utility for setting the parallel algorithm, parallel partitioning fractions for each participant, and machine list information.

At least one participant must be defined for this command to be used. Use of this command is not recommended if participants are already running.

Note: Ansys recommends only using this command for the Custom partitioning algorithm.

When other algorithms are used (SharedAllocateMachines, DistributedAllocateCores, etc.) the algorithm should be specified directly, for example:

setup.analysis_control.partitioning_algorithm = "SharedAllocateMachines"

The participant parallel fractions can also be specified directly, for example:

setup.coupling_participant["FLUENT-1"].execution_control.parallel_fraction = 0.5

The machine list should be specified via System Coupling command line arguments, for example:

<v252>/SystemCoupling/binsystemcoupling --cnf="hostA:4,hostB:4"

Parameters:

algorithm_namestr, optional

Name of the partitioning algorithm. Available algorithms are: ‘SharedAllocateMachines’(default), ‘SharedAllocateCores’, ‘DistributedAllocateMachines’, ‘DistributedAllocateCores’, and ‘Custom’ (please see partitioning_info section below for more details for this algorithm)

The algorithms allow for both shared and distributed execution and for the allocation of machines or cores. The default value is generally the best choice, as it allows for each participant to take advantage of all the allocated resources. The other partitioning methods are provided to handle situations where not enough resources are available to run the same machines.

See the System Coupling documentation for more details of the partitioning algorithms.

names_and_fractionsList, optional

List of tuples specifying the fractions of core count applied for each participant

Each tuple must have the ParticipantName as its first item and the associated fraction as its second item. If this parameter is omitted, then cores will be allocated for all participants set in the data model.

machine_listList, optional

List of dictionaries specifying machines available for distributed run. Each dictionary must have a key ‘machine-name’ with machine name as its value, and key ‘core-count’ with number of cores for that machine as its value. Providing this argument will over-ride any machine-list information detected from the scheduler environment and any information provided by the –cnf command-line argument.

partitioning_infoDict, optional

Dictionary specifying machines resources assigned to each participant by user. Dictionary must have participant names as keys and machineLists containing machine resources as values. The value of partitioning_info machineList is a list of dictionaries specifying machines assigned to corresponding participants. Each dictionary of machine mist must have a key ‘machine-name’ with machine name as its value, and key ‘core-count’ with number of cores for that machine as its value. Providing this argument will disallow other arguments except algorithm_name, which must set as ‘Custom’ if provided. Otherwise, algorithm_name will be set as ‘Custom’ internally if partitioning_info is provided.

Included in:

Parent	Summary
solution_root	‘root’ object