COMOS. Process FEED Administration. Supported process simulators 1. Assigning units between Aspen Plus or ProMax and COMOS

Transcription

1 Supported process simulators 1 Assigning units between Aspen Plus or ProMax and COMOS 2 COMOS Process Operating Manual Modifying the standard import 3 Assemblies 4 Creating and grouping pure components under the "Pure components" folder 5 Tips for base data administrators 6 Base data reference 7 Project properties reference 8 03/2017 V A5E AB

2 Legal information Warning notice system This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are graded according to the degree of danger. DANGER indicates that death or severe personal injury will result if proper precautions are not taken. WARNING indicates that death or severe personal injury may result if proper precautions are not taken. CAUTION indicates that minor personal injury can result if proper precautions are not taken. NOTICE indicates that property damage can result if proper precautions are not taken. If more than one degree of danger is present, the warning notice representing the highest degree of danger will be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property damage. Qualified Personnel The product/system described in this documentation may be operated only by personnel qualified for the specific task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified personnel are those who, based on their training and experience, are capable of identifying risks and avoiding potential hazards when working with these products/systems. Proper use of Siemens products Note the following: Trademarks WARNING Siemens products may only be used for the applications described in the catalog and in the relevant technical documentation. If products and components from other manufacturers are used, these must be recommended or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance are required to ensure that the products operate safely and without any problems. The permissible ambient conditions must be complied with. The information in the relevant documentation must be observed. All names identified by are registered trademarks of Siemens AG. The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owner. Disclaimer of Liability We have reviewed the contents of this publication to ensure consistency with the hardware and software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this publication is reviewed regularly and any necessary corrections are included in subsequent editions. Siemens AG Division Process Industries and Drives Postfach NÜRNBERG GERMANY A5E AB P 02/2017 Subject to change Copyright Siemens AG All rights reserved

3 Table of contents 1 Supported process simulators Assigning units between Aspen Plus or ProMax and COMOS Modifying the standard import Overview of the topic "Modifying the standard import" Buttons for import objects Simulation objects Import() ImportDone() SimulatorImport() SimulatorImportDone() Aspen Plus: Class AspenNode Properties Read() ReadArray() CreateSubObjects() XML ValueExist() ProMax ReadBlock_Property() ReadPStreamComposition_Property() ReadPStreamPhase_Property() Public class ProMaxNode Public class BlockNode: ProMaxNode Public class StreamNode: ProMaxNode Public class ComponentNode: StreamNode PRO/II:Class ProIINode Properties Read() ReadArray() ReadArrayToFewSpecs() ReadSI() GetComosSpecArray() Functions that are used internally HYSYS: Class HYSYSNode Properties HYSYSClass() LiquidPhase1() LiquidPhase2() Read() ReadPhase VaporPhase() UniSim Design: Class UniSimNode...39 Operating Manual, 03/2017 V , A5E AB 3

4 Table of contents Read() Public Sub ReadPhase() Properties of the combined liquid phase EbsilonProfessional: Class EbsilonNode Properties GetEbsKind() Read() ReadNumeric() ChemCad: Class ChemCad Node Extension for COMOS Properties GetChemCadClass() ReadNumeric() ReadEquilibriumReactionPar() ReadStreamComponents FillTrayStreamList Default settings for the simultaneous import of multiple files Importing additional attributes Setting margins for automatic placing of equipment on reports Excluding certain simulation types from the import Adapting an HTRI import/export Assemblies General notes on assemblies Creating P&ID assemblies Create a template Creating the structure of the template Creating P&ID assemblies Configuring script for connector mapping Assigning connectors Making assemblies available Creating and grouping pure components under the "Pure components" folder Tips for base data administrators Tips on process units Tips on boundary streams Checking the links of the equipment attributes Base data reference Attributes with locally filtered units Simulation objects Properties of the simulation objects Equipment simulation objects Stream simulation objects CompCalc simulation object Material stream simulation object Operating Manual, 03/2017 V , A5E AB

5 Table of contents Simulation subobjects Heating curves - simulation object Components - simulation object Column tray - simulation object Condensation curves - simulation object Simulation import objects Simulation import objects Simulation case process unit PFD objects Equipment General properties of equipment Column Heat exchanger Tray layout (general) Column section Equipment design cases Properties general Column (equipment case) Tray layout (general) (equipment case) Components Pure components Design cases Process streams Used classes Standard tables "Aspen units" "Aspen units for domain DELTA-T" "TEMA letter 1-3" "Stream/tray/stage composition" "Columns/trays/stages" System: "Graphical representation" Base objects for import documents PRO/II simulation import process HYSYS simulation import process Project properties reference "Case variants" category...89 Operating Manual, 03/2017 V , A5E AB 5

6 Table of contents 6 Operating Manual, 03/2017 V , A5E AB

7 Supported process simulators 1 Supported process simulators (publisher software name - version type of data exchange) AspenTech - AspenPlus - V8.8, V9 - XML AspenTech - HYSYS - V8.8, V9 - Com AspenTech - Shell&Tube Exchanger EDR (previously HTFS/TASC+) - V8.0 Schneider (SimSci)/ Invensys Operations Management - PRO/II - V9.2, V Com Honeywell Process Solutions - UniSim Design - R440, R443 - Com Chemstations Inc. - ChemCad - V6.5, V Com Note Parallel installation ChemCad V6 and ChemCad V7 If you install ChemCad V7 in addition to ChemCad V6, an import of files of version 6 is no longer possible. Note Using older methods If you open a simulation that contains old methods with ChemCad, more up-to-date calculation methods are offered in a dialog. When you import a ChemCad file that contains old methods into COMOS, the same dialog is opened in the background, but it cannot be operated from COMOS. You have the possibility of opening this dialog via ChemCad and activating the option, so that this dialog is no longer displayed. Alternatively open the file in ChemCad and save it unchanged so that you overwrite the old file. The dialog is no longer displayed afterwards. Bryan Research & Engineering, Inc. - ProMax - V4.0 - XML Evonik Energy Services GmbH - Ebsilon Professional - V9 - Com (discontinued) Heat exchanger (publisher software name - version type of data exchange) Heat Transfer Research, Inc. - HTRI - V6, V Com Designation in the manual The software product AspenPlus is a product of the AspenTech company, and is referred to simply as AspenPlus in the rest of this document. The software product HYSYS is a product of the AspenTech company, and is referred to simply as HYSYS in the rest of this document. The software product PRO/II is a product of the Invensys Operations Management company, and is referred to simply as PRO/II in the rest of this document. Operating Manual, 03/2017 V , A5E AB 7

8 Supported process simulators The software product UniSim Design is a product of the Honeywell Process Solutions company, and is referred to simply as UniSim in the rest of this document. The software product ChemCad is a product of the Chemstations Inc. company, and is referred to simply as ChemCad in the rest of this document. The software product ProMax is a product of the Bryan Research & Engineering company, and is referred to simply as ProMax in the rest of this document. The software product EbsilonProfessional is a product of the company Evonik Energy Services GmbH, and is referred to simply as EbsilonProfessional in the rest of this document. 8 Operating Manual, 03/2017 V , A5E AB

9 Assigning units between Aspen Plus or ProMax and COMOS 2 To import the attribute values correctly to COMOS, set up an assignment between the units of the simulation files and the COMOS units. Whenever new units are added to the simulation files, you must expand the standard tables accordingly. See also chapter Standard tables (Page 82). Standard tables This assignment is made using the following standard tables: "Y40 > M21 > A10 > Y40M21N00001 Aspen units" "Y40 > M21 > A10 > Y40M21N00005 ProMax dimension units" Column "Name" "Value1" Description This column contains the units as they are defined in XML in the "unit" attributes of a node. This column contains the name of the assigned COMOS unit as defined in the COMOS unit system. Additional information about Aspen Plus Below this standard table, additional standard tables are defined which help to differentiate between Aspen Plus units that belong to multiple unit groups. The unit groups are defined in XML using the "domain" attribute. The name of this table corresponds to the name of the "domain" attribute, e.g. "Y40 > M21 > A10 > Y40M21N00001 > HEAD Aspen units for domain HEAD". Operating Manual, 03/2017 V , A5E AB 9

