PVT Package Hierarchy

The architecture of the PVT package is as follows

@startuml package PVT { package public_interface { abstract LimitedMultiphaseSystem #PaleTurquoise { + {abstract} getLimitedMultiphaseSystemProperties(): LimitedMultiphaseSystemProperties } abstract LimitedMultiphaseSystemProperties #Plum { + {abstract} getPhaseMoleFraction( phaseType ): ScalarPropertyAndDerivatives< double > + {abstract} getMoleComposition( phaseType ): ScalarPropertyAndDerivatives< double > + {abstract} getDensity( phaseType ): ScalarPropertyAndDerivatives< double > + {abstract} getMolecularWeight( phaseType ): ScalarPropertyAndDerivatives< double > } class MultiphaseSystemBuilder { + {static} Build( args... ): LimitedMultiphaseSystem } } /' end of package public_interface '/ class MultiphaseSystem #PaleTurquoise { # Flash * flash + getLimitedMultiphaseSystemProperties(): LimitedMultiphaseSystemProperties } LimitedMultiphaseSystem <|-- MultiphaseSystem class FreeWaterFlashMultiphaseSystemProperties #Plum class NegativeTwoPhaseFlashMultiphaseSystemProperties #Plum class TrivialFlashMultiphaseSystemProperties #Plum class BlackOilFlashMultiphaseSystemProperties #Plum{ + getOilPhaseModel(): BlackOil_OilModel + getGasPhaseModel(): BlackOil_GasModel + getLiquidWaterRichPhaseModel(): BlackOil_WaterModel } class DeadOilFlashMultiphaseSystemProperties #Plum { + getOilPhaseModel(): DeadOil_OilModel + getGasPhaseModel(): DeadOil_GasModel + getLiquidWaterRichPhaseModel(): BlackOil_WaterModel } LimitedMultiphaseSystemProperties <|-- BlackOilFlashMultiphaseSystemProperties LimitedMultiphaseSystemProperties <|-- DeadOilFlashMultiphaseSystemProperties LimitedMultiphaseSystemProperties <|-- NegativeTwoPhaseFlashMultiphaseSystemProperties NegativeTwoPhaseFlashMultiphaseSystemProperties<|-- FreeWaterFlashMultiphaseSystemProperties NegativeTwoPhaseFlashMultiphaseSystemProperties <|-- TrivialFlashMultiphaseSystemProperties Class FlashFactory { + {static} Build( args... ): Flash } abstract class Flash #PaleGreen { + {abstract} getLimitedMultiphaseSystemProperties(): LimitedMultiphaseSystemProperties + {abstract} ComputeEquilibrium(...) } abstract class CompositionalFlash #PaleGreen class FreeWaterFlash #PaleGreen { # FreeWaterFlashMultiphaseSystemProperties * props + getLimitedMultiphaseSystemProperties(): FreeWaterFlashMultiphaseSystemProperties + ComputeEquilibrium(...) } class NegativeTwoPhaseFlash #PaleGreen { # NegativeTwoPhaseFlashMultiphaseSystemProperties * props + getLimitedMultiphaseSystemProperties(): NegativeTwoPhaseFlashMultiphaseSystemProperties + ComputeEquilibrium(...) } class TrivialFlash #PaleGreen { # TrivialFlashMultiphaseSystemProperties * props + getLimitedMultiphaseSystemProperties(): TrivialFlashMultiphaseSystemProperties + ComputeEquilibrium(...) } class BlackOilFlash #PaleGreen { # BlackOilFlashMultiphaseSystemProperties * props + getLimitedMultiphaseSystemProperties(): BlackOilFlashMultiphaseSystemProperties + ComputeEquilibrium(...) } class DeadOilFlash #PaleGreen { # DeadOilFlashMultiphaseSystemProperties * props + getLimitedMultiphaseSystemProperties(): DeadOilFlashMultiphaseSystemProperties + ComputeEquilibrium(...) } Flash <|-up- CompositionalFlash CompositionalFlash <|-up- FreeWaterFlash CompositionalFlash <|-up- NegativeTwoPhaseFlash CompositionalFlash <|-up- TrivialFlash Flash <|-up- BlackOilFlash Flash <|-up- DeadOilFlash FlashFactory <.. MultiphaseSystem Flash <.. MultiphaseSystem Flash <.. FlashFactory FreeWaterFlashMultiphaseSystemProperties <.. FreeWaterFlash NegativeTwoPhaseFlashMultiphaseSystemProperties <.. NegativeTwoPhaseFlash TrivialFlashMultiphaseSystemProperties <.. TrivialFlash BlackOilFlashMultiphaseSystemProperties <.. BlackOilFlash DeadOilFlashMultiphaseSystemProperties <.. DeadOilFlash class BlackOil_PhaseModel #LightSalmon class BlackOil_GasModel #LightSalmon class BlackOil_OilModel #LightSalmon class BlackOil_WaterModel #LightSalmon class DeadOil_PhaseModel #LightSalmon class DeadOil_GasModel #LightSalmon class DeadOil_OilModel #LightSalmon class CubicEoSPhaseModel #LightSalmon BlackOil_PhaseModel <|-up- BlackOil_GasModel BlackOil_PhaseModel <|-up- BlackOil_OilModel DeadOil_PhaseModel <|-up- DeadOil_GasModel DeadOil_PhaseModel <|-up- DeadOil_OilModel BlackOilFlashMultiphaseSystemProperties ..> BlackOil_GasModel BlackOilFlashMultiphaseSystemProperties ..> BlackOil_OilModel BlackOilFlashMultiphaseSystemProperties ..> BlackOil_WaterModel DeadOilFlashMultiphaseSystemProperties ..> DeadOil_GasModel DeadOilFlashMultiphaseSystemProperties ..> DeadOil_OilModel DeadOilFlashMultiphaseSystemProperties ..> BlackOil_WaterModel NegativeTwoPhaseFlashMultiphaseSystemProperties ..> CubicEoSPhaseModel TrivialFlashMultiphaseSystemProperties ..> CubicEoSPhaseModel FreeWaterFlashMultiphaseSystemProperties ..> CubicEoSPhaseModel note right of FlashFactory There are "links" between FlashFactory and its products. Registration of products in a factory is a classic pattern. end note } /' end of package PVT '/ @enduml

Fig. 96 Architecture of the PVT package

The color scheme is:

  • Green is for computational flash classes

  • Purple is for data classes

  • Orange is for fluid models (black oil, free water…)

  • Light blue are for computational system (algorithms and data combined)

@startuml package public { enum PHASE_TYPE { LIQUID_WATER_RICH OIL GAS UNKNOWN } enum EOS_TYPE { REDLICH_KWONG_SOAVE PENG_ROBINSON UNKNOWN } enum COMPOSITIONAL_FLASH_TYPE { TRIVIAL NEGATIVE_OIL_GAS TABULATED_KVALUES FREE_WATER THREE_PHASE UNKNOWN } class ScalarPropertyAndDerivatives< T > { T value T dP T dT std::vector< T > dz } class VectorPropertyAndDerivatives< T > { std::vector< T > value std::vector< T > dP std::vector< T > dT std::vector< std::vector< T > > dz } abstract MultiphaseSystemProperties #PaleTurquoise { + {abstract} getMassDensity( phaseType ): ScalarPropertyAndDerivatives< double > + {abstract} getMoleComposition( phaseType ): VectorPropertyAndDerivatives< double > + {abstract} getMoleDensity( phaseType ): ScalarPropertyAndDerivatives< double > + {abstract} getMolecularWeight( phaseType ): ScalarPropertyAndDerivatives< double > + {abstract} getPhaseMoleFraction( phaseType ): ScalarPropertyAndDerivatives< double > } abstract MultiphaseSystem #Plum { + {abstract} Update( double pressure, double temperature, std::vector< double > feed ) + {abstract} getMultiphaseSystemProperties(): MultiphaseSystemProperties const & + {abstract} hasSucceeded(): bool } class MultiphaseSystemBuilder { buildCompositional( properties... ): std::unique_ptr< System > buildLiveOil( properties... ): std::unique_ptr< System > buildDeadOil( properties... ): std::unique_ptr< System > } } /' end of package public '/ @enduml

Fig. 97 Public interface of the PVT package

Only classes exposed in the public interface of the PVT package is meant to be used outside the PVT package.

  • PHASE_TYPE, EOS_TYPE and COMPOSITIONAL_FLASH_TYPE enums are meant to be used to select the models one wants to use.

  • ScalarPropertyAndDerivatives and VectorPropertyAndDerivatives are utility classes used to return the results. Those classes should eventually be replaced by LvArray.

  • MultiphaseSystemProperties agglomerates the result of the computation.

  • MultiphaseSystem is responsible for performing the computation and serving the results.

  • MultiphaseSystemBuilder builds the system.