Represents a simulation file and its contents. More...

Inheritance diagram for CCAPI.Flowsheet:

Public Member Functions
FlashResult	CalculateHPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashEnthalpy, float flashPressure, FlowRateInternalUnits[] flow)
	Calculates a HP flash on user defined component flowrates in internal units. More...

FlashResult	CalculateHPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashEnthalpy, float flashPressure, FlowRateCurUnits[] compFlows)
	Calculates a HP flash on user defined component flowrates in current flowsheet units. More...

FlashResult	CalculateHPFlash (float flashEnthalpy, float flashPressure, StreamInCurUnits stream)
	Calculates a HP flash using single stream in current flowsheet units. More...

FlashResult	CalculateHPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashEnthalpy, float flashPressure, StreamInCurUnits[] streams)
	Calculates a HP flash using multiple streams in current flowsheet units. More...

FlashResult	CalculateHPFlash (float flashEnthalpy, float flashPressure, StreamInInternalUnits stream)
	Calculates a HP flash using single stream in internal units. More...

FlashResult	CalculateHPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashEnthalpy, float flashPressure, StreamInInternalUnits[] streams)
	Calculates a HP flash using multiple streams in internal units. More...

FlashResult	CalculateTPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashTemperature, float flashPressure, FlowRateInternalUnits[] flow)
	Calculates a TP flash using user defined component flowrates in internal units. More...

FlashResult	CalculateTPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashTemperature, float flashPressure, FlowRateCurUnits[] flow)
	Calculates a TP flash using user defined component flowrates in current flowsheet units. More...

FlashResult	CalculateTPFlash (float flashTemperature, float flashPressure, StreamInCurUnits stream)
	Calculates a TP flash using single stream in current flowsheet units. More...

FlashResult	CalculateTPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashTemperature, float flashPressure, StreamInCurUnits[] streams)
	Calculates a TP flash using multiple streams in current flowsheet units. More...

FlashResult	CalculateTPFlash (float flashTemperature, float flashPressure, StreamInInternalUnits stream)
	Calculates a TP flash using single stream in internal units. More...

FlashResult	CalculateTPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashTemperature, float flashPressure, StreamInInternalUnits[] streams)
	Calculates a TP flash using multiple streams in internal units. More...

FlashResult	CalculateVPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashVaporFraction, float flashPressure, FlowRateInternalUnits[] flow)
	Calculates a VP flash using user defined component flowrates in internal units. More...

FlashResult	CalculateVPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashVaporFraction, float flashPressure, FlowRateCurUnits[] flow)
	Calculates a VP flash using user defined component flowrates in current flowsheet units. More...

FlashResult	CalculateVPFlash (float flashVaporFraction, float flashPressure, StreamInCurUnits stream)
	Calculates a VP flash. Takes stream values in current flowsheet untis and return result in current flowsheet units. More...

FlashResult	CalculateVPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashVaporFraction, float flashPressure, StreamInCurUnits[] streams)
	Calculates a VP flash. Takes stream values in current flowsheet untis and return result in current flowsheet units. More...

FlashResult	CalculateVPFlash (float flashVaporFraction, float flashPressure, StreamInInternalUnits stream)
	Calculates a VP flash using single stream in internal units. More...

FlashResult	CalculateVPFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashVaporFraction, float flashPressure, StreamInInternalUnits[] streams)
	Calculates a VP flash using multiple streams in internal units. More...

FlashResult	CalculateVTFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashVaporFraction, float flashTemperature, FlowRateCurUnits[] flow)
	Calculates a VT flash using user defined component flowrates. More...

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

FlashResult	CalculateVTFlash (float flashVaporFraction, float flashTemperature, StreamInCurUnits stream)
	Calculates a VT flash Takes Stream values in current flowsheet units. Takes single stream as a parameter. More...

FlashResult	CalculateVTFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashVaporFraction, float flashTemperature, StreamInCurUnits[] streams)
	Calculates a VT flash using multiple streams in current flowsheet units. More...

FlashResult	CalculateVTFlash (float flashVaporFraction, float flashTemperature, StreamInInternalUnits stream)
	Calculates a VT flash using single stream in internal units. More...