10 Assigning units between Aspen Plus or ProMax and COMOS 10 Operating Manual, 03/2017 V , A5E AB

11 Modifying the standard import Overview of the topic "Modifying the standard import" Functions controlling the sequence of the import operation are defined in the "Script" tab of the base objects of the import documents, the simulation objects, and the buttons that start the import steps. In the database, these functions call the standard import operation. Modification However, you have the option of modifying the standard import operation by extending the functions via the script. In this way you can, for example, import attributes that are not considered by the standard import, or change the way the attributes are assigned in comparison to the standard import. In the script, the full scope of the standard COMOS script functions is available. See also Buttons for import objects (Page 11) Simulation objects (Page 12) 3.2 Buttons for import objects In the "Import data" tab, the import documents have various buttons that launch the individual import steps. Each of these buttons has an OnClick() script that controls the import step in question. The buttons available differ depending on the import document. The following commands within the OnClick() script start the standard import: "BU001 Start import": Workset.lib.pe.Simulation.StartImport ThisObject Starts the first import step. StartImport() creates an instance, calls its Import(), and transfers the CDevice of the import object as a parameter. "BU002 Start partial import": Workset.lib.pe.PeScript.Simulation.StartPartialImport ThisObj Starts the partial import, during which the import objects can be selected individually. "BU003 Create PFD objects": Workset.lib.pe.Simulation.CreatePFDObjects ThisObject Starts the second import step. Operating Manual, 03/2017 V , A5E AB 11

12 Modifying the standard import 3.3 Simulation objects "BU004 Place PFD equipment": Workset.lib.pe.Simulation.PlaceObjectsOnPFD1 owner.owner, Nothing Starts the third import step. "BU005 Place PFD streams": Workset.lib.pe.Simulation.PlaceStreamOnPFD1 owner.owner Starts the fourth import step. "BU006 Objects on sub flow sheets" Workset.lib.Pe.PlaceObjectsOnMultiplePFD GetSpecOwner, GetSpecOwner.spec("M21Y00T026.Y00A01382").LinkObject, true Creates additional PFDs and places equipment on sub-flow charts. If necessary, adapt the scripts using additional commands. Delete the commands only if you want to replace the standard import completely with your own import. However, the actual modification of the standard import function takes place in the user script blocks of the simulation objects. 3.3 Simulation objects Functions Each base object below > M21 > A50 > A10 > A30 Simulation objects" defines multiple functions in the "Script" tab. These functions control what happens with this object during the first two import steps. The start of the function body calls the standard import function for the object. You can extend the standard import in the subsequent lines. References See also: Chapter Aspen Plus: Class AspenNode (Page 17) Chapter ProMax (Page 25) Chapter HYSYS: Class HYSYSNode (Page 36) Chapter PRO/II:Class ProIINode (Page 30) Chapter UniSim Design: Class UniSimNode (Page 39) Chapter EbsilonProfessional: Class EbsilonNode (Page 40) Chapter ChemCad: Class ChemCad Node (Page 42) This way you can, for example, import attributes that are not imported via the standard import, or change the way in which attributes are assigned compared with the standard import. Do not delete the call for the standard import. 12 Operating Manual, 03/2017 V , A5E AB

13 Modifying the standard import 3.3 Simulation objects Exception The standard import operation should not be executed at all for this object but is replaced completely by a script that is defined in the function. This involves the following functions: Function [InterfaceName]Import(Node ) [InterfaceName]ImportDone( Node) SimulatorImport(DevSimObj) SimulatorImportDone(devPFD Obj, DevSimObj) Description This function is called for each simulation object shortly before the end of the first import step. See also chapter Import() (Page 14). A reference to the node object of the simulation object is transferred as a parameter. You can use this function to import attributes that are not imported by the standard import. You have to consider that these attributes must exist on the simulation object and its PFD object. If this is not the case, they must be created in the base data beforehand. If you want to modify how attributes are assigned in the standard import, you need to undo the value assignments made via the standard import in the script before reassigning the attributes as required. Following applies in both cases: In order to also pass the modified settings for the standard import to the PFD object, the attribute linking between the simulation object and PFD object must be modified accordingly. If new attributes were added, you may need to modify the report templates of evaluating reports that should work with these attributes. Called once the Import() function for all simulation objects has been executed and is responsible for post-calculations. A reference to the node object of the simulation object is transferred as a parameter. Example: Conversion of the molar density into mass density. See also chapter ImportDone() (Page 15). This function is called for each simulation object in the second import step. A reference to the import object is transferred as a parameter. See also chapter SimulatorImport() (Page 16). Called once the SimulatorImport() function has been executed for all simulation objects and is responsible for post-calculations. A reference to the import object is transferred as a parameter. See also chapter SimulatorImportDone() (Page 16). Operating Manual, 03/2017 V , A5E AB 13

14 Modifying the standard import 3.3 Simulation objects Import() Functions Aspen Plus: UserScriptBlock1: "Function AspenImport(Node)" Call standard import: Node.ExecuteStandardImportScript PRO/II: UserScriptBlock2: "Function ProIIImport(Node)" Call standard import: If ThisObj.SystemType = 13 Then Workset.lib.pe.Pro2Simulation.import ProIINode, GetClassification(1) Else Workset.lib.pe.Pro2Simulation.import ProIINode, CDevice.GetClassification(1) End If HYSYS: UserScriptBlock3: "HYSYSImport(Node)" Call standard import: If ThisObj.SystemType = 13 Then Workset.lib.pe.HysysSimulation.Import node, GetClassification(1) Else Workset.lib.pe.HysysSimulation.Import node, CDevice.GetClassification(1) End If UniSim Design: UserScriptBlock5: If ThisObj.SystemType = 13 Then Workset.lib.pe.UnisimSimulation.Import node, GetClassification(1) Else Workset.lib.pe.UnisimSimulation.Import node, CDevice.GetClassification(1) End If ProMax: UserScriptBlock6: Node.executeStandardImportScript 14 Operating Manual, 03/2017 V , A5E AB

15 Modifying the standard import 3.3 Simulation objects ChemCad: UserScriptBlock7: If ThisObj.SystemType = 13 Then Workset.lib.pe.ChemCadSimulation.Import node, GetClassification(1) Else Workset.lib.pe.ChemCadSimulation.Import node, CDevice.GetClassification(1) End If EbsilonProfessional: UserScriptBlock8: If ThisObj.SystemType = 13 Then Workset.lib.pe.EbsilonSimulation.Import node, GetClassification(1) Else Workset.lib.pe.EbsilonSimulation.Import node, CDevice.GetClassification(1) End If ImportDone() Functions Aspen Plus: UserScriptBlock1: "Function AspenImportDone(Node)" Call standard import: Node.ExecuteStandardImportDone PRO/II: UserScriptBlock2: "Function ProIIImportDone(Node)" Call standard import: Workset.lib.pe.Pro2Simulation.importdone ProIINode HYSYS: UserScriptBlock3: "Function HYSYSImportDone(Node)" Call standard import: If ThisObj.SystemType = 13 Then Workset.lib.pe.HysysSimulation.ImportDone node, GetClassification(1) Else Workset.lib.pe.HysysSimulation.ImportDone node, CDevice.GetClassification(1) End If Operating Manual, 03/2017 V , A5E AB 15

16 Modifying the standard import 3.3 Simulation objects UniSim Design: UserScriptBlock5: If ThisObj.SystemType = 13 Then Workset.lib.pe.UnisimSimulation.ImportDone node, GetClassification(1) Else Workset.lib.pe.UnisimSimulation.ImportDone node, CDevice.GetClassification(1) End If ProMax: UserScriptBlock6: Workset.lib.pe.ProMaxSimulation.ImportDone Node ChemCad: UserScriptBlock7: If ThisObj.SystemType = 13 Then Workset.lib.pe.ChemCadSimulation.ImportDone node, GetClassification(1) Else Workset.lib.pe.ChemCadSimulation.ImportDone node, CDevice.GetClassification(1) End If EbsilonProfessional: UserScriptBlock8: Workset.lib.pe.EbsilonSimulation.importdone Node SimulatorImport() All interfaces UserScriptBlock4: SimulatorImportDone(devPFDObj, devsimobj) Call standard import Set SimulatorImport = ImportDone(devPFDObj, devsimobj) SimulatorImportDone() All interfaces UserScriptBlock4: SimulatorImportDone(devPFDObj, devsimobj) 16 Operating Manual, 03/2017 V , A5E AB

