#include <ERF_IBSEBSolar.H>

Collaboration diagram for ibseb::RayMap:

[legend]

Public Member Functions
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool	locate (int &ci, int &cj) const noexcept

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	column_top (int ci, int cj) const noexcept

Public Attributes
amrex::Array4< const int >	top
	Column tops over the patch (any k index; use `top.begin[2]`) More...

int	ilo = 0

int	jlo = 0
	Low corner of the domain, in cells. More...

int	nx = 0

int	ny = 0
	Columns of the domain in x and y. More...

bool	wrap_x = false

bool	wrap_y = false
	The patch spans the periodic domain in x / y. More...

amrex::Real	x_lo = 0.0

amrex::Real	y_lo = 0.0
	Physical position of the domain's low corner [m]. More...

amrex::Real	dx = 0.0

amrex::Real	dy = 0.0

amrex::Real	dz = 0.0
	Cell sizes [m]. More...

amrex::Real	z_ground = 0.0
	Ground height [m]. More...

amrex::Real	z_max = 0.0
	Tallest column the map holds [m]; a ray above it meets nothing. More...

int	max_steps = 0
	Columns a ray at the map's floor elevation crosses before it clears z_max (the halo's reach in x plus y) More...

Detailed Description

The column tops a ray cast on one rank sees: a k-collapsed map over this rank's patch of the level (its boxes grown by the halo of IBFaceSet::build_ray_map()), with the domain and the grid it is drawn on. An entry is the domain-relative k of the highest solid cell of its column, -1 where the column is fluid; column_top() turns it into a height. The patch holds the columns of other ranks and the periodic images within the halo, so the walk needs no communication. Where wrap_x (wrap_y) is set the patch spans the whole periodic domain in x (y) and a ray that leaves it comes back in on the other side; otherwise a ray that leaves the patch has left the map: the far field is open ground (see locate()). A ray is followed for as many columns as the halo's reach holds (max_steps), which is every column a ray no shallower than the map's floor can cross before it clears the tallest column or reaches the ground; a shallower ray stops there too, so a building beyond the halo's reach never shades, whether the map wraps or not. A level ray is followed for two rounds of the map and then counts as sky.

Member Function Documentation

◆ column_top()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real ibseb::RayMap::column_top	(	int	ci,
		int	cj
	)		const

inlinenoexcept

Top height of column (ci, cj) of the map (the ground where it is fluid).

     {
         const int kt = top(ci, cj, top.begin[2]);
         return (kt < 0) ? z_ground : z_ground + (kt + 1) * dz;
     }

Referenced by ibseb::ray_blocked(), and ibseb::ray_hit().

Here is the caller graph for this function:

◆ locate()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool ibseb::RayMap::locate	(	int &	ci,
		int &	cj
	)		const

inlinenoexcept

Whether the map holds column (ci, cj) (wrapped into the patch where the patch spans the domain).

     {
         if (ci < top.begin[0] || ci >= top.end[0]) {
             if (!wrap_x) { return false; }
             ci = top.begin[0] + ((ci - top.begin[0]) % nx + nx) % nx;
         }
         if (cj < top.begin[1] || cj >= top.end[1]) {
             if (!wrap_y) { return false; }
             cj = top.begin[1] + ((cj - top.begin[1]) % ny + ny) % ny;
         }
         return true;
     }