FlashResult	CalculateVTFlash (float streamTemperature, float streamPressure, float streamEnthalpy, float flashVaporFraction, float flashTemperature, StreamInInternalUnits[] streams)
	Calculates a VT flash using multiple streams in internal units. More...

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...

StreamInInternalUnits	GetStreamByIdInInternalUnits (short id)
	Gets stream properties by id. More...

Component	GetComponentById (short id)
	Returns all components used in the current flowsheet. More...

Component	GetComponentByPosition (short position)
	Get compononet by its position in the flowsheet. The first component is at positon 0. More...

short[]	GetIDsOfComponents ()
	Returns the ID of the components present in the flowsheet. More...

float	CalculateLiquidEnthalpy (float temperature, float pressure, FlowRateCurUnits[] flow)
	Calculate liquid enthalpy. The flowrate is defined in current flowsheet units. More...

float	CalculateLiquidEnthalpy (float temperature, float pressure, FlowRateInternalUnits[] flow)
	Calculate liquid enthalpy. The flowrate is defined in internal units. More...

float	CalculateVaporEnthalpy (float temperature, float pressure, FlowRateCurUnits[] flow)
	Calculate vapor enthalpy. The flowrate is defined in current flowsheet units. More...

float	CalculateVaporEnthalpy (float temperature, float pressure, FlowRateInternalUnits[] flow)
	Calculate vapor enthalpy. The flowrate is defined in internal flowsheet units. More...

KValuesResult	CalculateKValues (float temperatureCurInits, float pressureCurUnits, FlowRateCurUnits[] liquidFlow, FlowRateCurUnits[] vaporFlow)
	Calculate K values. The parameter are in current flowsheet units. More...

KValuesResult	CalculateKValues (float temperatureInternalUnits, float pressureInternalUnits, FlowRateInternalUnits[] liquidFlow, FlowRateInternalUnits[] vaporFlow)
	Calculate K values. The parameter are in internal flowsheet units. More...

HeatCurvesResult	HeatCurveEqualCutH (UnitOperations.HeatExchanger heatx, int numberOfPoints)
	Calculate Heat curves of Heat Exchanger. More...

HeatCurvesResult	HeatCurveEqualCutT (UnitOperations.HeatExchanger heatx, int numberOfPoints)
	Calculate Heat curves of Heat Exchanger. More...

void	CopyStreamToId (StreamInCurUnits stream, short id)
	This method is used to copy one stream from one stream to other. More...

void	PutStreamByIdInCurrentUnits (float temp, float pressure, float enthalpy, float molarVaporFraction, FlowRateCurUnits[] CompFlow, short id)
	This method is used to put stream by id in current flowsheet engineering units. More...

void	PutStreamByIdInternalUnits (float temp, float pressure, float enthalpy, float molarVaporFraction, FlowRateCurUnits[] CompFlow, short id)
	This method is used to put stream By id in internal units. More...

void	Close ()
	Closes the flowsheet. More...

void	DefineUserStreamInInternalUnits (float TempR, float presPsia, float moleVapFrac, float enthBtu_Hr, FlowRateInternalUnits[] flowRates)
	User can define stream in internal units. More...

void	DefineUserStreamInFlowsheetUnits (float Temp, float pres, float moleVapFrac, float enthalpy, FlowRateCurUnits[] flowRates)
	User can define stream in flowsheet engineering units. More...

float	GetUserStreamPropertyInInternalUnits (StreamProperty property)
	Get User Defined property in internal units More...

Properties
string	FilePath `[get]`

InternalUnits	UnitsInternal `[get]`
	Returns all internal units used in this flowsheet. More...

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

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

StreamCollectionInternalUnits	StreamsInInternalUnits `[get]`
	Returns all streams in internal units 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...

StreamCollectionInternalUnits	ProductStreamsInInternalUnits `[get]`
	Returns the product streams used in internal units in this flowsheet. More...

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

StreamCollectionInternalUnits	FeedStreamsInInternalUnits `[get]`
	Returns the feed streams used in internal units in this flowsheet. More...

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

StreamCollectionInternalUnits	CutStreamsInInternalUnits `[get]`
	List of cut streams used in internal units in the flowsheet. More...

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

bool	IsDynamic `[get]`
	Determines whether the flowsheet is a dynamic simulation or not. 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...

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

