Detailed Description

Wrapper for CoSimulationApplication coupling procedures.

Default parameters:

{
   "interface_datasets" : [],
   "transform_operators" : {},
   "coupling_sequence" : [],
   "convergence_accelerators" : [],
   "convergence_criteria" : [],
   "max_iterations" : 0
   "verbosity" : 2
}

"transform_operators" is forwarded to CoSimulationApplication.factories.helpers.CreateDataTransferOperators. "coupling_operations" is forwarded to CoSimulationApplication.factories.helpers.CreateCouplingOperations.

Items in "interface_datasets" represent exposed sets of data on partition interfaces. The expected format of each item:

{
   "name" : "",            // <== name of the dataset
   "partition" : "",       // <== name of related partition
   "model_part_name" : "", // <== name of the ModelPart within the partition the dataset is defined on
   "dimension" : 0,        // <== number of components in each item of the dataset
   "variable_name" : ""    // <== name of the variable the dataset refers to
}

Each item in "coupling_sequence" either defines a fetch-transform-write operation DatasetTransfer or a subsynchronization (usually a single call to PythonSolver.SolveSolutionStep) SubSynchronization. Each item is expected in the following format:

{
   "type" : "",        // <== "trasfer" or "subsync"
   "parameters" : {}   // <== parameters passed on to the appropriate constructor
}

fetch a specific dataset from a source partition
transform the fetched dataset
write the transformed dataset to a dataset defined in the target partition

The documentation for this class was generated from the following file:

CoSimCoupling.py