17 Modifying the standard import 3.4 Aspen Plus: Class AspenNode Call standard import Set SimulatorImport = Workset.lib.pe.simulator. ImportDone(devPFDObj, devsimobj) 3.4 Aspen Plus: Class AspenNode Modification The first two import steps can be modified using the AspenNode class from the "Comos.Aspen.XMLImp.dll" file. Background: An instance of AspenNode is created for each simulation object during the import operation. This instance is a temporary object that serves as a link between COMOS (the target object = the simulation object) and AspenTech Aspen Plus (the source object = the XML node) and is only available during the import operation. In addition, the import functions defined in the "Script" tab are called for each simulation object during the standard import operation. See also chapter Simulation objects (Page 12). For these calls the AspenNode instance which was created for the simulation object is transferred as a parameter. The import calls can be extended and the standard inport function for the first two import steps adjusted using the functions and variables of the AspenNode instance. The "AspenXMLImp.dll" file also contains the AspenXMLImp class. This class is instantiated in the OnClick() script of the "BUTTON1 Start Import" button of the AspenTech Aspen Plus import object. See also chapter Buttons for import objects (Page 11). Next, the following function of the AspenXMLImp instance is called in the script: Sub Import(ByVal devsimulator As IComosDDevice) This function starts the import operation. A reference to the AspenTech Aspen Plus import object is transferred as a parameter. Result of the call The simulation objects are created below devsimulator and an instance of AspenNode is generated for each simulation object Properties ComosDevice Public ComosDevice As IcomosDDevice Operating Manual, 03/2017 V , A5E AB 17

18 Modifying the standard import 3.4 Aspen Plus: Class AspenNode Reference to the simulation object whose script is currently being executed. Example: Node.ComosDevice.spec("Y00T00133.Y00A02301").Value Reads the value of attribute PD.CD0055 of the current simulation object. AspenXMLNode Public AspenXMLNode As MSXML.IXMLDOMNode Reference to the current XML source node. The declaration as MSXML.IXMLDOMNode refers to the standard Microsoft XML library. Through this you have access to numerous XML default properties, for example: AspenXMLNode.SelectSingleNode(ByVal nodename as String) Selects a particular node via the name and returns the node. Example: Can be used to check whether or not a particular node exists. If Not Node.AspenXMLNode.SelectSingleNode("TSINP_SSTG") Is Nothing Then End If AspenXMLNode.NodeName As String Returns the name of the current XML node as a string. Example: Can be used to execute code only for a particular node. If Node.AspenXMLNode.NodeName = "BlockRadfrac" Then End If IsLogActive Public Property IsLogActive() As Boolean Allows you to turn the log texts on and off. This way, the administrator can determine which error or warning messages are to be included in the log text. Example: Activate the log text while a subobject is being created. If the required XML subnode does not exist, an error message is written to the log text. Node.IsLogActive = True Node.CreateSubObjects "B_TEMP", "Stage", "Tray" Node.IsLogActive = False Liquidphase2 The Aspen interface imports the second liquid phase for flows and column trays. This concerns the molar and mass flow and the molar and mass portion of individual components. 18 Operating Manual, 03/2017 V , A5E AB

19 Modifying the standard import 3.4 Aspen Plus: Class AspenNode To this end there are the following Properties of type Boolean in class AspenNode: IsLightLiquidInStream IsHeavyLiquidInStream IsVapourInStream Read() Public Function Read(ByVal straspenxmlattribute As String, ByVal strcomosspecname As String) As Boolean Reads a single value from an XML node and writes it to a COMOS attribute. XML values defined by "*" are skipped during the import operation. Parameter "strcomosspecname" Type: String Name of the target attribute. Parameter "straspenxmlattribute" Type: String A combination of the name of the XML node and a precise definition of the source value. The definition of the source value can be made up from several blocks: "domain" Defines the unit group If the source value involves a numeric value with a unit, then a "domain" attribute must exist at the XML node. The attribute must be incorporated in the detailed definition of the source value. Exception: Multiple unit groups exist in a node. In that case "domain" has the value "MultiDomain" and is not specified in the definition of the source value. Dimensions An XML node can have a one dimensional or a multi-dimensional data field. The single dimensions are defined via subnodes. Each dimension owns a collection of "items". If one item was determined for each dimension, the associated value can be determined from the "Value" subnode. This results in the following notation for straspenxmlattribute: [XMLNodeName](domain:[value], [NameDimension_1]:[value from "items"],[namedimension_2]:[value from "items"],...) The precise definition of the source value is optional and depends on the structure of the XML node. The round brackets are mandatory. They are also required to be stated if the definition of the source value is omitted. The text in square brackets must be replaced by the specific values. Operating Manual, 03/2017 V , A5E AB 19

20 Modifying the standard import 3.4 Aspen Plus: Class AspenNode If a dimension is not specified, COMOS cannot determine which value is to be selected. A log entry is made. A number of examples follow. The target attribute is Y00T00134.Y00A01355 in all examples. No definition of the source value is required Name of the XML node: MW_LIQ The node does not have a "unit" attribute, and hence no "domain" attribute. In addition, the node does not have a data field but instead only a single value. Thus there are also no existing dimensions. The definition of the source value is thus entirely omitted. Function call: Node.Read "MW_LIQ()", "Y00T00134.Y00A01355" Definition of the source value for a one-dimensional data field Name of the XML node: TEMP_OUT Attribute "domain": exists Value: TEMPERATURE Dimensions: a dimension SUBSTREAM: Value from "items": MIXED Function call: Node.Read "TEMP_OUT(domain:TEMPERATURE, SUBSTREAM:MIXED)", "Y00T00134.Y00A01355" 20 Operating Manual, 03/2017 V , A5E AB

21 Modifying the standard import 3.4 Aspen Plus: Class AspenNode Definition of the source value for a multi-dimensional data field Name of the XML node: HMX Attribute "domain": exists Value: MultiDomain -> multi-dimensional data field Dimensions: two dimensions SUBSTREAM: Value from "items": MIXED Domain: Value from "items": MASS-ENTHALP Function call: Node.Read "HMX(SUBSTREAM:MIXED, Domain:MASS-ENTHALP)", "Y00T00134.Y00A01355" ReadArray() Public Function ReadArray (ByVal straspenxmlattribute As String, ByVal strcomosspecname As String) As Boolean Reads a one-dimensional data field from an XML node and writes it to the XValues of a COMOS list attribute. XML values defined by "*" are skipped during the import operation. Parameter "strcomosspecname" Type: String Name of the COMOS list attribute. Parameter "straspenxmlattribute" Type: String Same as the parameter straspenxmlattribute of Read(). One dimension remains undetermined. It does not matter which dimension this is. If two or more dimensions are not Operating Manual, 03/2017 V , A5E AB 21

22 Modifying the standard import 3.4 Aspen Plus: Class AspenNode specified, the function call is under-determined. If all dimensions are determined, then Read() would be the correct function call. Examples: Name of the XML node: HT_FROM_TOP2 Attribute "domain": exists Value: LENGTH Dimensions: two dimensions NPOINTS and Stage Case 1: NPOINTS undefined Function call: Node.ReadArray "HT_FROM_TOP2(domain:LENGTH, Stage: 3)","Y00T00134.Y00A01355" Consequence: Two values are written into the XValues of list attribute Y00T00134.Y00A01355; in our example, the values from stage 3. Case 2: Stage undefined Function call: Node.ReadArray "HT_FROM_TOP2(domain:LENGTH, NPOINTS: 2)","Y00T00134.Y00A01355" Consequence: 18 values are written into the XValues, in our example the values from NPOINTS CreateSubObjects() Public Function CreateSubObjects(ByVal AspenXMLNodeName As String, ByVal AspenXMLSubNodeName As String, ByVal NamePrefix As String, Optional ByVal AspenSubObjClassName As String = "") As Boolean 22 Operating Manual, 03/2017 V , A5E AB

