FlowExchange

The FlowExchange package provides CAPE-OPEN based unit operations to import and export material stream data from CAPE-OPEN compliant flowsheet environments. Applications include

• Exchange of material stream data between flowsheet simulations of the same flowsheet simulator package,
• Exchange of material stream data between flowsheet simulations of different flowsheet simulator packages,
• Importing software-generated material stream data from non-flowsheet software applications via an XML format,
• Exporting flowsheet simulation generated material stream data via an XML format to non-flowsheet software applications,
• Archiving flowsheet simulation generated material stream data in XML format to a database.

The FlowExchange package consists out of two unit operations:

• The XFlowSaver Unit operation: this unit operation can be used in a product stream or intermediate stream in a flowsheet. Its main purpose is to save an XFlow file.
• The XFlowLoader Unit operation: this unit operation can be used to define a feed stream in a flowsheet. Its main purpose is to read an existing XFlow file and define the product stream.

The XFlow file format is an open, XML based, file format designed to exchange material stream data between flowsheet simulators. XFlow files are written by the XFlowSaver unit operation and read by the XFlowLoader unit operation, but any 3rd party application can easily parse or write XFlow files. The level of detail that are saved in an XFlow file by the XFlowSaver is configurable. The .XFlow file format specification is available here; also see this example .XFlow file content.

The FlowExchange package includes a stand-alone viewer and comparison tool for XFlow files.

Source Code

The FlowExchange package is written in Visual Studio 2017, using the .NET 4.6.1 platform. The source code is available, and is included in the FlowExchange package installer. To compile the source code, the CO-LaN PIA must be installed

Availability

The FlowExchange installer is available from the Downloads Page.

The FlowExchange package is open-source and free-of-charge.

Links

• Tutorial video available by VMGEurope, demonstrating interaction via XFlow files written from VMGSim, linking to COCO simulator using the XFlowLoader Unit operation: Click Here.

Change log

Version 1.0.3

• corrected an error where mole fractions and mass fractions referenced the same error after compound mapping, causing mass fractions to be interpreted as mole fractions in the XFlowLoader

Version 1.0.4

• added Consumes_Thermo_CATID, SupportsThermodynamics10_CATID and SupportsThermodynamics11_CATID

Version 1.0.5

• Edit returns S_FALSE in case the unit operation has not changed

Version 1.0.6

• Fixed issues with option parameters
• Fixed issue with IPersistStream::Getmaxsize
• Fixed issue with obtaining errors from CAPE-OPEN object

Version 1.0.7

• Code and help spell checked

Version 1.0.8

• Signed binaries

Version 1.0.9

• Changed default installation folder for current user

Version 2.0.0

• Upgrade to VS 2015
• Moved to .NET 4.5.1
• Embedded interop types

Version 2.0.1

• Upgrade to VS 2017
• Moved to .NET 4.6.1
• Reference to CO-LaN CAPE-OPEN .NET PIA

Version 2.0.2

• Upgrade to VS 2022
• Fixed issue with decimal separator