voxcity.simulator.solar.radiation
=================================

.. py:module:: voxcity.simulator.solar.radiation

.. autoapi-nested-parse::

   Stage 2: Physics - convert geometry to irradiance.



Functions
---------

.. autoapisummary::

   voxcity.simulator.solar.radiation.get_direct_solar_irradiance_map
   voxcity.simulator.solar.radiation.get_diffuse_solar_irradiance_map
   voxcity.simulator.solar.radiation.get_global_solar_irradiance_map
   voxcity.simulator.solar.radiation.compute_solar_irradiance_for_all_faces
   voxcity.simulator.solar.radiation.compute_solar_irradiance_for_all_faces_masked
   voxcity.simulator.solar.radiation.compute_cumulative_solar_irradiance_faces_masked_timeseries
   voxcity.simulator.solar.radiation.get_building_solar_irradiance


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

.. py:function:: get_direct_solar_irradiance_map(voxcity: voxcity.models.VoxCity, azimuth_degrees_ori, elevation_degrees, direct_normal_irradiance, show_plot=False, **kwargs)

   Compute horizontal direct irradiance map (W/m²) with tree transmittance.


.. py:function:: get_diffuse_solar_irradiance_map(voxcity: voxcity.models.VoxCity, diffuse_irradiance=1.0, show_plot=False, **kwargs)

   Compute diffuse horizontal irradiance map (W/m²) using SVF.


.. py:function:: get_global_solar_irradiance_map(voxcity: voxcity.models.VoxCity, azimuth_degrees_ori, elevation_degrees, direct_normal_irradiance, diffuse_irradiance, show_plot=False, **kwargs)

   Combine direct and diffuse horizontal irradiance (W/m²).


.. py:function:: compute_solar_irradiance_for_all_faces(face_centers, face_normals, face_svf, sun_direction, direct_normal_irradiance, diffuse_irradiance, voxel_data, meshsize, tree_k, tree_lad, hit_values, inclusion_mode, grid_bounds_real, boundary_epsilon)

   Numba kernel: compute per-face direct/diffuse/global (W/m²) using generic ray tracer.


.. py:function:: compute_solar_irradiance_for_all_faces_masked(face_centers, face_normals, face_svf, sun_direction, direct_normal_irradiance, diffuse_irradiance, vox_is_tree, vox_is_opaque, meshsize, att, x_min, y_min, z_min, x_max, y_max, z_max, boundary_epsilon)

.. py:function:: compute_cumulative_solar_irradiance_faces_masked_timeseries(face_centers, face_normals, face_svf, sun_dirs_arr, DNI_arr, DHI_arr, vox_is_tree, vox_is_opaque, meshsize, att, x_min, y_min, z_min, x_max, y_max, z_max, boundary_epsilon, t_start, t_end, time_step_hours)

.. py:function:: get_building_solar_irradiance(voxcity: voxcity.models.VoxCity, building_svf_mesh, azimuth_degrees, elevation_degrees, direct_normal_irradiance, diffuse_irradiance, **kwargs)

   Compute per-face direct/diffuse/global (W/m²) on a building mesh with SVF.