23 Modifying the standard import 3.4 Aspen Plus: Class AspenNode This function creates a new simulation object underneath the current COMOS device, provided that the simulation object that is to be created does not exist already: AspenXMLNodeName: Name of the XML subnode underneath which you find the names of the new objects. AspenXMLSubNodeName: Name of the subnode of the second order. This name determines which base object is used for creation. The values of this node determine how many objects are created and what names they have. NamePrefix: A desired combination of alphabetical letters that is prefixed to the object name. Example: Node.CreateSubObjects "X", "COMPONENTS", "C_" AspenSubObjClassname: Optional parameter for determining the base object of the subobject. If nothing or an empty string is specified, "AspenXMLSubNodeName" is used for determining the base object (as before) XML ValueExist() Public Function XMLValueExists(ByVal XMLInfoStr As String) As Boolean: Checks whether a particular XML attribute has a particular value. XMLInfoStr: Name of the XML attribute and the value that is being checked, as a string. The following notation applies: "Name_XMLNode(AttributeName:AttributeValue)" Example: Can be used to only execute commands if a particular value is present. Operating Manual, 03/2017 V , A5E AB 23

24 Modifying the standard import 3.4 Aspen Plus: Class AspenNode bvalueexists = Node.XMLValueExists("DUTY_OUT2(HCURV_NO:2)") Function Public Function ProcessSideColumns(ByVal AspenXMLNodeName As String, ByVal SideColumnSubNodeName As String, ByVal StageSubNodeName As String, ByVal SideColPrefix As String, ByVal AspenSubObjClassName As String) As Boolean Public Function ReadNoOfTrays(ByVal XMLNodeName As String) As Long Description Creates a number of additional columns, depending on the number of additional columns in the node AspenXMLNodeName. SideColumnSubNodeName specifies the subnode containing the names and numbers of the additional columns. StageSubNodeName is the node containing the maximum number of levels. SideColPrefix is the prefix that is to be added to the names of the additional columns. AspenSubObjClassName is the Aspen name of the base object that is used for the additional columns. Called by the import script of the object for the additional columns and uses the column index and a number of possible values. A number of storage locations, which read values from the XML nodes, are calculated in this column as the start and end index. 24 Operating Manual, 03/2017 V , A5E AB

25 Modifying the standard import 3.5 ProMax Function Public Function CreateSideColumnTrays(ByVal AspenXMLNodeName As String, ByVal AspenXMLSubNodeName As String, ByVal NamePrefix As String, ByVal AspenSubObjClassName As String) As Boolean Public Function CreateColumnInternalStreams(ByVal AspenXMLNodeName As String, Optional ByVal AspenSubObjClassName As String = "") As Boolean Description Creates storage locations underneath the additional columns. There is not a storage location for every entry. AspenXMLNodeName (String): AspenXMLSubNodeName (String): Depending on Aspen version "Stage" or "TRAY_NO" AspenSubObjClassName: Aspen name of the base object that is used for storage locations. Creates internal processes for columns with additional columns. AspenXMLNodeName (String): Name of the node containing information for internal processes. AspenXMLSubNodeNameColu mns (String): Name of the node that contains the column name. AspenXMLSubNodeNameStre ams (String): Name of the node that contains the names of the processes. Optional: AspenSubObjClassName (String = ""): SIM should be used if the processes are not material processes. 3.5 ProMax ReadBlock_Property() public void ReadBlock_Property(string propertyname, string comosspecname) Operating Manual, 03/2017 V , A5E AB 25

26 Modifying the standard import 3.5 ProMax Parameters propertyname Identifies the source data field at an equipment project. comosspecname Identifies the target data field in COMOS ReadPStreamComposition_Property() public void ReadPStreamComposition_Property(string phasename, string propertyname, string comosspecname) Parameters phasename Identifies the phase at a component source object. propertyname Identifies the source data field at a component source object. comosspecname Identifies the target data field in COMOS ReadPStreamPhase_Property() public void ReadPStreamPhase_Property(string phasename, string propertyname, string comosspecname) Parameters phasename Identifies the phase at a material stream simulation source object. propertyname Identifies the source data field at a material stream simulation source object. comosspecname Identifies the target data field in COMOS. You can use the ProMaxNode class and/or the classes inherited from it BlockNode, StreamNode, and ComponentNode from the "ProMaxImport.dll" file to modify the first import step. Background An instance of the ProMaxNode class or one of the classes inherited from it is created for each simulation object during the import operation. 26 Operating Manual, 03/2017 V , A5E AB

27 Modifying the standard import 3.5 ProMax This instance is a temporary object that serves as a link between COMOS (the target object = the simulation object) and ProMax (the source object = the XML node) and is only available during the import operation. In addition, the import functions defined in the "Script" tab are called for each simulation object during the standard import operation. See also chapter Simulation objects (Page 12). For these calls, the ProMaxNode instance and/or the additional classes inherited from ProMaxNode, which were created for the simulation object, are passed as parameters. The import calls can be extended and the standard import function for the first import step adjusted using the functions and variables of the ProMaxNode instance. The "ProMaxImport.dll" file also contains the ProMaxImp class. This class is instantiated in the OnClick() script of the "BUTTON1 Start import" button of the ProMax import object. Subsequently, the following function of the ProMaxImp instance is called in the script: Sub Import(ByVal devsimulator As IComosDDevice) This function starts the import operation. A reference to the ProMax import object is transferred as a parameter. Result of the call: The simulation objects are created underneath devsimulator and an instance of ProMaxNode or one of the classes inherited from it is generated for each simulation object Public class ProMaxNode The ProMaxNode class is implemented for all simulation objects. public IComosDDevice ComosDevice; Reference to the simulation object whose script is currently being executed. public XElement ProMaxXMLNode; Reference to the current XML source node. public string getpromaxxmlnodename() Returns the name of the XML node. Operating Manual, 03/2017 V , A5E AB 27

28 Modifying the standard import 3.5 ProMax Public class BlockNode: ProMaxNode The BlockNode class inherits from the ProMaxNode class. The BlockNode class is implemented for all simulation objects to be designated as equipment objects. public void createstageobjects() Creates the trays for a column. public void readblock_property(string propertyname, string ComosSpecName) Reads a value from the properties node of the XML node and writes it to a COMOS attribute. Parameter "propertyname" Type: String Name of the attribute in the properties node of the XML node Parameter "ComosSpecName" Type: String Name of the target attribute public void readblockstreamconnections() Reads out, in the XML node, the streams that are connected to the equipment and enters the data in the list of connectors in the COMOS import data. This method must be called for every equipment simulation object. 28 Operating Manual, 03/2017 V , A5E AB

29 Modifying the standard import 3.5 ProMax Public class StreamNode: ProMaxNode The StreamNode class inherits from the ProMaxNode class. The StreamNode class is implemented for all simulation objects to be designated as process streams or energy streams. public void createsubobjects(string phasename, string compositionelement, string propertyname) Creates the COMOS components for a process stream. The input data is needed to find out how many components there are underneath the process stream. Parameter "phasename" Type: String Name of the phase/the phase node in the XML node Parameter "compositionelement" Type: String Name of the component node in the phase node Parameter "propertyname" Type: String Name of the attribute in the component node public void readpstreamphase_property(string phasename, string propertyname, string ComosSpecName) Reads a value out from the XML node and writes this to the COMOS attribute. The value designates an attribute of a specific phase. Parameter "phasename" Type: String Name of the phase/the phase node in the XML node Parameter "propertyname" Type: String Name of the attribute in the phase node Parameter "ComosSpecName" Type: String Name of the target attribute in COMOS Operating Manual, 03/2017 V , A5E AB 29

