set_residual

MercuryIntrusion.set_residual(pores=[], throats=[], overwrite=False)

Specify locations of any residual invader. These locations are set to invaded at the start of the simulation.

Parameters
  • pores (array_like) – The pores locations that are to be filled with invader at the beginning of the simulation.

  • throats (array_like) – The throat locations that are to be filled with invader at the beginning of the simulation.

  • overwrite (bool) – If True then all existing inlet locations will be removed and then the supplied locations will be added. If False, then supplied locations are added to any already existing locations.