Click or drag to resize

PropertyPackageGetCompoundList Method

Returns the list of all Compounds. This includes the Compound identifiers recognised and extra information that can be used to further identify the Compounds.

Namespace: DWSIM.Thermodynamics.PropertyPackages
Assembly: DWSIM.Thermodynamics (in DWSIM.Thermodynamics.dll) Version: 8.8.1.0
Syntax
public virtual void GetCompoundList(
	ref Object compIds,
	ref Object formulae,
	ref Object names,
	ref Object boilTemps,
	ref Object molwts,
	ref Object casnos
)
Request Example View Source

Parameters

compIds  Object
List of Compound identifiers
formulae  Object
List of Compound formulae
names  Object
List of Compound names.
boilTemps  Object
List of boiling point temperatures.
molwts  Object
List of molecular weights.
casnos  Object
List of Chemical Abstract Service (CAS) Registry numbers.

Implements

ICapeThermoCompounds.GetCompoundList(Object, Object, Object, Object, Object, Object)
Remarks
If any item cannot be returned then the value should be set to UNDEFINED. The same information can also be extracted using the GetCompoundConstant method. The equivalences between GetCompoundList arguments and Compound constant Physical Properties, as specified in section 7.5.2, is given in the table below. When the ICapeThermoCompounds interface is implemented by a Material Object, the list of Compounds returned is fixed when the Material Object is configured. For a Property Package component, the Property Package will normally contain a limited set of Compounds selected for a particular application, rather than all possible Compounds that could be available to a proprietary Properties System. The compIds returned by the GetCompoundList method must be unique within the component that implements the ICapeThermoCompounds interface. There is no restriction on the length of the strings returned in compIds. However, it should be recognised that a PME may restrict the length of Compound identifiers internally. In such a case the PME’s CAPE-OPEN socket must maintain a method of mapping the, potentially long, identifiers used by a CAPE-OPEN Property package component to the identifiers used within the PME. In order to identify the Compounds of a Property Package, the PME, or other client, will use the casnos argument rather than the compIds. This is because different PMEs and different Property Packages may give different names to the same Compounds and the casnos is (almost always) unique. If the casnos is not available (e.g. for petroleum fractions), or not unique, the other pieces of information returned by GetCompoundList can be used to distinguish the Compounds. It should be noted, however, that for communication with a Property Package a client must use the Compound identifiers returned in the compIds argument. It is the responsibility of the client to maintain appropriate data structures that allow it to reconcile the different Compound identifiers used by different Property Packages and any native property system.
See Also