30 Modifying the standard import 3.6 PRO/II:Class ProIINode public void readstreamconnectionproperties(string connectiontype, string specfrom, string specto) Checks, in the XML node, which equipment from which direction is connected to the process stream and writes the result to the COMOS attributes. Parameter "connectiontype" Type: String Name of the connection type in the XML node Parameter "specfrom" Type: String Name of the target attribute in COMOS if the connection is an incoming connection Parameter "specto" Type: String Name of the target attribute in COMOS if the connection is an outgoing connection public Boolean existsphasetype(string typename) Checks whether a certain phase is available in the XML node. Parameter "typename" Type: String Name of the phase type Public class ComponentNode: StreamNode The ComponentNode class inherits from the StreamNode class. The ComponentNode class is implemented for all simulation objects to be designated as process stream components. public void readpstreamcomposition_property(string phasename, string propertyname, string ComosSpecName) Reads out, from a phase in the XML node, a value for all components that are available there and writes this value to the relevant COMOS attribute. Parameter "phasename" Type: String Name of the phase/the phase node in the XML node Parameter "propertyname" Type: String Name of the attribute in the phase node Parameter "ComosSpecName" Type: String Name of the target attribute in COMOS 3.6 PRO/II:Class ProIINode The first two import steps can be modified using the ProIINode class from the "Pro2Lib601.dll" file. 30 Operating Manual, 03/2017 V , A5E AB

31 Modifying the standard import 3.6 PRO/II:Class ProIINode Background An instance of ProIINode is created for each simulation object during the import operation. This instance is a temporary object that serves as a link between the target object in COMOS and the source object from Invensys PRO/II and is only available during the import operation. Analogous to the Aspen Plus import: The import functions defined in the "Script" tab are called for each simulation object in the first two import steps and the ProIINode instance created for this simulation object is transferred as a parameter. See also chapter Simulation objects (Page 12). The import calls can be extended by means of the functions and variables of the ProIINode instance, thus modifying the standard import function for the first two import steps. In the "Pro2Lib601.dll" file, there is also the ProIIComImport class. This class is initialized in the OnClick() script of the "BUTTON1 Start Import" button of the PRO/II import object. See also chapter Buttons for import objects (Page 11). Next, the following function of the ProIICOMImport instance is called in the script: Function Sub Import(ByVal ObjSimulator As IComosBaseObject): This function starts the import operation. A reference to the Invensys PRO/II import object is transferred as a parameter. Result of the call: The simulation objects are created below ObjSimulator and an instance of ProIINode is created for each simulation object Properties "ComosDevice" ComosDevice As IComosDDevice The target object (simulation object). "Pro2Objects" Pro2Objects As Dictionary The source objects. These are a collection of Invensys PRO/II objects that each represent an interface of an overall object. Thus, multiple Invensys PRO/II objects are converted into one COMOS object. "Pro2File" Pro2File As Object Reference to the Invensys PRO/II file object from which the data is imported. Operating Manual, 03/2017 V , A5E AB 31

32 Modifying the standard import 3.6 PRO/II:Class ProIINode For example, if you need more data for the current object than is read by the standard import function. "Pro2Server" Pro2Server as Object Reference to the Invensys PRO/II file server. This allows queries to the to be imported file. "CompCalcDev" CompCalcDev As IComosDDevice Reference to the CompCalc simulation object, below which the pure components are collected. "isstream As Boolean" Returns TRUE if the object in question has the Invensys PRO/II class "Stream" or is a temporary stream. "MaterialCDev As IComosDCDevice" MaterialCDevice As IComosDCDevice Reference to the base object that is used for all components: "@30 > M21 > A50 > A10 > A20 > A30 > A30 Components - Simulation object". "Pro2Components As Collection" Reference to a collection of devices that is located below the CompCalc simulation object Read() Function Read (ProIIClassName As String, ProIIAttributeName As String, ComosSpecName As String, [index As Integer = -999]) As Boolean Reads a single value from PRO/II and writes it to an attribute of the COMOS object that is managed by the ProIINode instance. Parameters ProIIClassName: Determines from which in Pro2Objects referenced objects the value is read. ProIIAttributeName: Identifies the source attribute from which the value is read. 32 Operating Manual, 03/2017 V , A5E AB

33 Modifying the standard import 3.6 PRO/II:Class ProIINode ComosSpecName: Identifies the target attributes of the object that is referenced in Device. Notation: NameRegisterkarte.NameAttribut Since some values in Invensys PRO/IIII do not have a measurement unit, the measurement unit of the output value can also be transferred in the function call. This is done by appending the string /NameComosMaßeinheit to ComosSpecName, where the name of the COMOS measurement unit is passed exactly as it was defined in the COMOS unit system. Example: Unit group molar volume: Name M62 Unit: Cubic meter/kilomol, Name: M62.25 Parameter ComosSpecName: SPH.CD0199/M62.25 index: Optional. Enables to read a value from an array. Example: Node.Read "SrBulkProp", "SolidCritVolume", "SPH.CD0199/M62.25" ReadArray() Function ReadArray(ProIIClassName As String, ProIIArrSizeAttributeName As String, ProIIAttributeName As String, ComosSpecName As String) As Boolean Reads a one-dimensional data field from Invensys PRO/II and writes it to a list attribute in COMOS. Parameters ProIIClassName: Identifies the object from whose source data field values are read. ProIIArrSizeAttributeName: Specifies the name of the attribute that contains the size of the source data field. Empty string: No size is passed. ProIIAttributeName: Identifies the source data field. ComosSpecName: Analogous to Read(). The attribute must be of type List. The name of the column into which the data field is written must be passed as well. Notation: <NameTab>.<NameAttribute>.<NameColumn> Example: Node.ReadArray "SideColumn", "NumberOfPumparounds", "PumpAroundTrayFrom", "Y00T00174.Y00A01456.Y00A03207" 'Pumparound from tray Operating Manual, 03/2017 V , A5E AB 33

34 Modifying the standard import 3.6 PRO/II:Class ProIINode ReadArrayToFewSpecs() Function ReadArrayToFewSpecs (ProIIClassName As String, ProIIArrSizeAttributeName As String, ProIIAttributeName As String, ComosSpecNames As String) As Boolean Reads a one-dimensional data field from Invensys PRO/II and writes it to multiple attributes of the COMOS object that is managed by the ProIINode instance. Parameters ProIIClassName, ProIIArrSizeAttributeName und ProIIAttributeName: As ReadArray(). ComosSpecNames: Contains the names of the target attributes. They are passed in a string, separated by commas. This function is used if values are stored in one data field in Invensys PRO/II and distributed over two data fields in COMOS. Example: Node.ReadArrayToFewSpecs "HcurveCalc", "NumberOfPoints","CriticalPresLV", "Y00T00166.Y00A01376.Y00A03223, Y00T00166.Y00A01376.Y00A03221/E80.AA250"' Critical Pressure ReadSI() Function ReadSI (ProIIClassName As String, ProIIAttributeName As String, [index As Integer = -999]) As Double Returns the value of an attribute from Invensys PRO/II as a numeric value. The function is called if you need the value within control flow structures, for example. There are differences between Invensys PRO/II and COMOS with regard to the use of SI standardization. If there is a difference, the COMOS SI standardization is used as a basis. This means that the value is converted from the unit specified by the Invensys PRO/II standardization into the unit specified by the COMOS standardization. Parameters See also chapter Read() (Page 32). 34 Operating Manual, 03/2017 V , A5E AB

35 Modifying the standard import 3.6 PRO/II:Class ProIINode GetComosSpecArray() Function GetComosSpecArray(ComosSpecNames As String, ComosSpecCount As Integer) As String() Help method. Parameters ComosSpecNames As String: Comma-separated list of COMOS attributes. ComosSpecCount As Integer: Number of attributes that are passed in ComosSpecNames. Return value: String Array: Each field contains one of the attribute names that were passed in ComosSpecNames Functions that are used internally ProIINode owns additional functions that are only called internally and which have no application in the modification of the import. "ReadMainComp()" Function ReadMainComp (ProIIClassName As String, ProIIAttributeName As String, ComosSpecName As String, [index As Integer = -999]) As Boolean Reads a value from Invensys PRO/II and writes it to a subobject (component) of the CompCalc engineering object. Parameters See also chapter Read() (Page 32). "ReadStreamComp()" Function ReadStreamComp (ProIIClassName As String, ProIIAttributeName As String, ComosSpecName As String, [index As Integer = -999]) As Boolean Writes data to a component link below a material stream. The component link is created, if it does not already exist. The objects created are based on the base object "@30 > M21 > A50 > A10 > A20 > A30 > A30 Components - Simulation object". Operating Manual, 03/2017 V , A5E AB 35

