Skip to content

particula.optics.gpu.bulk

Prepared bounded-memory optical reductions across particle populations.

Classes

NameDescription
PopulationWorkspaceRetained streaming population outputs, commands and scratch.

Functions

NameDescription
prepare_population_miePrepare streamed bulk optics without retaining particle optical output.

PopulationWorkspaceclassdataclass#

class PopulationWorkspace(optics: wp.array, mueller: wp.array, status: wp.array, particle_tile: int, _commands: tuple, _resources: tuple, _device: str, _stream: wp.Stream | None)

Retained streaming population outputs, commands and scratch.

Attributes

NameTypeDescription
opticswp.array(groups,9): extinction, scattering, absorption, backscatter, radiation pressure [m⁻¹], SSA, g, extinction/scattering validity.
muellerwp.array(groups,angles,4,4) differential matrices [m⁻¹/sr]; zero length angle axis when angular output was not requested.
statuswp.arrayPer-group status; 0 success, 2 input/upstream error, 3 overflow.
particle_tileintFixed maximum live particle scratch count.

Groups flatten box/wavelength axes. Outputs require enqueue and successful observation; inputs may be updated in place on the prepared stream.

_commandsattributeinstance attribute#

_commands: tuple

_deviceattributeinstance attribute#

_device: str

_resourcesattributeinstance attribute#

_resources: tuple

_streamattributeinstance attribute#

_stream: wp.Stream | None

muellerattributeinstance attribute#

mueller: wp.array

opticsattributeinstance attribute#

optics: wp.array

particle_tileattributeinstance attribute#

particle_tile: int

statusattributeinstance attribute#

status: wp.array

__init__method#

def __init__(optics: wp.array, mueller: wp.array, status: wp.array, particle_tile: int, _commands: tuple, _resources: tuple, _device: str, _stream: wp.Stream | None) -> None

checkmethod#

def check() -> None

Explicitly synchronize and reject failed population results.

enqueuemethod#

def enqueue() -> None

Enqueue the retained streaming calculation without host transfers.

prepare_population_miefunction#

def prepare_population_mie(relative_index: wp.array, size_parameter: wp.array, radius: wp.array, number_density_weights: wp.array, *, angles: wp.array | None = None, particle_tile: int = 256, angle_tile: int = 128, coefficient_capacity: int = 10090, stream=None) -> PopulationWorkspace

Prepare streamed bulk optics without retaining particle optical output.

Parameters

NameTypeDefaultDescription
relative_indexwp.arrayrequiredContiguous (groups,particles) vec2d relative n+ik.
size_parameterwp.arrayrequiredSame shape float64 x=2pir*n_medium/lambda_vacuum.
radiuswp.arrayrequiredSame shape float64 SI radius [m], consistent with x.
number_density_weightswp.arrayrequiredSame shape float64 density weights [m⁻³]. Callers supply discrete, resolved-count/volume or PDF weights.
angleswp.array | NoneNoneOptional shared 1D float64 angles [rad], on the same device.
particle_tileint256Maximum particles in scratch, default 256.
angle_tileint128Angular launch width, default 128.
coefficient_capacityint10090Maximum retained series order, default 10090.
streamNoneOptional matching CUDA stream; used for all work and checks.

Returns

PopulationWorkspace
Population workspace. Scratch is bounded by particle_tile, series
PopulationWorkspace
capacity and angle count, independently of total particle count.
PopulationWorkspace
No CPU transfers, fallback or scientific launches during preparation.

Raises

ValueError
If shapes/devices/capacities conflict. Physical-value errors are reported by check after enqueue, without host input readback.