SFParticleEntity

The particle entity backing Stable Fluid smoke, created from a gs.materials.SF.Smoke material and simulated by the Stable Fluid (SF) solver.

class genesis.engine.entities.sf_entity.SFParticleEntity(scene, solver, material, morph, surface, particle_size, idx, particle_start, name: str | None = None)

Bases: ParticleEntity

PBD-based entity represented solely by particles.

process_input(in_backward=False)

Push position, velocity, and activation target states into the simulator.

Parameters:

in_backward (bool, default=False) – Whether the simulation is in the backward gradient pass.

sample()

Sample particles from the morph based on its type and the specified sampler.

Raises:

GenesisException – If no particles are sampled, or sampled particles lie outside the solver’s domain.

update_particles(particles)