Properties inherited from CCAPI.IFlowsheet
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...

Detailed Description

Represents a simulation file and its contents.

New feature:: Flash methods can be used using both internal engineering units and current flowsheet units.

Member Function Documentation

◆ CalculateHPFlash() [1/6]

FlashResult CCAPI.Flowsheet.CalculateHPFlash	(	float	flashEnthalpy,
		float	flashPressure,
		StreamInCurUnits	stream
	)

Calculates a HP flash using single stream in current flowsheet units.

◆ CalculateHPFlash() [2/6]

FlashResult CCAPI.Flowsheet.CalculateHPFlash	(	float	flashEnthalpy,
		float	flashPressure,
		StreamInInternalUnits	stream
	)

Calculates a HP flash using single stream in internal units.

◆ CalculateHPFlash() [3/6]

FlashResult CCAPI.Flowsheet.CalculateHPFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashEnthalpy,
		float	flashPressure,
		FlowRateCurUnits[]	compFlows
	)

Calculates a HP flash on user defined component flowrates in current flowsheet units.

◆ CalculateHPFlash() [4/6]

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

Calculates a HP flash on user defined component flowrates in internal units.

Implements CCAPI.IFlowsheet.

◆ CalculateHPFlash() [5/6]

FlashResult CCAPI.Flowsheet.CalculateHPFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashEnthalpy,
		float	flashPressure,
		StreamInCurUnits[]	streams
	)

Calculates a HP flash using multiple streams in current flowsheet units.

◆ CalculateHPFlash() [6/6]

FlashResult CCAPI.Flowsheet.CalculateHPFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashEnthalpy,
		float	flashPressure,
		StreamInInternalUnits[]	streams
	)

Calculates a HP flash using multiple streams in internal units.

◆ CalculateKValues() [1/2]

KValuesResult CCAPI.Flowsheet.CalculateKValues	(	float	temperatureCurInits,
		float	pressureCurUnits,
		FlowRateCurUnits[]	liquidFlow,
		FlowRateCurUnits[]	vaporFlow
	)

Calculate K values. The parameter are in current flowsheet units.

Implements CCAPI.IFlowsheet.

◆ CalculateKValues() [2/2]

KValuesResult CCAPI.Flowsheet.CalculateKValues	(	float	temperatureInternalUnits,
		float	pressureInternalUnits,
		FlowRateInternalUnits[]	liquidFlow,
		FlowRateInternalUnits[]	vaporFlow
	)

Calculate K values. The parameter are in internal flowsheet units.

◆ CalculateLiquidEnthalpy() [1/2]

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

Calculate liquid enthalpy. The flowrate is defined in current flowsheet units.

Implements CCAPI.IFlowsheet.

◆ CalculateLiquidEnthalpy() [2/2]

float CCAPI.Flowsheet.CalculateLiquidEnthalpy	(	float	temperature,
		float	pressure,
		FlowRateInternalUnits[]	flow
	)

Calculate liquid enthalpy. The flowrate is defined in internal units.

◆ CalculateTPFlash() [1/6]

FlashResult CCAPI.Flowsheet.CalculateTPFlash	(	float	flashTemperature,
		float	flashPressure,
		StreamInCurUnits	stream
	)

Calculates a TP flash using single stream in current flowsheet units.

◆ CalculateTPFlash() [2/6]

FlashResult CCAPI.Flowsheet.CalculateTPFlash	(	float	flashTemperature,
		float	flashPressure,
		StreamInInternalUnits	stream
	)

Calculates a TP flash using single stream in internal units.

◆ CalculateTPFlash() [3/6]

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

Calculates a TP flash using user defined component flowrates in current flowsheet units.

◆ CalculateTPFlash() [4/6]

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

Calculates a TP flash using user defined component flowrates in internal units.

Implements CCAPI.IFlowsheet.

◆ CalculateTPFlash() [5/6]

FlashResult CCAPI.Flowsheet.CalculateTPFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashTemperature,
		float	flashPressure,
		StreamInCurUnits[]	streams
	)

Calculates a TP flash using multiple streams in current flowsheet units.

◆ CalculateTPFlash() [6/6]

