qlbm_rt
=======

.. py:module:: qlbm_rt


Functions
---------

.. autoapisummary::

   qlbm_rt.simulate


Module Contents
---------------

.. py:function:: 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.

   :param I_i: Lattice of initial intensities.
   :param S_i: Lattice of initial sources>
   :param n: Number of simulation dimensions.
   :param m: Number of direction vectors for the lattice Boltzmann method.
   :param N: Grid dimensions.
   :param n_timesteps: Number of simulation timesteps (does not include timestep 0, which can exclude certain processes).
   :param delta_t: Temporal resolution of the simulation.
   :param kappa: Constant or array of absorption coefficients.
   :param sigma: Constant or array of scattering coefficients.
   :param angular_redistribution_coefficents: Angular redistribution coefficients for use if AR is to be applied.
   :param boundary_conditions: Boundary condition specifications.
   :param save_lattices: Specifies whether to save the lattice at intermediate timesteps.
   :param save_circuit: Specifies whether to save an image of the circuit at each timestep.
   :param save_name: Unique name to be used in save files.
   :param statevector_analysis_options: Any options to be used during statevector simulation.
   :param verbose: Specifies whether or not to print verbose information.

   :returns: Intensity lattices, source lattices, and statevector norms