36 Modifying the standard import 3.7 HYSYS: Class HYSYSNode "ReadTempStream()" Function ReadTempStream(StreamID As String) It is possible to create virtual streams in Invensys PRO/II. A call to this function imports a virtual stream to COMOS. First, the stream is created in COMOS below the calling object. Then, the data is imported in the same way as for a normal material stream. "ReadTrayStreams()" Sub ReadTrayStreams() If this function is called at a column, an object with name prefix "Tray" is created below the column for each tray. The objects created are instances of the base object "@30 > M21 > A50 > A10 > A20 > A30 > A20 Column tray - simulation object". 3.7 HYSYS: Class HYSYSNode You can modify the first two import steps using the HYSYSNode class from the "HYSYSImport.dll" file. Background An instance of HYSYSNode is created for each simulation object during the import operation. This instance is a temporary object that serves as a link between COMOS (the target object) and AspenTech HYSYS (the source object) and is only available during the import operation. The import functions defined in the "Script" tab are called for each simulation object in the first two import steps and the HYSYSNode instance created for this simulation object is transferred as a parameter. See also chapter Overview of the topic "Modifying the standard import" (Page 11). The import calls can be extended via the functions and variables of the HYSYSNode instance and the standard import function modified for the first two import steps. In the "HYSYSImport.dll" file, there is also the HYSYSImport class. This class is initialized via the OnClick() script of the "BUTTON1 Start Import" button of the AspenTech HYSYS import object. See also chapter Buttons for import objects (Page 11). Subsequently, the following function of the HYSYSImport instance is called in the script: Sub Import(ByVal objsimcase As IComosBaseObject) This function starts the import operation. A reference to the AspenTech HYSYS import object is transferred as a parameter. Result of the call The simulation objects are created below objsimcase and an instance of HYSYSNode is created for each simulation object. 36 Operating Manual, 03/2017 V , A5E AB

37 Modifying the standard import 3.7 HYSYS: Class HYSYSNode Properties "ComosDevice" ComosDevice As IComosDDevice The target object in COMOS. "Components" Components As Object Link to the components of the active FluidPackage from AspenTech HYSYS. "HYSYSObject" HYSYSObject As Object The source object. "NodeType" NodeType As enodetype Only used internally. Variable to identify the AspenTech HYSYS types. "SpecLog" SpecLog As IComosDSpecification Reference to the "Y00A01405 Log text" attribute at the import object to which the log text is written. The property is used to control the output during the import operation. "XPos" XPos As Double X coordinate of the object in the HYSYS PFD. "YPos" YPos As Double Y coordinate of the object in the HYSYS PFD. "HeatExchangerCurve" During the import of HCurves, the Properties are calculated via PH-Flash. Operating Manual, 03/2017 V , A5E AB 37

38 Modifying the standard import 3.7 HYSYS: Class HYSYSNode "SurfaceTension" The surface tension is imported. This information only exists in HYSYS as a Bulk Property meaning that it is only output for the overall flow but not for the individual phases HYSYSClass() Function HYSYSClass() As String Reads the HYSYS class name from HYSYSObject LiquidPhase1() Function LiquidPhase1() As Object Call at simulation material streams. If HYSYSObject involves a stream, this function returns the LiquidPhase1 object of the HYSYS stream. The phase data can be read from the object LiquidPhase2() Function LiquidPhase2() As Object See also chapter LiquidPhase1() (Page 38) Read() Function Read(strSpecName As String, hyattribute As Variant, [strhysysunit As String], [strparam As String]) Reads a single value from HYSYS and writes it to an attribute of the COMOS object managed by HYSYSNode. strspecname: Target attribute hyattribute: The HYSYS object. strhysysunit: Optional The value that is passed here is set as SI unit. Then the value is converted into the unit that was set for the target attribute. If a number is passed: The value of the HYSYS object is multiplied by this factor. Blank: The default unit for this HYSYS object type is determined and used. strparam: Optional If the target attribute is a list. The index for setting the XValue. 38 Operating Manual, 03/2017 V , A5E AB

39 Modifying the standard import 3.8 UniSim Design: Class UniSimNode ReadPhase Sub ReadPhase(strchapter As String, hyfluidphase As Object) Call at simulation stream objects. Writes phase tabs to streams. hyfluidphase: For example, by calling LiquidPhase1() VaporPhase() Function VapourPhase() As Object See also chapter LiquidPhase1() (Page 38). 3.8 UniSim Design: Class UniSimNode The modification made for the UniSim import corresponds to the modifications made for HYSYS; the only difference is the name. See also HYSYS: Class HYSYSNode (Page 36) Read() Reads an attribute from a Unisim object and writes it to a specific COMOS attribute Public Function Read _ ( _ ByVal strspecname As String, _ ByVal usdattribute As Variant, _ Optional ByVal strunisimunit As String, _ Optional ByVal strparam As String _ ) Parameters strspecname Identifies the target data field. usdattribute Identifies the source data field. Operating Manual, 03/2017 V , A5E AB 39

40 Modifying the standard import 3.9 EbsilonProfessional: Class EbsilonNode usdattribute Identifies the unit at the source data field. strparam The attribute must be the List type. The strparam specifies the index in the list Public Sub ReadPhase() Reads the attributes of individual phases of the material stream simulation objects Public Sub ReadPhase(ByVal strchapter As String, ByVal usdphase As UniSimDesign.FluidPhase) Parameters strchapter Chapter tab in COMOS in which the data is to be displayed. usdphase Name of the phase in the source object (material stream simulation object) Properties of the combined liquid phase To import the properties of the combined liquid phase, use the attribute "Y00T00152.Y00A05703 Import combined liquid phase properties". 3.9 EbsilonProfessional: Class EbsilonNode The first two import steps can be modified using the EbsilonNode class from the "ComosEbsilonImport.dll" file. Background An instance of the EbsilonNode class is created for each simulation object during the import operation. This instance is a temporary object that serves as a link between the target object in COMOS and the source object in EbsilonProfessional and is only available during the import operation. The import functions defined in the "Script" tab are called for each simulation object during the first two import steps. The instance of EbsilonNode that was created for the simulation object is transferred as a parameter. See also chapter Overview of the topic "Modifying the standard import" (Page 11). The import calls can be extended by means of the functions and variables of the EbsilonNode instance, thus modifying the standard import function for the first two import steps. In the "ComosEbsilonImport.dll" file, there is also the EBSILONImport class. This class is initialized via the OnClick() script of the "BUTTON1 Start Import" button of the Ebsilon import 40 Operating Manual, 03/2017 V , A5E AB

41 Modifying the standard import 3.9 EbsilonProfessional: Class EbsilonNode object. See also chapter Buttons for import objects (Page 11). Next, the following function of the EBSILONImport instance is called in the script: Sub Import(ByVal objsimcase As IComosBaseObject)This function starts the import operation. A reference to the Ebsilon import object is transferred as a parameter. Result of the call The simulation objects are created below objsimcase and an instance of EbsilonNode is created for each simulation object Properties "ComosObject" ComosDevice As IComosDDevice The target object in COMOS. "ebsobject" EbsilonObject As ebsopen.object The source object GetEbsKind() Function GetEbsKind () As String Reads the Ebsilon class name from ebsobject Read() Script Function Read (ByVal ebsattribute As String, Optional ByVal strspecname As String, Optional ByVal SpecListIndex As Long = -1, Optional ByVal strparam As String = "") As String Operating Manual, 03/2017 V , A5E AB 41