FlashResult CCAPI.Flowsheet.CalculateTPFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashTemperature,
		float	flashPressure,
		StreamInInternalUnits[]	streams
	)

Calculates a TP flash using multiple streams in internal units.

◆ CalculateVaporEnthalpy() [1/2]

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

Calculate vapor enthalpy. The flowrate is defined in current flowsheet units.

Implements CCAPI.IFlowsheet.

◆ CalculateVaporEnthalpy() [2/2]

float CCAPI.Flowsheet.CalculateVaporEnthalpy	(	float	temperature,
		float	pressure,
		FlowRateInternalUnits[]	flow
	)

Calculate vapor enthalpy. The flowrate is defined in internal flowsheet units.

◆ CalculateVPFlash() [1/6]

FlashResult CCAPI.Flowsheet.CalculateVPFlash	(	float	flashVaporFraction,
		float	flashPressure,
		StreamInCurUnits	stream
	)

Calculates a VP flash. Takes stream values in current flowsheet untis and return result in current flowsheet units.

◆ CalculateVPFlash() [2/6]

FlashResult CCAPI.Flowsheet.CalculateVPFlash	(	float	flashVaporFraction,
		float	flashPressure,
		StreamInInternalUnits	stream
	)

Calculates a VP flash using single stream in internal units.

◆ CalculateVPFlash() [3/6]

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

Calculates a VP flash using user defined component flowrates in current flowsheet units.

◆ CalculateVPFlash() [4/6]

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

Calculates a VP flash using user defined component flowrates in internal units.

Implements CCAPI.IFlowsheet.

◆ CalculateVPFlash() [5/6]

FlashResult CCAPI.Flowsheet.CalculateVPFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashVaporFraction,
		float	flashPressure,
		StreamInCurUnits[]	streams
	)

Calculates a VP flash. Takes stream values in current flowsheet untis and return result in current flowsheet units.

◆ CalculateVPFlash() [6/6]

FlashResult CCAPI.Flowsheet.CalculateVPFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashVaporFraction,
		float	flashPressure,
		StreamInInternalUnits[]	streams
	)

Calculates a VP flash using multiple streams in internal units.

◆ CalculateVTFlash() [1/6]

FlashResult CCAPI.Flowsheet.CalculateVTFlash	(	float	flashVaporFraction,
		float	flashTemperature,
		StreamInCurUnits	stream
	)

Calculates a VT flash Takes Stream values in current flowsheet units. Takes single stream as a parameter.

◆ CalculateVTFlash() [2/6]

FlashResult CCAPI.Flowsheet.CalculateVTFlash	(	float	flashVaporFraction,
		float	flashTemperature,
		StreamInInternalUnits	stream
	)

Calculates a VT flash using single stream in internal units.

◆ CalculateVTFlash() [3/6]

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

Calculates a VT flash using user defined component flowrates.

◆ CalculateVTFlash() [4/6]

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

Calculates a VT flash using user defined component flowrates.

Implements CCAPI.IFlowsheet.

◆ CalculateVTFlash() [5/6]

FlashResult CCAPI.Flowsheet.CalculateVTFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashVaporFraction,
		float	flashTemperature,
		StreamInCurUnits[]	streams
	)

Calculates a VT flash using multiple streams in current flowsheet units.

◆ CalculateVTFlash() [6/6]

FlashResult CCAPI.Flowsheet.CalculateVTFlash	(	float	streamTemperature,
		float	streamPressure,
		float	streamEnthalpy,
		float	flashVaporFraction,
		float	flashTemperature,
		StreamInInternalUnits[]	streams
	)

Calculates a VT flash using multiple streams in internal units.

◆ Close()

void CCAPI.Flowsheet.Close ( )

Closes the flowsheet.

◆ CopyStreamToId()

void CCAPI.Flowsheet.CopyStreamToId	(	StreamInCurUnits	stream,
		short	id
	)

This method is used to copy one stream from one stream to other.

◆ DefineUserStreamInFlowsheetUnits()

void CCAPI.Flowsheet.DefineUserStreamInFlowsheetUnits	(	float	Temp,
		float	pres,
		float	moleVapFrac,
		float	enthalpy,
		FlowRateCurUnits[]	flowRates
	)

User can define stream in flowsheet engineering units.

