CubeEmitter

March 30, 2022 ยท View on GitHub

from tdw.obi_data.fluids.cube_emitter import CubeEmitter

A cube-shaped Obi fluid emitter.


Fields

  • size The size of the cube in meters. If None, defaults to {"x": 0.1, "y": 0.1, "z": 0.1}.

  • sampling_method The EmitterSamplingMethod.


Functions

__init__

CubeEmitter()

CubeEmitter(size=None, sampling_method=EmitterSamplingMethod.volume)

ParameterTypeDefaultDescription
sizeDict[str, float]NoneThe size of the cube in meters. If None, defaults to {"x": 0.1, "y": 0.1, "z": 0.1}.
sampling_methodEmitterSamplingMethodEmitterSamplingMethod.volumeThe EmitterSamplingMethod.

to_dict

self.to_dict()

Returns: A JSON dictionary of this object.