mpacts.commands.misc. volumechange

In order to be able to use this module import it like this:

import mpacts.commands.misc.volumechange
#or assign it to a shorter name
import mpacts.commands.misc.volumechange as vol

ComputeViscousVolumeChangeCommand

class mpacts.commands.misc.volumechange.ComputeViscousVolumeChangeCommand

Bases: mpacts.core.command.Command, mpacts.core.baseobject.BaseObject

This command changes the equilibrium volume of a deformable body if a certain threshold volume pressure has been exceeded. Proportional to this pressure multiplied with the permeable surface area (total area or area not in contact), the body will then shrink or expand its reference volume with the constant Lp. We require a reference volume to be set as well as ‘volume_pressure’ and ‘area’. ‘contact area’ also has to be set if Total_area=False.
Default location: ‘loop_cmds/body_force_cmds’
  • Required keywords:
    • Lp — Hydraulic conductivity [m/ (Pa s)]
    • pc — Particle container on which the command is applied
  • Optional keywords:
    • Total_area (default value = 1) — If true, volume loss is assumed to occur over the total area. If false, only the area not in contact will be assumed permeable
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • max_volume (default value = 1.7976931348623157e+308) — Maximal equilibrium volume that a cell can obtain. Above this, the volume will not be changed regardless of pressure.
    • min_volume (default value = 0) — Minimal equilibrium volume that a cell can obtain. Below this, the volume will not be changed regardless of pressure.
    • predicate (default value = None) — Predicate that will decide whether this command is executed for a specific particle, when absent the command is executed for every particle.
    • visc_threshold (default value = 0) — Threshold (pressure) at which the volume of the cell will starts viscously changing based upon the calculated volume pressure. This parameter is always positive.
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, Lp, [gate, predicate, visc_threshold, min_volume, max_volume, Total_area]
ComputeViscousVolumeChangeCommand(name, parent, **kwargs)