set_occupancy#

MultiPhase.set_occupancy(phase, *, pores=[], throats=[], values=1)[source]#

Specifies occupancy of a phase in each pore or throat. This method doesn’t return any value.

Parameters:
  • phase (Phase) – The phase whose occupancy is being specified.

  • pores (ndarray) – The location of pores whose occupancy is to be set.

  • throats (ndarray) – The location of throats whose occupancy is to be set.

  • values (ndarray or float) – Pore/throat occupancy values.