Inheritance diagram for CCAPI.IFlowsheet:

Public Member Functions
FlashResult	CalculateHPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashEnthalpy, float flashPressure, FlowRateInternalUnits[] flow)
	Calculates a HP flash. More...

FlashResult	CalculateTPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashTemperature, float flashPressure, FlowRateInternalUnits[] flow)
	Calculates a TP flash. More...

FlashResult	CalculateVPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashVaporFraction, float flashPressure, FlowRateInternalUnits[] flow)
	Calculates a VP flash. More...

FlashResult	CalculateVTFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashVaporFraction, float flashTemperature, FlowRateInternalUnits[] flow)
	Calculates a VT flash. More...

Component	GetComponentById (short Id)

UnitOperation	GetUnitOperationById (short id)
	Gets unit operation by ID. It is recommended to use this method instead of calling unit operations by the array. More...

StreamInCurUnits	GetStreamByIdInCurUnits (short id)
	Gets stream properties by id. More...

float	CalculateLiquidEnthalpy (float temperature, float pressure, FlowRateCurUnits[] flow)
	Calculate liquid enthalpy. More...

float	CalculateVaporEnthalpy (float temperature, float pressure, FlowRateCurUnits[] flow)
	Calculate vapor enthalpy. More...

KValuesResult	CalculateKValues (float temperature, float pressure, FlowRateCurUnits[] liquidFlow, FlowRateCurUnits[] vaporFlow)

Properties
string	FilePath `[get]`

FlowsheetUnits	UnitsCurrent `[get]`
	Returns all units used in this flowsheet. More...

InternalUnits	UnitsInternal `[get]`

StreamCollectionCurUnits	StreamsInCurUnits `[get]`
	Returns all streams used in this flowsheet. More...

UnitOperationCollection	UnitOperations `[get]`
	Returns all unit operations in a flowsheet. The enumeration starts with 0 and is not necessarily the same as in CHEMCAD. It is recommended to use the GetUnitOperationById() method. More...

ComponentCollection	Components `[get]`
	Returns all components used in the current flowsheet. More...

StreamCollectionCurUnits	ProductStreamsInCurUnits `[get]`
	Returns the product streams used in this flowsheet. More...

StreamCollectionCurUnits	FeedStreamsInCurUnits `[get]`
	Returns the feed streams used in this flowsheet. More...

StreamCollectionCurUnits	CutStreamsInCurUnits `[get]`
	List of cut streams used in the flowsheet. More...

bool	IsDynamic `[get]`
	Determines whether the flowsheet is a dynamic simulation or not. More...

float	DynamicTimeInCurUnits `[get]`
	Returns the Dynamic Time in current engineering units. More...

float	DynamicTimeStepInCurUnits `[get]`
	Returns the Dynamic Time Step in current engineering units. More...

float	TimeStepInMinute `[get]`
	Returns the defined time step of a dynamic simulation in minutes. More...

float	OTSTimeScale `[get, set]`
	If a value is written in OTSTimeScale, CHEMCAD attempts to run dynamic simulations at [time scale] * [real time]. More...

Member Function Documentation

◆ CalculateHPFlash()

FlashResult CCAPI.IFlowsheet.CalculateHPFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashEnthalpy,
		float	flashPressure,
		FlowRateInternalUnits[]	flow
	)

Calculates a HP flash.

Implemented in CCAPI.Flowsheet.

◆ CalculateLiquidEnthalpy()

float CCAPI.IFlowsheet.CalculateLiquidEnthalpy	(	float	temperature,
		float	pressure,
		FlowRateCurUnits[]	flow
	)

Calculate liquid enthalpy.

Implemented in CCAPI.Flowsheet.

◆ CalculateTPFlash()

FlashResult CCAPI.IFlowsheet.CalculateTPFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashTemperature,
		float	flashPressure,
		FlowRateInternalUnits[]	flow
	)

Calculates a TP flash.

Implemented in CCAPI.Flowsheet.

◆ CalculateVaporEnthalpy()

float CCAPI.IFlowsheet.CalculateVaporEnthalpy	(	float	temperature,
		float	pressure,
		FlowRateCurUnits[]	flow
	)

Calculate vapor enthalpy.

Implemented in CCAPI.Flowsheet.

◆ CalculateVPFlash()

FlashResult CCAPI.IFlowsheet.CalculateVPFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashVaporFraction,
		float	flashPressure,
		FlowRateInternalUnits[]	flow
	)

Calculates a VP flash.

Implemented in CCAPI.Flowsheet.

◆ CalculateVTFlash()

FlashResult CCAPI.IFlowsheet.CalculateVTFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashVaporFraction,
		float	flashTemperature,
		FlowRateInternalUnits[]	flow
	)

Calculates a VT flash.

Implemented in CCAPI.Flowsheet.

◆ GetStreamByIdInCurUnits()

