clamp_influence

The clamp influence can be used to clamp the value of a simulation property like voxel_density,point_velocity, or point_size.

To use this node, plug its output into the influences input of a simulate node like simulate_aero, simulate_particles, or simulate_mpm.

Inputs

influence

One may optionally connect an influence field out_influence into this port. For example a mask_influence node could be connected to mask the effect of this influence. Any number of influence fields may be added to the daisy chain to build a complex field.

enable

Turn off to disable the effect. Disabling makes it a pass through node. Note that any other influence fields connected to the influence input port will still be active when this is disabled.

property

The name of the simulation property to modify.

min

The minimum value to clamp to. The min and max may be a float, float3, scalarField or vectorField.

max

The maximum value to clamp to.

hard_mask

When enabled the mask, if it exists, will be interpreted as either 0.0 or 1.0 so that within the mask region the clamp values are guaranteed. Otherwise if the mask has partial values the clamp will pull towards the clamped value rather than instantly replacing it.

clamp_vector_length

This allows one to do things like clamp the speed (the length of the velocity). For this to work the property should be vector type and the min and max either float or scalarFields. The clamp is then applied to the length of the vector property.

Outputs

out_influence

An output influence object that one can connect to simulation nodes or other influence nodes.