qlbm_rt

Functions

simulate(I_i, S_i, n, m, N[, n_timesteps, delta_t, ...])

Main simulation function for lattice Boltzmann radiative transfer.

Module Contents

qlbm_rt.simulate(I_i, S_i, n, m, N, n_timesteps=1, delta_t=1.0, kappa=0.0, sigma=0.0, angular_redistribution_coefficients=None, boundary_conditions=None, save_lattices=False, save_circuit=False, save_name=None, statevector_analysis_options=None, verbose=False)

Main simulation function for lattice Boltzmann radiative transfer.

Parameters:

  • I_i – Lattice of initial intensities.

  • S_i – Lattice of initial sources>

  • n – Number of simulation dimensions.

  • m – Number of direction vectors for the lattice Boltzmann method.

  • N – Grid dimensions.

  • n_timesteps (int) – Number of simulation timesteps (does not include timestep 0, which can exclude certain processes).

  • delta_t (float) – Temporal resolution of the simulation.

  • kappa (float) – Constant or array of absorption coefficients.

  • sigma (float) – Constant or array of scattering coefficients.

  • angular_redistribution_coefficents – Angular redistribution coefficients for use if AR is to be applied.

  • boundary_conditions (Iterable | None) – Boundary condition specifications.

  • save_lattices (bool) – Specifies whether to save the lattice at intermediate timesteps.

  • save_circuit (bool) – Specifies whether to save an image of the circuit at each timestep.

  • save_name (str | None) – Unique name to be used in save files.

  • statevector_analysis_options (Iterable | None) – Any options to be used during statevector simulation.

  • verbose (bool) – Specifies whether or not to print verbose information.

  • angular_redistribution_coefficients (Iterable[float] | None)

Returns:

Intensity lattices, source lattices, and statevector norms

Return type:

tuple[Iterable, Iterable, Iterable]