Constants

This page contains the full reference to constants available for ALFAsim-SDK API.

class CompressorSpeedType(value)

An enumeration.

ConstantSpeed = 'constant_speed'

SpeedCurve = 'speed_curve'

class CorrelationPackage(value)

An enumeration.

Glaso = 'pvt_correlation_package_glaso'

Lasater = 'pvt_correlation_package_lasater'

Standing = 'pvt_correlation_package_standing'

VazquezBeggs = 'pvt_correlation_package_vazquez_beggs'

class CorrelationPackageType(value)

An enumeration.

Alfasim = 'correlation_package_alfasim'

Classical = 'correlation_package_classical'

ISDBTests = 'correlation_package_isdb_tests'

class EmulsionModelType(value)

Options for emulsion properties calculation.

Boxall2012 = 'boxall2012'

Brauner2001 = 'brauner2001'

Brinkman1952 = 'brinkman1952'

Brinkman1952AndYeh1964 = 'brinkman1952_and_yeh1964'

Hinze1955 = 'hinze1955'

ModelDefault = 'model_default'

Mooney1951a = 'mooney1951a'

Mooney1951b = 'mooney1951b'

NoModel = 'no_model'

Sleicher1962 = 'sleicher1962'

Taylor1932 = 'taylor1932'

class EnergyModel(value)

Do not rely on the value of this enum, it is used exclusively for backward compatibility

GlobalModel = 'global_model'

LayersModel = 'layers_model'

NoModel = 'no_model'

class EnergyModelPrimaryVariable(value)

Do not rely on the value of this enum, it is used exclusively for backward compatibility

Enthalpy = 'enthalpy'

Temperature = 'temperature'

class EquationOfStateType(value)

An enumeration.

PengRobinson = 'pvt_compositional_peng_robinson'

SoaveRedlichKwong = 'pvt_compositional_soave_redlich_kwong'

class EvaluationStrategyType(value)

An enumeration.

Implicit = 'implicit'

NewtonExplicit = 'newton_explicit'

TimeExplicit = 'time_explicit'

class FlashModel(value)

Do not rely on the value of this enum, it is used exclusively for backward compatibility

HydrocarbonAndWater = 'hydrocarbon_and_water'

HydrocarbonOnly = 'hydrocarbon_only'

class FlowDirection(value)

An enumeration.

Backward = 'backward'

Forward = 'forward'

class HydrodynamicModelType(value)

Informs which base Hydrodynamic model is being used, without any modification from plugins:

TwoFields is valid only for the slug/regime capturing

• TwoFields - ‘Two-fluid, Regime Capturing (gas-oil)’:

  Two phase (gas and oil) with two fields (continuous gas and continuous oil) using Regime Capturing strategy.

• FourFields - ‘Multi-field, Unit Cell (gas-oil)’:

  Two phase (gas and oil) with four fields (continuous gas, continuous oil, dispersed gas bubble, and dispersed oil droplet).

• ThreeLayersGasOilWater - ‘Multi-field, Unit Cell (gas-oil-water), free water’:

  Three phase (gas, oil, and water) with five fields (continuous gas, continuous oil, continuous water, dispersed gas bubble, and dispersed liquid droplet). Water does not disperse in any other phase