StreamInCurUnits CCAPI.IFlowsheet.GetStreamByIdInCurUnits ( short id )

Gets stream properties by id.

Parameters

id	Id of the stream. Search in CHEMCAD Flowsheet for the right id or use the Compiler to check.

Returns

Implemented in CCAPI.Flowsheet.

◆ GetUnitOperationById()

UnitOperation CCAPI.IFlowsheet.GetUnitOperationById ( short id )

Gets unit operation by ID. It is recommended to use this method instead of calling unit operations by the array.

Parameters

id	ID of the selceted Unit Operation. Search in CHEMCAD Flowsheet for the right ID or use the compiler to check.

Returns: Unit operation by CHEMCAD ID.

Implemented in CCAPI.Flowsheet.

Property Documentation

◆ Components

ComponentCollection CCAPI.IFlowsheet.Components

get

Returns all components used in the current flowsheet.

Returns: Randomly arranged array containing all components.

◆ CutStreamsInCurUnits

StreamCollectionCurUnits CCAPI.IFlowsheet.CutStreamsInCurUnits

get

List of cut streams used in the flowsheet.

Returns: Array containing all cut streams.

◆ DynamicTimeInCurUnits

float CCAPI.IFlowsheet.DynamicTimeInCurUnits

get

Returns the Dynamic Time in current engineering units.

◆ DynamicTimeStepInCurUnits

float CCAPI.IFlowsheet.DynamicTimeStepInCurUnits

get

Returns the Dynamic Time Step in current engineering units.

◆ FeedStreamsInCurUnits

StreamCollectionCurUnits CCAPI.IFlowsheet.FeedStreamsInCurUnits

get

Returns the feed streams used in this flowsheet.

Returns: Randomly arranged array containing all feed streams.

◆ IsDynamic

bool CCAPI.IFlowsheet.IsDynamic

get

Determines whether the flowsheet is a dynamic simulation or not.

This method is read only, dynamic mode only can be set in CHEMCAD.

◆ OTSTimeScale

float CCAPI.IFlowsheet.OTSTimeScale

getset

If a value is written in OTSTimeScale, CHEMCAD attempts to run dynamic simulations at [time scale] * [real time].

For example, if you enter a value of 5, CHEMCAD attempts to run the model at 5 times real time (5 minutes of calculation for one minute of real time). Using OTS mode is particularly powerful if you have linked the simulation to external data (control system, data historian, online training simulator, etc.). HINT: Allow dynamic editing anytime to make changes when the simulation is not at time zero. If the simulation is paused, you can make a change and then use the method RunStep If an OTS time scale is entered, you can enter dialogs and make changes while calculation proceeds.The flowsheet will use the updated value at the next calculation.

◆ ProductStreamsInCurUnits

StreamCollectionCurUnits CCAPI.IFlowsheet.ProductStreamsInCurUnits

get

Returns the product streams used in this flowsheet.

Returns: Randomly arranged array of product streams.

◆ StreamsInCurUnits

StreamCollectionCurUnits CCAPI.IFlowsheet.StreamsInCurUnits

get

Returns all streams used in this flowsheet.

Returns: Afforts an array containing all streams.

◆ TimeStepInMinute

float CCAPI.IFlowsheet.TimeStepInMinute

get

Returns the defined time step of a dynamic simulation in minutes.

The time step can not be changed via this interface. Changes can only be made in the CHEMCAD flowsheet.

◆ UnitOperations

UnitOperationCollection CCAPI.IFlowsheet.UnitOperations

get

Returns all unit operations in a flowsheet. The enumeration starts with 0 and is not necessarily the same as in CHEMCAD. It is recommended to use the GetUnitOperationById() method.

Returns: Randomly arranged array containing all unit operations.

◆ UnitsCurrent

FlowsheetUnits CCAPI.IFlowsheet.UnitsCurrent

get

Returns all units used in this flowsheet.

Returns: Afforts an array of output units that is defined in CHEMCAD.

The documentation for this interface was generated from the following file:

C:/builds/qw2AyaQN/0/capital-gain/software/net-interface/cc-api/api/IFlowsheet.cs

Public Member Functions

Properties

Member Function Documentation

◆ CalculateHPFlash()

◆ CalculateLiquidEnthalpy()

◆ CalculateTPFlash()

◆ CalculateVaporEnthalpy()

◆ CalculateVPFlash()

◆ CalculateVTFlash()

◆ GetStreamByIdInCurUnits()

◆ GetUnitOperationById()

Property Documentation

◆ Components

◆ CutStreamsInCurUnits

◆ DynamicTimeInCurUnits

◆ DynamicTimeStepInCurUnits

◆ FeedStreamsInCurUnits

◆ IsDynamic

◆ OTSTimeScale

◆ ProductStreamsInCurUnits

◆ StreamsInCurUnits

◆ TimeStepInMinute

◆ UnitOperations

◆ UnitsCurrent