Skip to content

boundary

Boundary dataclass

Maps part of a subtile domain to another rank which shares halo points.

from_rank instance-attribute

to_rank instance-attribute

n_clockwise_rotations instance-attribute

number of clockwise rotations data undergoes if it moves from the from_rank to the to_rank. The same as the number of clockwise rotations to get from the orientation of the axes in from_rank to the orientation of the axes in to_rank.

__init__(from_rank, to_rank, n_clockwise_rotations)

send_view(quantity, n_points)

Return a sliced view of points which should be sent at this boundary.

Parameters:

Name Type Description Default
quantity Quantity

quantity for which to return a slice

required
n_points int

the width of boundary to include

required

recv_view(quantity, n_points)

Return a sliced view of points which should be received at this boundary.

Parameters:

Name Type Description Default
quantity Quantity

quantity for which to return a slice

required
n_points int

the width of boundary to include

required

send_slice(specification)

Return the index slices which should be sent at this boundary.

Parameters:

Name Type Description Default
specification QuantityHaloSpec

data specifications for the halo. Including shape and number of halo points.

required

Returns:

Type Description
tuple[slice, ...]

A tuple of slices (one per dimensions)

recv_slice(specification)

Return the index slices which should be received at this boundary.

Parameters:

Name Type Description Default
specification QuantityHaloSpec

data specifications for the halo. Including shape and number of halo points.

required

Returns:

Type Description
tuple[slice, ...]

A tuple of slices (one per dimensions)

SimpleBoundary dataclass

Bases: Boundary

A boundary representing an edge or corner of a subtile.

boundary_type instance-attribute

__init__(from_rank, to_rank, n_clockwise_rotations, boundary_type)