voxcity.simulator_gpu.solar.domain¶

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¶

`IUP`
`IDOWN`
`INORTH`
`ISOUTH`
`IEAST`
`IWEST`
`DIR_NORMALS`

Classes¶

`Domain`	3D computational domain for solar radiation simulation.
`Surfaces`	Collection of surface elements for radiation calculations.

Functions¶

extract_surfaces_from_domain(→ Surfaces)

Extract all surface elements from domain geometry.

Module Contents¶

voxcity.simulator_gpu.solar.domain.IUP = 0¶

voxcity.simulator_gpu.solar.domain.IDOWN = 1¶

voxcity.simulator_gpu.solar.domain.INORTH = 2¶

voxcity.simulator_gpu.solar.domain.ISOUTH = 3¶

voxcity.simulator_gpu.solar.domain.IEAST = 4¶

voxcity.simulator_gpu.solar.domain.IWEST = 5¶

voxcity.simulator_gpu.solar.domain.DIR_NORMALS¶

voxcity.simulator_gpu.solar.domain.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.

Parameters:

domain – The computational domain
default_albedo – Default surface albedo

Returns:

Surfaces object containing all extracted surfaces