Exchanged Fields Reference

The Co-Simulation API provides functions for outgoing and incoming fields. Registration functions instruct the API to prepare for exchanging particular fields.

The following code shows an example registration for outgoing fields. This example uses the Property Suite to assign a string (in this case, the field name) to the registered field:

int propertiesId = propertiesSuite->create();

propertiesSuite->addString(propertiesId, "FieldTitle", "Displacement Field");

int displacementId = factorySuite->registerOutgoingField(
  zoneId,
  StarccmplusVertexFieldLocation,
  StarccmplusDisplacementSpecification, 
  StarccmplusDisplacements, 
  propertiesId);

Example registration for incoming fields:

int pressureId = factorySuite->registerIncomingField(
  zoneId,
  StarccmplusFaceFieldLocation,
  StarccmplusPressureSpecification,
  StarccmplusPressure,
  propertiesSuite->create());  

Use the following table in registration functions for data fields:

Use the StarccmplusSpecification to say what quantity your program is going to exchange (incoming or outgoing). Use the StarccmplusFieldType to define the type of data that the codes exchange for that quantity.