42 Modifying the standard import 3.10 ChemCad: Class ChemCad Node Reads a single value from EbsilonProfessional and writes it to an attribute of the COMOS object managed by EbsilonNode. Script ebsattribute SpecListIndex strparam strspecname Description Target attribute: If no name is specified, the value is simply returned. Writing does not take place. Optional: If the target attribute is a list attribute. Optional: Only strvalue is processed as a possible transfer value. If this is set, the.stringvalue rather than the Value of the Ebsilon attribute is returned. Optional: Target attribute: If no name is specified, the value is simply returned. Writing does not take place ReadNumeric() Script Function ReadNumeric (ByVal ebsattribute As String, Optional ByVal strspecname As String, Optional ByVal SpecListIndex As Long = -1, Optional ByVal strparam As String = "") As Double Script ebsattribute strspecname SpecListIndex strparam Description Name of the attribute to be read out Optional: Target attribute: If no name is specified, the value is simply returned. Writing does not take place. Optional: If the target attribute is a list attribute. Optional: Not currently used ChemCad: Class ChemCad Node Extension for COMOS 10.2 Additional imported attributes: cp/cv idb:y00t00146.y00a01698 ph value idb:y00t00185.y00a01122 Latent heat idb:y00t00185.y00a Operating Manual, 03/2017 V , A5E AB

43 Modifying the standard import 3.10 ChemCad: Class ChemCad Node The first two import steps can be modified using the ChemCadNode class from the "ComosChemCadImport.dll" file. Background An instance of the ChemCadNode class is created for each simulation object during the import operation. This instance is a temporary object that serves as a link between the target object in COMOS and the source object from ChemCad and is only available during the import operation. The import functions defined in the "Script" tab are called for each simulation object during the first two import steps. The instance of ChemCadNode that was created for this simulation object is transferred as a parameter. See also chapter Overview of the topic "Modifying the standard import" (Page 11). The import calls can be extended by means of the functions and variables of the ChemCadNode instance, thus modifying the standard import function for the first two import steps. In the "ComosChemCadImport.dll" file, there is also the CHEMCADImport class. This class is initialized via the OnClick() script of the "Start import" button of the Chemstation ChemCad import object. See also chapter Buttons for import objects (Page 11). Next, the following function of the CHEMCADImport instance is called in the script: Sub Import(ByVal objsimcase As IComosBaseObject) This function starts the import operation. A reference to the CHEMCADImport object is transferred as a parameter. Result of the call The simulation objects are created below objsimcase and an instance of ChemCadNode is created for each simulation object Properties "ComosDevice" ComosDevice As IComosDDevice The target object in COMOS. "StreamComponents" Components As Object Reference to the components of the active FluidPackage from Chemstations ChemCad. "NodeType" NodeType As enodetype Variable that identifies the ChemCad type and is only used internally. Operating Manual, 03/2017 V , A5E AB 43

44 Modifying the standard import 3.10 ChemCad: Class ChemCad Node "SpecLog" SpecLog As IComosDSpecification Reference to the "ND0122" attribute at the import object, to which the log text is written. This property is used to control the output during the import operation. "UnitOp Type" Enumeration for the type of Unit Operation / Equipment GetChemCadClass() Function GetChemCadClass () As String Returns the CHEMCAD class name of the object ReadNumeric() Script Function ReadNumeric (ByVal ccattribute As String, ByVal strspecname As String, ByVal Unit As String, Optional ByVal SpecListIndex As Long = -1, Optional ByVal StreamID As Integer = -1, Optional ByVal strparam As String = "") As Double Reads a single value from Chemstations ChemCad and writes it to an attribute of the COMOS object managed by ChemCadNode. Script ccattribute strspecname Unit SpecListIndex StreamID strparam Description Source attribute in Chemstations ChemCad Target attribute in COMOS Target unit in unit conversion Optional: Only if the target attribute is a list. The index for setting the XValue. Optional: Required for reading out values for components below a stream. Optional: Not currently used. 44 Operating Manual, 03/2017 V , A5E AB

45 Modifying the standard import 3.11 Default settings for the simultaneous import of multiple files ReadEquilibriumReactionPar() Script Function ReadEquilibriumReactionPar (ByVal ccattribute As String, ByVal strspecname As String, ByVal Unit As String, ByVal ReactionNo As Integer, ByVal CompID As Integer, Optional ByVal SpecListIndex As Long = -1) As Double Special case for equilibrium reactions. See also chapter ReadNumeric() (Page 44) ReadStreamComponents Function ReadStreamComponents() As Long Accesses components at a stream one by one and executes the script for components for each one FillTrayStreamList Function FillTrayStreamList() Reads the input and output streams of a column and writes them, together with their corresponding tray numbers, to the SImObject of the column Default settings for the simultaneous import of multiple files A link to the PFD template to be used for the PFD equipment and PFD process streams (import steps 3 and 4) must be set up in the import options for the "Batch Import Control Center" object. A link to a suitable PFD template is already set by default. You can view this default setting and link a different PFD template, if required. Procedure 1. In the "Base objects" tab in the Navigator, open the node "@10 > A10 > A10 > A10 > A30 > A40 Simulation import objects". 2. Open the properties of the "Batch Import Control Center" object. 3. Go to the "Attributes > Import options" tab. The link to the PFD template is displayed in the "Link to PFD template" field. Operating Manual, 03/2017 V , A5E AB 45

46 Modifying the standard import 3.12 Importing additional attributes 4. If required, click the "..." button and select a different PFD template in the "Link to PFD template" field. 5. Save your entries once you have made the changes Importing additional attributes You can expand the script to specify which additional attributes are imported from a process simulator. Procedure 1. Navigate to the simulation object for which additional attributes are to be imported. Example: "@30 > M21 > A50 > A10 > A30 > A10 > B50 Pumps - Simulation object" 2. Open the "Script" tab in the properties of the object. 3. Open the script for import from a process simulator. 4. Edit one of the following functions in the script as described in the example below: Aspen Plus: See section Read() (Page 19). Pro/II: See section Read() (Page 32). HYSIS: See section Read() (Page 38). Ebsilon Professional: See section Read() (Page 41) or ReadNumeric() (Page 42). ChemCad: See section ReadNumeric() (Page 44). UniSim: See section Read() (Page 39) or Public Sub ReadPhase() (Page 40). ProMax: See section ReadBlock_Property() (Page 25), ReadPStreamComposition_Property() (Page 26), or ReadPStreamPhase_Property() (Page 26). Alternatively: Comment out the following line and create your own read functions: Workset.lib.pe.ChemCadSimulation.Import node, GetClassification(1).lib.pe.ChemCadSimulation.Import node, GetClassification(1) 5. Specify the following in the script: Which attributes from the process simulator are to be assigned to specific COMOS attributes? What is the unit of the attribute to be imported? If it is not specified in an SI unit, indicate the unit group and unit for the conversion. 46 Operating Manual, 03/2017 V , A5E AB

47 Modifying the standard import 3.13 Setting margins for automatic placing of equipment on reports Example This example shows the extension of the import of pumps when importing from ChemCad. Function ChemCadImport(Node) 'PUMP List of attributs for Pump Node.ReadNumeric "Efficiency", Y00T00133.Y00A00497, "" Node.ReadNumeric "Calculated power", Y00T00133.Y00A00417, A20.BA555 Node.ReadNumeric "Calculated Pout", Y00T00133.Y00A01654, E80.BA170 Node.ReadNumeric "Head", Y00T00133.Y00A01193, B75.BA210 Node.ReadNumeric "Vol. flow rate", Y00T00133.Y00A01792, K05.BA200 If Node.ReadNumeric("Request NPSH calc", "", "") > 0 Then Node.ReadNumeric "NPSH available", Y00T00133.Y00A01960, "" End If Explanation Explanation at the example of the following line: Node.ReadNumeric "Calculated power", Y00T00133.Y00A00417, A20.BA555 Arguments "Calculated power" Y00T00133.Y00A A20.BA555 Description Name of the attribute in ChemCad. Nested name of the COMOS attribute that is to be assigned the value from ChemCad. Unit group and unit in the COMOS unit system. If the value is not specified in an SI unit in ChemCad, indicate here which unit was used. You can find additional information on this topic in the "Administration" manual, keyword "Configuring units" Setting margins for automatic placing of equipment on reports To keep space free for a logo or other design elements on PFDs, you can set margins for the automatic placing of equipment on reports for the standard import. This is entirely independent of the type of simulator used. These settings are used when placing equipment automatically. You can find more information on this topic in the "FEED Operation" manual, keyword "Place the equipment on a predefined PFD". Operating Manual, 03/2017 V , A5E AB 47

