voxcity.simulator_gpu.solar.domain
==================================

.. py:module:: voxcity.simulator_gpu.solar.domain

.. autoapi-nested-parse::

   Domain definition for palm-solar.

   Represents the 3D computational domain with:
   - Grid cells (dx, dy, dz spacing)
   - Topography (terrain height)
   - Building geometry (3D obstacles)
   - Plant canopy (Leaf Area Density - LAD)
   - Surface properties (albedo)

   Coordinate System Notes:
       VoxCity uses a grid where:
       - i/u (row index) increases toward North
       - j (column index) increases from West to East
       - k (layer index) increases upward

       The Domain class maps grid indices to coordinates as:
       - x = i * dx (grid row/u direction, increases toward North)
       - y = j * dy (grid column/v direction, increases toward East)
       - z = k * dz (vertical, increases upward)

       Surface direction labels (INORTH, ISOUTH, etc.) follow PALM conventions
       but in VoxCity's grid:
       - IEAST (direction 4): compatibility label for the +i/+u boundary (North-facing)
       - IWEST (direction 5): compatibility label for the -i/-u boundary (South-facing)
       - INORTH (direction 2): surface at j+ boundary (East-facing in geographic terms)
       - ISOUTH (direction 3): surface at j- boundary (West-facing in geographic terms)



Attributes
----------

.. autoapisummary::

   voxcity.simulator_gpu.solar.domain.IUP
   voxcity.simulator_gpu.solar.domain.IDOWN
   voxcity.simulator_gpu.solar.domain.INORTH
   voxcity.simulator_gpu.solar.domain.ISOUTH
   voxcity.simulator_gpu.solar.domain.IEAST
   voxcity.simulator_gpu.solar.domain.IWEST
   voxcity.simulator_gpu.solar.domain.DIR_NORMALS


Classes
-------

.. toctree::
   :hidden:

   /autoapi/voxcity/simulator_gpu/solar/domain/Domain
   /autoapi/voxcity/simulator_gpu/solar/domain/Surfaces

.. autoapisummary::

   voxcity.simulator_gpu.solar.domain.Domain
   voxcity.simulator_gpu.solar.domain.Surfaces


Functions
---------

.. autoapisummary::

   voxcity.simulator_gpu.solar.domain.extract_surfaces_from_domain


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

.. py:data:: IUP
   :value: 0


.. py:data:: IDOWN
   :value: 1


.. py:data:: INORTH
   :value: 2


.. py:data:: ISOUTH
   :value: 3


.. py:data:: IEAST
   :value: 4


.. py:data:: IWEST
   :value: 5


.. py:data:: DIR_NORMALS

.. py:function:: extract_surfaces_from_domain(domain: Domain, default_albedo: float = 0.2) -> Surfaces

   Extract all surface elements from domain geometry.

   Creates surface elements at all interfaces between solid and air cells.

   :param domain: The computational domain
   :param default_albedo: Default surface albedo

   :returns: Surfaces object containing all extracted surfaces