setup

MixedInvasionPercolationCoop.setup(phase=None, pore_entry_pressure='pore.entry_pressure', throat_entry_pressure='throat.entry_pressure', snap_off='', invade_isolated_Ts=False, late_pore_filling='', late_throat_filling='', cooperative_pore_filling='')[source]

Used to specify necessary arguments to the simulation. This method is useful for resetting the algorithm or applying more explicit control.

Parameters
  • phase (GenericPhase) – The Phase object containing the physical properties of the invading fluid.

  • pore_entry_pressure (str) – The dictionary key on the Phase object where the pore entry pressure values are stored. The default is ‘pore.entry_pressure’.

  • throat_entry_pressure (str) – The dictionary key on the Phase object where the throat entry pressure values are stored. The default is ‘throat.entry_pressure’.

  • snap_off (str) – The dictionary key on the Phase object where the throat snap-off pressure values are stored.

  • invade_isolated_Ts (bool) – If True, isolated throats are invaded at the higher invasion pressure of their connected pores.

  • late_pore_filling (str) – The name of the model used to determine late pore filling as a function of applied pressure.

  • late_throat_filling (str) – The name of the model used to determine late throat filling as a function of applied pressure.

  • cooperative_pore_filling (str) – The name of the model used to determine the meniscus properties required for assessing cooperative pore filling.