48 Modifying the standard import 3.14 Excluding certain simulation types from the import Procedure 1. You can set margins for the automatic placing of equipment on reports in the following ways: To make a change to a report in individual cases, select a report "Process flow diagram" in the "Units" tab. To make basic settings for a certain type of report, create a copy of the corresponding base object in the "Base objects" tab and make your changes. You can find additional information on this topic in the "Administration" manual, keyword "Copying objects". 2. Open the properties of the required report. 3. Go to the "Attributes > Document options" tab. 4. Deactivate the "Standard border placement" option. 5. Make your entries for the coordinate system of the report in the "Left and right border" and "Upper and lower border" fields. 6. Save your entries Excluding certain simulation types from the import After activating the "Create dummy objects" option in the "Import options" tab in the properties of the import document, all of the simulation objects present are imported as dummy simulation objects with an import of unknown simulation objects. As the administrator, you can also define simulation types that are not to be imported as exception classes. Procedure 1. In the "Base objects" tab in the Navigator, open the node "@30 > M21 > A50 > A10 > A20 > A10 > A40 Dummy simulation object". 2. Open the properties of the "Dummy simulation object" and go to the "Attributes > Import data" tab. 48 Operating Manual, 03/2017 V , A5E AB

49 Modifying the standard import 3.15 Adapting an HTRI import/export 3. Enter the simulation types that are not to be imported in the field bearing the name of the simulator concerned. To enter more than one simulation type in a field, you must enter the types separated by a comma ",". 4. Confirm your entries Adapting an HTRI import/export The HTRI import is controlled via script by the "ComosHTRIImport.dll" file. For this reason, check the settings in this file. Procedure 1. Click the "Extra > Object debugger" command in the menu bar. 2. Click the "Help" button. 3. In the "Script: components, declarations" window, click in the "Declaration" tab. There is a list at the very top. You can also fill this list from Microsoft Explorer using drag&drop. 4. Select the desired DLL file in Microsoft Explorer; in this case: "<COMOS>\OCX\Import\ComosHTRIImport.dll" or "<COMOS>\Bin\OCX\Import\ComosHTRIImport.dll" Operating Manual, 03/2017 V , A5E AB 49

50 Modifying the standard import 3.15 Adapting an HTRI import/export 5. Drag&drop the "ComosHTRIImport.dll" file into the DLL browser, which is located in the help of the script editor. 6. Click one of the methods or properties. Help text is displayed in the comment area. Additional base objects > A30 > M00 > A20 > HTRI > HTRI HTRI Import" 50 Operating Manual, 03/2017 V , A5E AB

51 Assemblies General notes on assemblies Assemblies are also called templates and consist of COMOS engineering objects. There are various benefits to using assemblies. You can find additional information on this topic in the "Administration" manual, keyword "Administering templates". 4.2 Creating P&ID assemblies Create a template Procedure 1. Open the base project. 2. Navigate to the object "@Template Templates > M21 > A20 Templates for conversion PFD to P&ID" in the "Units" tab. The object includes template folders for the various equipment. 3. Select a matching template folder. Example: "A20 Vessel" 4. Use the "New" context menu command to create a new object below the template folder. 5. Drag&drop a matching base object into the properties of the newly created object in the "Base object" field. Example: "@30 > M21 > A50 > A10 > A20 > A30 > A30 > A10 Vessel, vertical" The base object is assigned to the object. Result You have created a template for a PFD object. The content of the template has not yet been specified. Operating Manual, 03/2017 V , A5E AB 51

52 Assemblies 4.2 Creating P&ID assemblies Creating the structure of the template Procedure 1. Navigate to the following object in the "Base objects" tab of the Navigator: > A10 > A20 > M21 > A70 > A10 Template P&ID assembly" 2. Drag&drop the object below the newly created object. See also section Create a template (Page 51). 3. Use the "New" context menu command to create a new object below the "A10 Template P&ID assembly" object: "Y00R00025 Template P&ID object" 4. Use the "New" context menu command to create a new P&ID below the "A10 Template P&ID assembly" object. Result You have created a structure which looks as follows: Creating P&ID assemblies Create the assembly on the P&ID that is to be used for the PFD object, if PFD in a P&ID assembly, convert PFDs in P&IDs. 52 Operating Manual, 03/2017 V , A5E AB

53 Assemblies 4.2 Creating P&ID assemblies Procedure 1. Open the newly created P&ID under the object "Y00R00024 Template P&ID assembly". 2. Create a P&ID assembly for the selected PFD object. Example: Vessel with nozzles 3. Assign the P&ID objects with the "Assign object" tool to the following object: "Y00R00025 Template P&ID object". You can find more information on this topic in the "P&ID Operation" manual, keyword "Assigning objects". 4. Save the P&ID. 5. Link the PFD and P&ID connectors. See also chapter Assigning connectors (Page 55) Configuring script for connector mapping The following is made possible when you configure the script: The PFD object is linked with all P&ID objects that are part of the assembly. You can navigate between objects. There is a data flow between the PFD object and the P&ID objects. Operating Manual, 03/2017 V , A5E AB 53

54 Assemblies 4.2 Creating P&ID assemblies Procedure 1. Open the "Attributes > Connector mapping" tab in the properties of the "Y00R00024 Template P&ID assembly" object. 2. Click the "Edit" button. The Script editor opens. 3. Enter all P&ID objects listed under the "Y00R00024.Y00R00025 Template P&ID object" object in the script. Function AssignProcessStreams(SpcObj) ''### set PFD object as LinkObject to P&ID object(s) Set PIDobj = SpcObj.GetSpecOwner.Devices.Item("Y00R00025").Devices.Item("<Name of the engineering object>") If Not PIDobj Is Nothing Then Set LinkSpc = PIDobj.spec("Y00T00001.Y00A01446") If Not LinkSpc Is Nothing Then Set LinkSpc.LinkObject = SpcObj.GetSpecOwner.owner End If End If End Function Example If Not PIDobj Is Nothing Then Set LinkSpc = PIDobj.spec("Y00T00001.Y00A01446") If Not LinkSpc Is Nothing Then Set LinkSpc.LinkObject = SpcObj.GetSpecOwner.owner End If End If Set PIDobj = SpcObj.GetSpecOwner.Devices.Item("Y00R00025").Devices.Item("B002") If Not PIDobj Is Nothing Then Set LinkSpc = PIDobj.spec("Y00T00001.Y00A01446") If Not LinkSpc Is Nothing Then Set LinkSpc.LinkObject = SpcObj.GetSpecOwner.owner 54 Operating Manual, 03/2017 V , A5E AB

55 Assemblies 4.2 Creating P&ID assemblies End If End If Assigning connectors Link the PFD and P&ID connectors in order to enable correct conversion of a PFD to a P&ID. Operating Manual, 03/2017 V , A5E AB 55

56 Assemblies 4.2 Creating P&ID assemblies Procedure 1. Open the "Attributes > Connector mapping" tab in the properties of the "Y00R00024 Template P&ID assembly" object. 2. Drag&drop the connectors of the input, output and the dynamic connectors of the assembly (optional) from the Navigator into the fields of the "Connector mapping" tab. Example: 56 Operating Manual, 03/2017 V , A5E AB

57 Assemblies 4.3 Making assemblies available 4.3 Making assemblies available Once you have created assemblies, make them available to users with the help of queries. Procedure 1. Open the "Base objects" tab in the base project. 2. Create a new query under the following object: "@20 > A70 > Y20 > M21 > B10 Queries for template selection" 3. Define a template folder at the unit end below the following object as start node: "@Template > M21 > A20 Templates for converting PFD to P&ID" The query searches and filters the assemblies under the selected template folder. Operating Manual, 03/2017 V , A5E AB 57

58 Assemblies 4.3 Making assemblies available 4. Select a base object under the "@30 > M21 > A50 > A10 > A20 Equipment" object at which you want to make the assemblies available. 5. Create a new base object below it with the name "Y00R00004". 6. Drag&drop the newly created query to the "Base object" field. 7. Repeat these steps for each piece of equipment at which you want to make assemblies available to users. Result Users can access queries at the engineering end in the context menu of a configured equipment with the entry "Select P&ID template". You can find more information on this topic in the "FEED Operation" manual, keyword "Selecting P&ID templates". 58 Operating Manual, 03/2017 V , A5E AB