Interface ValveInterface

All Superinterfaces:

NamedInterface, ProcessEquipmentInterface, Runnable, Serializable, SimulationInterface, TwoPortInterface

All Known Implementing Classes:

BlowdownValve, CheckValve, ControlValve, ESDValve, HIPPSValve, LevelControlValve, PressureControlValve, PressureDrop, PSDValve, RuptureDisk, SafetyReliefValve, SafetyValve, ThrottlingValve

public interface ValveInterface
extends ProcessEquipmentInterface, TwoPortInterface

ValveInterface interface.

Version:

$Id: $Id

Author:

esol

Method Summary

Modifier and Type	Method	Description
double	getCg()	getCg.
double	getClosingTravelTime()	Returns the configured closing travel time (seconds).
double	getCv()	getCv.
double	getCv(String unit)	getCv.
double	getKv()	Gets the Kv (metric flow coefficient) of the valve.
double	getOpeningTravelTime()	Returns the configured opening travel time (seconds).
double	getPercentValveOpening()	getPercentValveOpening.
double	getTargetPercentValveOpening()	Returns the requested (target) valve opening before dynamic travel limitations are applied.
SystemInterface	getThermoSystem()	getThermoSystem.
ValveTravelModel	getTravelModel()	Returns the current valve travel model.
double	getTravelTime()	Returns the configured full travel time (seconds) for the valve.
double	getTravelTimeConstant()	Returns the configured time constant (seconds) for first-order travel dynamics.
boolean	isIsoThermal()	isIsoThermal.
void	setClosingTravelTime(double travelTimeSec)	Sets the travel time for closing actions (seconds).
void	setCv(double Cv)	setCv.
void	setCv(double Cv, String unit)	setCv.
void	setIsoThermal(boolean isoThermal)	setIsoThermal.
void	setKv(double Kv)	Sets the Kv (metric flow coefficient) of the valve.
void	setOpeningTravelTime(double travelTimeSec)	Sets the travel time for opening actions (seconds).
void	setPercentValveOpening(double percentValveOpening)	setPercentValveOpening.
void	setTargetPercentValveOpening(double percentValveOpening)	Sets the requested (target) valve opening in percent.
void	setTravelModel(ValveTravelModel travelModel)	Sets the valve travel model used to translate requested opening to actual position.
void	setTravelTime(double travelTimeSec)	Sets the total travel time (seconds) corresponding to a movement from fully closed to fully open.
void	setTravelTimeConstant(double timeConstantSec)	Sets the time constant (seconds) for first-order travel dynamics.

Methods inherited from interface NamedInterface

getName, getTagName, setName, setTagName

Methods inherited from interface ProcessEquipmentInterface

displayResult, equals, getCapacityDuty, getCapacityMax, getConditionAnalysisMessage, getController, getEntropyProduction, getExergyChange, getExergyChange, getFluid, getMassBalance, getMassBalance, getMechanicalDesign, getPressure, getPressure, getReport_json, getRestCapacity, getResultTable, getSpecification, getTemperature, getTemperature, hashCode, initMechanicalDesign, needRecalculation, reportResults, runConditionAnalysis, setController, setPressure, setRegulatorOutSignal, setSpecification, setTemperature, toJson, toJson, validateSetup

Methods inherited from interface SimulationInterface

getCalculateSteadyState, getCalculationIdentifier, getTime, increaseTime, isRunInSteps, run, run, run_step, run_step, runTransient, runTransient, setCalculateSteadyState, setCalculationIdentifier, setRunInSteps, setTime, solved

Methods inherited from interface TwoPortInterface

getInletPressure, getInletStream, getInletTemperature, getInStream, getOutletPressure, getOutletStream, getOutletTemperature, getOutStream, setInletPressure, setInletStream, setInletTemperature, setOutletPressure, setOutletStream, setOutletTemperature

Method Details

isIsoThermal

boolean isIsoThermal()

isIsoThermal.

Returns:

a boolean

setIsoThermal

void setIsoThermal(boolean isoThermal)

setIsoThermal.

Parameters:

isoThermal - a boolean

getPercentValveOpening

double getPercentValveOpening()

getPercentValveOpening.

Returns:

a double

setPercentValveOpening

void setPercentValveOpening(double percentValveOpening)

setPercentValveOpening.

Parameters:

percentValveOpening - a double

getTargetPercentValveOpening

double getTargetPercentValveOpening()

Returns the requested (target) valve opening before dynamic travel limitations are applied.

Returns:

requested valve opening in percent

setTargetPercentValveOpening

void setTargetPercentValveOpening(double percentValveOpening)

Sets the requested (target) valve opening in percent. The actual valve opening may lag the request depending on the selected travel model.

Parameters:

percentValveOpening - target valve opening in percent

getCv

double getCv()

getCv.

Returns:

a double

getCg

double getCg()

getCg.

Returns:

a double

getCv

double getCv(String unit)

getCv.

Parameters:

unit - can be SI or US SI is unit litre/minute US is gallons per minute

Returns:

a double

setCv

void setCv(double Cv)

setCv.

Parameters:

Cv - a double

setCv

void setCv(double Cv,
 String unit)

setCv.

Parameters:

Cv - a double

unit - can be SI or US SI is unit litre/minute US is gallons per minute

getThermoSystem

SystemInterface getThermoSystem()

getThermoSystem.

Specified by:

getThermoSystem in interface ProcessEquipmentInterface

Returns:

a SystemInterface object

setKv

void setKv(double Kv)

Sets the Kv (metric flow coefficient) of the valve.

Parameters:

Kv - the metric flow coefficient

getKv

double getKv()

Gets the Kv (metric flow coefficient) of the valve.

Returns:

the metric flow coefficient

setTravelTime

void setTravelTime(double travelTimeSec)

Sets the total travel time (seconds) corresponding to a movement from fully closed to fully open.

Parameters:

travelTimeSec - full travel time in seconds

getTravelTime

double getTravelTime()

Returns the configured full travel time (seconds) for the valve.

Returns:

full travel time in seconds

setOpeningTravelTime

void setOpeningTravelTime(double travelTimeSec)

Sets the travel time for opening actions (seconds). When not specified, the symmetric travel time is used.

Parameters:

travelTimeSec - opening travel time in seconds

getOpeningTravelTime

double getOpeningTravelTime()

Returns the configured opening travel time (seconds).

Returns:

opening travel time in seconds

setClosingTravelTime

void setClosingTravelTime(double travelTimeSec)

Sets the travel time for closing actions (seconds). When not specified, the symmetric travel time is used.

Parameters:

travelTimeSec - closing travel time in seconds

getClosingTravelTime

double getClosingTravelTime()

Returns the configured closing travel time (seconds).

Returns:

closing travel time in seconds

setTravelTimeConstant

void setTravelTimeConstant(double timeConstantSec)

Sets the time constant (seconds) for first-order travel dynamics.

Parameters:

timeConstantSec - time constant in seconds

getTravelTimeConstant

double getTravelTimeConstant()

Returns the configured time constant (seconds) for first-order travel dynamics.

Returns:

time constant in seconds

setTravelModel

void setTravelModel(ValveTravelModel travelModel)

Sets the valve travel model used to translate requested opening to actual position.

Parameters:

travelModel - travel model implementation

getTravelModel

ValveTravelModel getTravelModel()

Returns the current valve travel model.

Returns:

travel model