Full API Reference

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

• C/C++ API
  • Enums
    • error_code
      • error_code::REFERENCE_NOT_SET
      • error_code::UNKNOWN_REFERENCE_TYPE
      • error_code::OUT_OF_BOUNDS
      • error_code::UNKNOWN_CONTEXT
      • error_code::NOT_AVAILABLE_DATA
      • error_code::BUFFER_SIZE_INSUFFICIENT
      • error_code::UNDEFINED_DATA
      • error_code::NOT_IMPLEMENTED
      • error_code::OK
    • GridScope
      • GridScope::CENTER
      • GridScope::FACE
    • MultiFieldDescriptionScope
      • MultiFieldDescriptionScope::MIXTURE
      • MultiFieldDescriptionScope::GLOBAL
      • MultiFieldDescriptionScope::FIELD
      • MultiFieldDescriptionScope::LAYER
      • MultiFieldDescriptionScope::PHASE
    • TwoPhaseSystem
      • TwoPhaseSystem::GAS
      • TwoPhaseSystem::LIQUID
    • LiquidLiquidSystem
      • LiquidLiquidSystem::OIL
      • LiquidLiquidSystem::WATER
    • TimestepScope
      • TimestepScope::CURRENT
      • TimestepScope::PREVIOUS
    • StateVariable
      • StateVariable::RHO
      • StateVariable::MU
      • StateVariable::CP
      • StateVariable::DRHO_DP
      • StateVariable::DRHO_DT
      • StateVariable::H
      • StateVariable::K
      • StateVariable::SIGMA
      • StateVariable::RS
      • StateVariable::RSW
    • sdk_load_error_code
      • sdk_load_error_code::SDK_DLL_PATH_TOO_LONG
      • sdk_load_error_code::SDK_ALREADY_OPEN_ERROR
      • sdk_load_error_code::SDK_OK
  • Structs
    • VariableScope
      • VariableScope::grid_scope
      • VariableScope::mfd_scope
      • VariableScope::ts_scope
  • Functions
    • ALFAsim-SDK API Loading
      • alfasim_sdk_open()
      • alfasim_sdk_close()
    • Plugin Input Data (From user interface)
      • get_plugin_input_data_boolean()
      • get_plugin_input_data_enum()
      • get_plugin_input_data_quantity()
      • get_plugin_input_data_string()
      • get_plugin_input_data_string_size()
      • get_plugin_input_data_file_content()
      • get_plugin_input_data_file_content_size()
      • get_plugin_input_data_table_quantity()
      • get_plugin_input_data_reference()
      • get_plugin_input_data_multiplereference_selected_size()
    • Plugin Internal Data
      • set_plugin_data()
      • get_plugin_data()
      • get_number_of_threads()
      • get_thread_id()
    • ALFAsim’s Solver Data
      • get_plugin_variable()
      • get_field_id()
      • get_phase_id()
      • get_layer_id()
      • get_number_of_fields()
      • get_number_of_phases()
      • get_number_of_layers()
      • get_number_of_phase_pairs()
      • get_state_variable_array()
      • get_primary_field_id_of_phase()
      • get_phase_id_of_fields()
      • get_field_ids_in_layer()
      • get_phase_pair_id()
      • get_simulation_array()
      • get_simulation_tracer_array()
      • get_simulation_quantity()
      • get_tracer_id()
      • get_tracer_name_size()
      • get_tracer_name()
      • get_tracer_ref_by_name()
      • get_tracer_partition_coefficient()
      • get_wall_interfaces_temperature()
      • get_flow_pattern()
    • Unit Cell Model (UCM) helpers
      • get_ucm_friction_factor_input_variable()
      • get_ucm_fluid_geometrical_properties()
    • Liquid-Liquid Mechanistic Model helpers
      • get_liq_liq_flow_pattern_input_variable()
      • get_liquid_effective_viscosity_input_variable()
      • get_gas_liq_surface_tension_input_variable()
      • get_liq_liq_shear_force_per_volume_input_variable()
      • get_relative_emulsion_viscosity()
    • Variable Name Parsing
      • Basic example
      • List Model Example
      • Internal Reference Example
      • External Reference Example
      • Multiple Reference
• Application API
  • Models
    • data_model()
    • container_model()
  • Types
    • BaseField
    • String
    • Enum
    • Reference
    • MultipleReference
    • Quantity
    • Table
    • TableColumn
    • Boolean
    • FileContent
  • Layout
    • group()
    • tabs()
    • tab()
  • Status
    • ErrorMessage
    • WarningMessage
  • Context
    • Context
      • Context.get_edges()
      • Context.get_model()
      • Context.get_nodes()
      • Context.get_physics_options()
      • Context.get_pipelines()
      • Context.get_plugin_info_by_id()
      • Context.get_plugins_infos()
    • EdgeInfo
    • EmulsionModelInfo
    • HydrodynamicModelInfo
    • NodeInfo
    • PhysicsOptionsInfo
    • PipelineInfo
    • PipelineSegmentInfo
    • PluginInfo
• Configuration API
  • Hydrodynamic Model
    • AddField
    • AddPhase
    • UpdatePhase
    • AddLayer
    • UpdateLayer
  • Secondary Variables
    • SecondaryVariable
    • Type
    • Visibility
    • Location
    • Scope
  • Constants
    • GAS_PHASE
    • OIL_PHASE
    • WATER_PHASE
    • GAS_LAYER
    • OIL_LAYER
    • WATER_LAYER