◆ DefineUserStreamInInternalUnits()

void CCAPI.Flowsheet.DefineUserStreamInInternalUnits	(	float	TempR,
		float	presPsia,
		float	moleVapFrac,
		float	enthBtu_Hr,
		FlowRateInternalUnits[]	flowRates
	)

User can define stream in internal units.

◆ GetComponentById()

Component CCAPI.Flowsheet.GetComponentById ( short id )

Returns all components used in the current flowsheet.

Returns: Randomly arranged array containing all components.

Implements CCAPI.IFlowsheet.

◆ GetComponentByPosition()

Component CCAPI.Flowsheet.GetComponentByPosition ( short position )

Get compononet by its position in the flowsheet. The first component is at positon 0.

Returns: Randomly arranged array containing all components.

◆ GetIDsOfComponents()

short [] CCAPI.Flowsheet.GetIDsOfComponents ( )

Returns the ID of the components present in the flowsheet.

◆ GetStreamByIdInCurUnits()

StreamInCurUnits CCAPI.Flowsheet.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

Implements CCAPI.IFlowsheet.

◆ GetStreamByIdInInternalUnits()

StreamInInternalUnits CCAPI.Flowsheet.GetStreamByIdInInternalUnits ( 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

◆ GetUnitOperationById()

UnitOperation CCAPI.Flowsheet.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.

Implements CCAPI.IFlowsheet.

◆ GetUserStreamPropertyInInternalUnits()

float CCAPI.Flowsheet.GetUserStreamPropertyInInternalUnits ( StreamProperty property )

Get User Defined property in internal units

◆ HeatCurveEqualCutH()

HeatCurvesResult CCAPI.Flowsheet.HeatCurveEqualCutH	(	UnitOperations.HeatExchanger	heatx,
		int	numberOfPoints
	)

Calculate Heat curves of Heat Exchanger.

///

New feature:: This method can be used to generate heat curve points using equal cut H method.

◆ HeatCurveEqualCutT()

HeatCurvesResult CCAPI.Flowsheet.HeatCurveEqualCutT	(	UnitOperations.HeatExchanger	heatx,
		int	numberOfPoints
	)

Calculate Heat curves of Heat Exchanger.

New feature:: This method can be used to generate heat curve points using equal cut T method.

◆ PutStreamByIdInCurrentUnits()

void CCAPI.Flowsheet.PutStreamByIdInCurrentUnits	(	float	temp,
		float	pressure,
		float	enthalpy,
		float	molarVaporFraction,
		FlowRateCurUnits[]	CompFlow,
		short	id
	)

This method is used to put stream by id in current flowsheet engineering units.

◆ PutStreamByIdInternalUnits()

void CCAPI.Flowsheet.PutStreamByIdInternalUnits	(	float	temp,
		float	pressure,
		float	enthalpy,
		float	molarVaporFraction,
		FlowRateCurUnits[]	CompFlow,
		short	id
	)

This method is used to put stream By id in internal units.

Property Documentation

◆ Components

ComponentCollection CCAPI.Flowsheet.Components

get

Returns all components used in the current flowsheet.

Returns: Randomly arranged array containing all components.

◆ CutStreamsInCurUnits

StreamCollectionCurUnits CCAPI.Flowsheet.CutStreamsInCurUnits

get

List of cut streams used in the flowsheet.

Returns: Array containing all cut streams.

◆ CutStreamsInInternalUnits

StreamCollectionInternalUnits CCAPI.Flowsheet.CutStreamsInInternalUnits

get

List of cut streams used in internal units in the flowsheet.

Returns: Array containing all cut streams.

◆ DynamicTimeInCurUnits

float CCAPI.Flowsheet.DynamicTimeInCurUnits

get

Returns the Dynamic Time in current engineering units.

◆ DynamicTimeStepInCurUnits

float CCAPI.Flowsheet.DynamicTimeStepInCurUnits

get

Returns the Dynamic Time Step in current engineering units.

◆ FeedStreamsInCurUnits

StreamCollectionCurUnits CCAPI.Flowsheet.FeedStreamsInCurUnits

get

Returns the feed streams used in this flowsheet.

Returns: Randomly arranged array containing all feed streams.

◆ FeedStreamsInInternalUnits

StreamCollectionInternalUnits CCAPI.Flowsheet.FeedStreamsInInternalUnits

get

Returns the feed streams used in internal units in this flowsheet.

Returns: Randomly arranged array containing all feed streams.

◆ IsDynamic

bool CCAPI.Flowsheet.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.Flowsheet.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.Flowsheet.ProductStreamsInCurUnits

get

Returns the product streams used in this flowsheet.

Returns: Randomly arranged array of product streams.

◆ ProductStreamsInInternalUnits

StreamCollectionInternalUnits CCAPI.Flowsheet.ProductStreamsInInternalUnits

get

Returns the product streams used in internal units in this flowsheet.

Returns: Randomly arranged array of product streams.

◆ StreamsInCurUnits

StreamCollectionCurUnits CCAPI.Flowsheet.StreamsInCurUnits

get

Returns all streams used in this flowsheet.

Returns: Afforts an array containing all streams.

◆ StreamsInInternalUnits

StreamCollectionInternalUnits CCAPI.Flowsheet.StreamsInInternalUnits

get

Returns all streams in internal units used in this flowsheet.

Returns: Afforts an array containing all streams.

◆ TimeStepInMinute

float CCAPI.Flowsheet.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.Flowsheet.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.Flowsheet.UnitsCurrent

get

Returns all units used in this flowsheet.

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

◆ UnitsInternal

InternalUnits CCAPI.Flowsheet.UnitsInternal

get

Returns all internal units used in this flowsheet.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CalculateHPFlash() [1/6]

◆ CalculateHPFlash() [2/6]

◆ CalculateHPFlash() [3/6]

◆ CalculateHPFlash() [4/6]

◆ CalculateHPFlash() [5/6]

◆ CalculateHPFlash() [6/6]

◆ CalculateKValues() [1/2]

◆ CalculateKValues() [2/2]

◆ CalculateLiquidEnthalpy() [1/2]

◆ CalculateLiquidEnthalpy() [2/2]

◆ CalculateTPFlash() [1/6]

◆ CalculateTPFlash() [2/6]

◆ CalculateTPFlash() [3/6]

◆ CalculateTPFlash() [4/6]

◆ CalculateTPFlash() [5/6]

◆ CalculateTPFlash() [6/6]

◆ CalculateVaporEnthalpy() [1/2]

◆ CalculateVaporEnthalpy() [2/2]

◆ CalculateVPFlash() [1/6]

◆ CalculateVPFlash() [2/6]

◆ CalculateVPFlash() [3/6]

◆ CalculateVPFlash() [4/6]

◆ CalculateVPFlash() [5/6]

◆ CalculateVPFlash() [6/6]

◆ CalculateVTFlash() [1/6]

◆ CalculateVTFlash() [2/6]

◆ CalculateVTFlash() [3/6]

◆ CalculateVTFlash() [4/6]

◆ CalculateVTFlash() [5/6]

◆ CalculateVTFlash() [6/6]

◆ Close()

◆ CopyStreamToId()

◆ DefineUserStreamInFlowsheetUnits()

◆ DefineUserStreamInInternalUnits()

◆ GetComponentById()

◆ GetComponentByPosition()

◆ GetIDsOfComponents()

◆ GetStreamByIdInCurUnits()

◆ GetStreamByIdInInternalUnits()

◆ GetUnitOperationById()

◆ GetUserStreamPropertyInInternalUnits()

◆ HeatCurveEqualCutH()

◆ HeatCurveEqualCutT()

◆ PutStreamByIdInCurrentUnits()

◆ PutStreamByIdInternalUnits()

Property Documentation

◆ Components

◆ CutStreamsInCurUnits

◆ CutStreamsInInternalUnits

◆ DynamicTimeInCurUnits

◆ DynamicTimeStepInCurUnits

◆ FeedStreamsInCurUnits

◆ FeedStreamsInInternalUnits

◆ IsDynamic

◆ OTSTimeScale

◆ ProductStreamsInCurUnits

◆ ProductStreamsInInternalUnits

◆ StreamsInCurUnits

◆ StreamsInInternalUnits

◆ TimeStepInMinute

◆ UnitOperations

◆ UnitsCurrent

◆ UnitsInternal