• ThreeLayersSevenFieldsGasOilWater - ‘Multi-field, Unit Cell (gas-oil-water), no liquid-liquid dispersion’:

  Three phase (gas, oil, and water) with seven fields (continuous gas, continuous oil, continuous water, gas in oil, gas in water, oil in gas, and water in gas. There is no dispersion of oil in water and water in oil.

• ThreeLayersNineFieldsGasOilWater - ‘Multi-field, Unit Cell (gas-oil-water)’:

  Full three phase gas oil water model. Three continuous fields and six dispersed fields.

FiveFieldsCO2 = 'hydrodynamic_model_5_fields_co2'

FiveFieldsSolid = 'hydrodynamic_model_5_fields_solid'

FiveFieldsWater = 'hydrodynamic_model_5_fields_water'

FourFields = 'hydrodynamic_model_4_fields'

ThreeLayersGasOilWater = 'hydrodynamic_model_3_layers_gas_oil_water'

ThreeLayersNineFieldsGasOilWater = 'hydrodynamic_model_3_layers_9_fields_gas_oil_water'

ThreeLayersNoBubbleGasOilWater = 'hydrodynamic_model_3_layers_no_bubble_gas_oil_water'

ThreeLayersSevenFieldsGasOilWater = 'hydrodynamic_model_3_layers_7_fields_gas_oil_water'

ThreeLayersWaterWithCO2 = 'hydrodynamic_model_3_layers_water_with_co2'

TwoFields = 'hydrodynamic_model_2_fields'

class InitialConditionStrategyType(value)

An enumeration.

Constant = 'constant'

Restart = 'restart'

SteadyState = 'steady_state'

class InterpolationType(value)

An enumeration.

Constant = 'constant'

Linear = 'linear'

Quadratic = 'quadratic'

class MassInflowSplitType(value)

PvtUserGorWc is currently only used for GenKey

ConstantMassFraction = 'mass_inflow_split_type_constant_mass_fraction'

ConstantVolumeFraction = 'mass_inflow_split_type_constant_volume_fraction'

Pvt = 'mass_inflow_split_type_pvt'

PvtUserGlrWc = 'mass_inflow_split_type_pvt_user_glr_wc'

PvtUserGorWc = 'mass_inflow_split_type_pvt_user_gor_wc'

class MassSourceType(value)

An enumeration.

AllVolumetricFlowRates = 'mass_source_type_all_volumetric_flow_rates'

FlowRateGasGorWc = 'mass_source_type_flow_rate_gas_gor_wc'

FlowRateOilGorWc = 'mass_source_type_flow_rate_oil_gor_wc'

FlowRateWaterGorWc = 'mass_source_type_flow_rate_water_gor_wc'

MassFlowRates = 'mass_source_type_mass_flow_rates'

TotalMassFlowRatePvtSplit = 'mass_source_type_total_mass_flow_rate_pvt_split'

class MaterialType(value)

An enumeration.

Fluid = 'fluid'

Solid = 'solid'

class NodeCellType(value)

An enumeration.

Internal = 'internal_node'

MassSource = 'mass_source_boundary'

Pressure = 'pressure_boundary'

Separator = 'separator_node'

class NonlinearSolverType(value)

An enumeration.

AlfasimQuasiNewton = 'nonlinear_solver_alfasim_quasi_newton'

NewtonBacktracking = 'nonlinear_solver_newton_backtracking'

NewtonBasic = 'nonlinear_solver_newton_basic'

class OutputAttachmentLocation(value)

Output Attachment Location will tell the location in which this attachment’s data should be retrieved from.

Annulus = 'annulus'

Main = 'main'

class PVTCompositionalViscosityModel(value)

An enumeration.

CorrespondingStatesPrinciple = 'corresponding_states_principle'

LohrenzBrayClark = 'lohrenz_bray_clark'

class PipeEnvironmentHeatTransferCoefficientModelType(value)

An enumeration.

Overall = 'overall_heat_transfer_coefficient_model'

WallsAndAir = 'walls_and_air_heat_transfer_coefficient_model'

WallsAndEnvironment = 'walls_and_environment_heat_transfer_coefficient'

WallsAndWater = 'walls_and_water_heat_transfer_coefficient_model'

class PipeThermalModelType(value)

An enumeration.

AdiabaticWalls = 'adiabatic_walls'

SteadyState = 'steady_state_heat_transfer'

Transient = 'transient_heat_transfer'

class PipeThermalPositionInput(value)

An enumeration.

Md = 'position_by_md'

Tvd = 'position_by_tvd'

class PumpType(value)

An enumeration.

ConstantPressure = 'constant_pressure'

TableInterpolation = 'table_interpolation'

class SeparatorGeometryType(value)

An enumeration.

HorizontalCylinder = 'horizontal_cylinder'

Sphere = 'sphere'

VerticalCylinder = 'vertical_cylinder'

class SimulationModeType(value)

An enumeration.

Default = 'default'

Robust = 'robust'

class SimulationRegimeType(value)

An enumeration.

SteadyState = 'simulation_regime_steady_state'

Transient = 'simulation_regime_transient'

class SolidsModelType(value)

Informs which solid model should be used:

• NoModel - None:RR

  Without slip velocity and slurry viscosity

• Mills1985Equilibrium - Mills (1985):

  Employs the equilibrium slip velocity model and the Mills (1985) effective dynamic viscosity expression.

• Santamaria2010Equilibrium - Santamaría-Holek (2010):

  This model is more appropriate to use when the solid phase has properties similar to or equal to hydrate. It was fitted by Qin et al. (2018) for hydrates.

• Thomas1965Equilibrium - Thomas (1965):

  Employs the equilibrium slip velocity model and the Thomas (1965) effective dynamic viscosity expression.

Mills1985Equilibrium = 'mills1985_equilibrium'

NoModel = 'no_model'

Santamaria2010Equilibrium = 'santamaria2010_equilibrium'

Thomas1965Equilibrium = 'thomas1965_equilibrium'

class SurfaceTensionType(value)

An enumeration.

Leechien = 'LeeChien'

Schechterguo = 'SchechterGuo'

Weinaugkatz = 'WeinaugKatz'

class TableInputType(value)

Indicates the semantics of a position field

vertical_position: Interpolation will be calculated in relation to the y-axis horizontal_position: Interpolation will be calculated in relation to the x-axis length: Interpolation will be calculated in relation to the pipeline trajectory

horizontal_position = 'horizontal_position'

length = 'length'

vertical_position = 'vertical_position'

class TracerModelType(value)

An enumeration.

Compositional = 'tracer_model_compositional'

Global = 'tracer_model_global'

class ValveOpeningType(value)

An enumeration.

ConstantOpening = 'constant_opening'

TableInterpolation = 'table_interpolation'

class ValveType(value)

An enumeration.

CheckValve = 'check_valve'

ChokeValveWithFlowCoefficient = 'choke_valve_with_flow_coefficient'

PerkinsValve = 'perkins_valve'

class WellConnectionPort(value)

Available ports for connecting to a Well node.

LeftAnnulus = 'left_annulus_port'

RightAnnulus = 'right_annulus_port'

Top = 'port'

class WellIndexPhaseType(value)

An enumeration.

Gas = 'well_index_phase_gas'

Liquid = 'well_index_phase_liquid'

Oil = 'well_index_phase_oil'

Water = 'well_index_phase_water'

EXTRAS_REQUIRED_VERSION_KEY = 'required-alfasim-sdk'

The dict key which identifies the required version of alfasim-sdk for a given plugin

GAS_LAYER = 'gas'

Constant to identify the gas layer

GAS_PHASE = 'gas'

Constant to identify the gas phase

OIL_LAYER = 'oil'

Constant to identify the oil layer

OIL_PHASE = 'oil'

Constant to identify the oil phase

WATER_LAYER = 'water'

Constant to identify the water layer

WATER_PHASE = 'water'

Constant to identify the water phase

Full API Reference