set_occupancy

MultiPhase.set_occupancy(phase, Pvals=[], Tvals=[], pores=[], throats=[])[source]

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

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

  • Pvals (array_like) – The volume fraction of phase in each pore. This array must be Np-long, except when pores is also specified, where in that case they must be of equal length. If a scalar is received, it is applied to all the pores. If nothing is passed, Pvals=1.0 will be assumed.

  • Tvals (array_like) – The volume fraction of phase in each throat. This array must be Nt-long, except when throats is also specified, where in that case they must be of equal length. If a scalar is received it is applied to all the throats. If nothing is passed, Tvals=1.0 will be assumed.

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

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