GranularFluid

July 24, 2023 ยท View on GitHub

from tdw.obi_data.fluids.granular_fluid import GranularFluid

Data for an Obi granular fluid. For more information, read this.


Fields

  • randomness The variation in particle size.

  • capacity The maximum amount of emitted particles.

  • resolution The size and amount of particles in 1 cubic meter. A value of 1 will use 1000 particles per cubic meter.

  • color The visual color of the fluid.

  • rest_density The fluid density in kg/m3.

  • radius_scale This scales the size at which particles are drawn.

  • random_velocity Random velocity of emitted particles.


Functions

__init__

GranularFluid(randomness, capacity, resolution, color, rest_density)

GranularFluid(randomness, capacity, resolution, color, rest_density, radius_scale=1.7, random_velocity=0)

ParameterTypeDefaultDescription
randomnessfloatThe variation in particle size.
capacityintThe maximum amount of emitted particles.
resolutionfloatThe size and amount of particles in 1 cubic meter.
colorDict[str, float]The visual color of the fluid.
rest_densityfloatThe fluid density in kg/m3.
radius_scalefloat1.7This scales the size at which particles are drawn.
random_velocityfloat0Random velocity of emitted particles.

to_dict

self.to_dict()

Returns: A JSON dictionary of this object.