Represents a unit operation in a flowsheet. More...

Inheritance diagram for CCAPI.UnitOperation:

Public Member Functions
	UnitOperation (UnitOperation o)

ColumnHydraulicsResult	GetColumnHydraulicsFromSizing (ColumnType columnType)
	Get hydraulics of a column unit op. The values are in current flowsheet units. More...

ColumnHydraulicsResult	GetColumnHydraulicsFromSizingInternalUnits (ColumnType columnType)
	Get hydraulics of a column unit op. The values are in internal units. More...

void	GetEquilibriumReactionParameter (float parVal, short rxnNo, EquilibriumRxnParamter parID, short compIdx)
	Get equilibrium reaction parameter. More...

void	PutEquilibriumReactionParameter (float parVal, EquilibriumRxnParamter parID, short rxnNo, short compIdx)
	Set an equilibrium reaction parameter of the unit op. More...

float	GetKineticReactionParameter (short rxnNo, KineticRxnParameter parID, short compIdx)
	Get kinetic reaction parameter of the unit op. More...

void	PutKineticReactionPar (float parVal, KineticRxnParameter parID, short rxnNo, short compIdx)
	Set kinetic reaction parameter of the unit op. More...

void	SetFoulingFactors (double tFouling, double sFouling)
	Set fouling factors of the unit op. More...

void	SetColumnPressureProfile (float[] pressureCurrentUnits)
	Set the column pressure of a profile in current flowsheet Units. More...

void	SetParameterInCurUnits (short parameterId, float parVal)
	Set parameter of unit op in current flowsheet units. More...

void	SetParameterInInternalUnits (short parameterId, float parVal)
	Set parameter of unit op in internal units. More...

float	GetParameterInCurUnits (short parameterId)
	Get parameter of unit op in current flowsheet units. More...

float	GetParameterInInernalUnits (short parameterId)
	Get parameter of unit op in internal units. More...

float	GetTrayProperty (ColumnType columnType, int trayNumber, StreamProperty property)
	Get tray property of the defined tray in the distillation column. More...

Properties
short	Id `[get]`
	Id of the unit operation. More...

string	Name `[get]`
	Name of the unit operation. More...

string	CategoryName `[get]`
	Type of the unit op. More...

int	CategoryId `[get]`
	Type of the unit op. More...

StreamCollectionCurUnits	InletStreams `[get]`
	Returns all inlet streams of this unit op. More...

StreamCollectionCurUnits	OutletStreams `[get]`
	Returns all outlet streams of this unit op. More...

string	RuntimeErrorString `[get]`
	Runtime error string. More...

int	RuntimeErrorCode `[get]`
	Runtime error code. More...

int	NumberOfStages `[get]`
	Number of stages of this unit operation. More...

Detailed Description

Represents a unit operation in a flowsheet.

Member Function Documentation

◆ GetColumnHydraulicsFromSizing()

ColumnHydraulicsResult CCAPI.UnitOperation.GetColumnHydraulicsFromSizing ( ColumnType columnType )

Get hydraulics of a column unit op. The values are in current flowsheet units.

Parameters

columnType

◆ GetColumnHydraulicsFromSizingInternalUnits()

ColumnHydraulicsResult CCAPI.UnitOperation.GetColumnHydraulicsFromSizingInternalUnits ( ColumnType columnType )

Get hydraulics of a column unit op. The values are in internal units.

Parameters

columnType

◆ GetEquilibriumReactionParameter()

void CCAPI.UnitOperation.GetEquilibriumReactionParameter	(	float	parVal,
		short	rxnNo,
		EquilibriumRxnParamter	parID,
		short	compIdx
	)

Get equilibrium reaction parameter.

◆ GetKineticReactionParameter()

float CCAPI.UnitOperation.GetKineticReactionParameter	(	short	rxnNo,
		KineticRxnParameter	parID,
		short	compIdx
	)

Get kinetic reaction parameter of the unit op.

