Results Provider

A results provider is a process that reads an upstream results file and uses the SIMULIA Co-Simulation Services to transfer and map fields to a downstream analysis.

You can use a results provider only with the Abaqus solvers. Abaqus provides a keyword interface and generates the configuration and specification files. The Abaqus execution driver launches the results provider and the SIMULIA Co-Simulation Services Director processes.

This page discusses:

In general, a results provider can import fields into any application that supports the SIMULIA Co-Simulation Services; if a solver can import a field for a co-simulation, it can import the field in a sequential analysis with minimal amount of coding effort. Typically, such coding effort encompasses a user interface, authoring the configuration and specification files, and launching the result provider and SIMULIA Co-Simulation Services Director processes.

Developing a Results Provider

Developing a results provider requires familiarity with Abaqus and the SIMULIA Co-Simulation Services API. Results providers are easier to develop compared to embedding the SIMULIA Co-Simulation Services in a solver for the purpose of co-simulation because of the following:

  • template code is provided as a starting point;
  • results providers require only a subset of the SIMULIA Co-Simulation Services API;
  • results providers are generally simpler applications than solvers; and
  • you do not need to worry about stability of the segregated solution approach.
However, the programmer should have the expertise outlined in Intended Users.

Results Provider Template

A results provider template is provided in the SIMULIA Co-Simulation Services API kit. This template provides the necessary SIMULIA Co-Simulation Services calls. Typically, you need to provide code only for extracting data from your results file, maintaining your data in memory, and casting it to the form required by SIMULIA Co-Simulation Services.

Extract the SIMULIA Co-Simulation Services API kit from the Abaqus media (see Extracting the SIMULIA Co-Simulation Services API Kit). Copy the file ResultsProviderTemplate.cpp from the /ResultsProvider folder, and use it as a starting point to develop a results provider for your application.

If you have Abaqus installed, you can also use the following command to fetch the results provider template:

abaqus -fetch -job ResultsProviderTemplate.cpp

Release Compatibility

Release compatibility is discussed in Release Compatibility. Typically, the results provider is launched from the Abaqus execution driver; therefore, the Abaqus execution driver uses the Co-Simulation libraries provided with the Abaqus release. We recommend updating the Co-Simulation Services with every major Abaqus release and ensuring that the SIMULIA Co-Simulation Services API header files have not changed between releases.

Launching the Results Provider

You can launch the results provider automatically from the Abaqus execution driver, or you can start all processes manually.

Command Line Arguments

The Abaqus execution driver launches the results provider with the arguments specified below. We recommend that your results provider adheres to the same arguments; otherwise, you must start all processes manually.

The following command line arguments are required for automatic launching:

job

The job name of the upstream analysis without its extension.

The job name reflects the value of the FILE parameter (without its extension) on the EXTERNAL FIELD option when launched from Abaqus.

file

The results file path and name with extension. You read the upstream results from this file.

The file name reflects the value of the FILE parameter on the EXTERNAL FIELD option when launched from Abaqus.

spec

The results provider specification file with its extension. Abaqus generates the specification file.

The file name is the upstream job name with the _spec and .xml extension. For example, if the upstream job is UpstreamJob, the specification file produced by Abaqus is UpstreamJob_spec.xml.

csedirector
The host and listener port of the SIMULIA Co-Simulation Services Director.

You must use a colon between the host and port.

timeout
An optional timeout period in seconds.

Launching the Results Provider from Abaqus

The Abaqus execution procedure automatically launches the results provider and the SIMULIA Co-Simulation Services Director. In this case, do not specify the csedirector argument on the Abaqus command line. The READER parameter on the EXTERNAL FIELD option specifies the results provider executable name. You must provide the path and executable name (including its extension). The Abaqus preprocessor generates the configuration and specification files. The Abaqus execution driver then sets the required environment variables as discussed in Setting up the Runtime Environment.

Launching the Results Provider Manually

You can start the results provider manually. This is useful when developing and debugging the results provider, or when your results provider uses different arguments from what the Abaqus execution procedure uses. In this case, provide the csedirector argument on the Abaqus command line, and start the SIMULIA Co-Simulation Services Director and the results provider. In addition, you must define the required environment variables as outlined in Setting up the Runtime Environment.

Generating the Configuration and Specification Files

Typically, the results provider requires a specification file and the SIMULIA Co-Simulation Services Director requires a Co-Simulation Configuration file. An easy way to author these files is to run an Abaqus datacheck execution procedure. The Abaqus datacheck procedure generates both files based on the EXTERNAL FIELD, FIELD MAPPER CONTROLS, and FIELD OPERATIONS options. These files are valid as long as you do not make any changes to the Abaqus input file or rename the Abaqus job.

Use the following command to generate the configuration and specification files using the Abaqus datacheck execution procedure:

abaqus –job downstream –datacheck

Running the Analysis

You must start the Abaqus analysis, the SIMULIA Co-Simulation Services Director, and the results provider to run the analysis. The examples below assumes that the results provider uses the same arguments that the Abaqus execution driver uses. The downstream job refers to the analysis importing the results, and the upstream job refers to the analysis exporting the results.

To continue the Abaqus analysis after the datacheck using the co-simulation director running on a local host with listener port 91000:

abaqus -continue –job downstream –csedirector localhost:91000 

To start the director process using the configuration file downstream_config.xml and the listener port 91000:

abaqus –cse -configure downstream_config.xml –listenerport localhost:91000

To start myResultsProvider reading from the file upstream.dat with the specification file upstream_spec.xml:

myResultsProvider -job upstream -file upstream.dat -spec upstream_spec.xml -csedirector localhost:91000