© 2024 Jasper van Baten, AmsterCHEM

getParameter

getParameter is used to obtain the value for a defined parameter. It is most useful for input parameters, but it can also be used to obtain the current value of an output parameter.

Syntax

value=getParameter(parameterName)

Arguments

parameterName
String; name of the parameter for which to get the value of. The parameter must be defined for this unit operation.

Returns

value
Value of the parameter. The data type of the value corresponds to the type of the parameter.

Examples

-->value=getParameter("split factor")
value  =
 
    0.5

-->value=getParameter("operation type")
value = 

 Adiabatic

INDEX
Acknowledgements
Additional files
Boolean parameters
Calculation
compNames
Dimensionality
Disclaimer
DOs and DONTs
Error trapping
Examples
Feeds
Files
Formulas
Function reference
getAggregationState
getAggregationStateName
getCompoundConstant
getEquilibrium
getEquilibriumProperty
getFeedEquilibrium
getFeedProp
getNumberOfFeeds
getNumberOfProducts
getParameter
getPDependentProperty
getPropertyUnitOfMeasure
getSinglePhaseProperty
getTDependentProperty
getTwoPhaseProperty
getUnitOperationName
Global variables
Integer parameters
License
Loading models
logMessage
Model files
nComp
nPhase
Parameters
phaseAggregationStates
phaseNames
Products
Real parameters
Reports
Requirements
Saving models
SCI files
setParameter
setProduct
setReport
String parameters
SUM files
Welcome
CONTENT
 Welcome
 Feed and product ports
 Parameters
 Reports
 SciLab Calculation Script
 Additional files
 Global variables
 Function reference
 getAggregationState
 getAggregationStateName
 getCompoundConstant
 getEquilibrium
 getEquilibriumProperty
 getFeedEquilibrium
 getFeedProp
 getNumberOfFeeds
 getNumberOfProducts
 getParameter
 getPDependentProperty
 getPropertyUnitOfMeasure
 getSinglePhaseProperty
 getTDependentProperty
 getTwoPhaseProperty
 getUnitOperationName
 logMessage
 setParameter
 setProduct
 setReport
 Saving and loading models
 License and disclaimer