◆ GetParameterInCurUnits()

float CCAPI.UnitOperation.GetParameterInCurUnits ( short parameterId )

Get parameter of unit op in current flowsheet units.

Parameters

parameterId

Returns

◆ GetParameterInInernalUnits()

float CCAPI.UnitOperation.GetParameterInInernalUnits ( short parameterId )

Get parameter of unit op in internal units.

Parameters

parameterId

Returns

◆ GetTrayProperty()

float CCAPI.UnitOperation.GetTrayProperty	(	ColumnType	columnType,
		int	trayNumber,
		StreamProperty	property
	)

Get tray property of the defined tray in the distillation column.

Returns

◆ PutEquilibriumReactionParameter()

void CCAPI.UnitOperation.PutEquilibriumReactionParameter	(	float	parVal,
		EquilibriumRxnParamter	parID,
		short	rxnNo,
		short	compIdx
	)

Set an equilibrium reaction parameter of the unit op.

◆ PutKineticReactionPar()

void CCAPI.UnitOperation.PutKineticReactionPar	(	float	parVal,
		KineticRxnParameter	parID,
		short	rxnNo,
		short	compIdx
	)

Set kinetic reaction parameter of the unit op.

◆ SetColumnPressureProfile()

void CCAPI.UnitOperation.SetColumnPressureProfile ( float[] pressureCurrentUnits )

Set the column pressure of a profile in current flowsheet Units.

◆ SetFoulingFactors()

void CCAPI.UnitOperation.SetFoulingFactors	(	double	tFouling,
		double	sFouling
	)

Set fouling factors of the unit op.

◆ SetParameterInCurUnits()

void CCAPI.UnitOperation.SetParameterInCurUnits	(	short	parameterId,
		float	parVal
	)

Set parameter of unit op in current flowsheet units.

◆ SetParameterInInternalUnits()

void CCAPI.UnitOperation.SetParameterInInternalUnits	(	short	parameterId,
		float	parVal
	)

Set parameter of unit op in internal units.

Property Documentation

◆ CategoryId

int CCAPI.UnitOperation.CategoryId

get

Type of the unit op.

◆ CategoryName

string CCAPI.UnitOperation.CategoryName

get

Type of the unit op.

◆ Id

short CCAPI.UnitOperation.Id

get

Id of the unit operation.

◆ InletStreams

StreamCollectionCurUnits CCAPI.UnitOperation.InletStreams

get

Returns all inlet streams of this unit op.

Returns

◆ Name

string CCAPI.UnitOperation.Name

get

Name of the unit operation.

◆ NumberOfStages

int CCAPI.UnitOperation.NumberOfStages

get

Number of stages of this unit operation.

◆ OutletStreams

StreamCollectionCurUnits CCAPI.UnitOperation.OutletStreams

get

Returns all outlet streams of this unit op.

Returns

◆ RuntimeErrorCode

int CCAPI.UnitOperation.RuntimeErrorCode

get

Runtime error code.

◆ RuntimeErrorString

string CCAPI.UnitOperation.RuntimeErrorString

get

Runtime error string.

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ GetColumnHydraulicsFromSizing()

◆ GetColumnHydraulicsFromSizingInternalUnits()

◆ GetEquilibriumReactionParameter()

◆ GetKineticReactionParameter()

◆ GetParameterInCurUnits()

◆ GetParameterInInernalUnits()

◆ GetTrayProperty()

◆ PutEquilibriumReactionParameter()

◆ PutKineticReactionPar()

◆ SetColumnPressureProfile()

◆ SetFoulingFactors()

◆ SetParameterInCurUnits()

◆ SetParameterInInternalUnits()

Property Documentation

◆ CategoryId

◆ CategoryName

◆ Id

◆ InletStreams

◆ Name

◆ NumberOfStages

◆ OutletStreams

◆ RuntimeErrorCode

◆ RuntimeErrorString