artist.field.heliostat_group

Heliostat group in ARTIST.

Classes

HeliostatGroup

Initialize the heliostat group.

Module Contents

class artist.field.heliostat_group.HeliostatGroup(names: list[str], positions: torch.Tensor, surface_points: torch.Tensor, surface_normals: torch.Tensor, canting: torch.Tensor, facet_translations: torch.Tensor, initial_orientations: torch.Tensor, nurbs_control_points: torch.Tensor, nurbs_degrees: torch.Tensor, device: torch.device | None = None)

Initialize the heliostat group.

Parameters

nameslist[str]: The string names of each heliostat in the group in order.
positionstorch.Tensor: The positions of all heliostats in the group. Shape is [number_of_heliostats, 4].
surface_pointstorch.Tensor: The surface points of all heliostats in the group. Shape is [number_of_heliostats, number_of_combined_surface_points_all_facets, 4].
surface_normalstorch.Tensor: The surface normals of all heliostats in the group. Shape is [number_of_heliostats, number_of_combined_surface_normals_all_facets, 4].
initial_orientationstorch.Tensor: The initial orientations of all heliostats in the group. Shape is [number_of_heliostats, 4].
nurbs_control_pointstorch.Tensor: The control points for NURBS surfaces for all heliostats in the group. Shape is [number_of_heliostats, number_of_facets_per_heliostat, number_of_control_points_u_direction, number_of_control_points_v_direction 3].
nurbs_degreestorch.Tensor: The spline degrees for NURBS surfaces in u and then in v direction, for all heliostats in the group. Shape is [2].
devicetorch.device | None: The device on which to perform computations or load tensors and models (default is None). If None, ARTIST will automatically select the most appropriate device (CUDA or CPU) based on availability and OS.

number_of_heliostats

number_of_facets_per_heliostat

names

positions

surface_points

surface_normals

canting

facet_translations

initial_orientations

nurbs_control_points

nurbs_degrees

kinematics

number_of_active_heliostats = 0

active_heliostats_mask

active_surface_points

active_surface_normals

active_canting

active_facet_translations

active_nurbs_control_points

preferred_reflection_directions

abstractmethod align_surfaces_with_incident_ray_directions(aim_points: torch.Tensor, incident_ray_directions: torch.Tensor, active_heliostats_mask: torch.Tensor, device: torch.device | None = None) → None

Align surface points and surface normals with incident ray directions.

Parameters

aim_pointstorch.Tensor: The aim points for all active heliostats. Shape is [number_of_active_heliostats, 4].
incident_ray_directionstorch.Tensor: The incident ray directions. Shape is [number_of_active_heliostats, 4].
active_heliostats_masktorch.Tensor: A mask where 0 indicates a deactivated heliostat and 1 an activated one. An integer greater than 1 indicates that this heliostat is regarded multiple times. Shape is [number_of_heliostats].
devicetorch.device | None: The device on which to perform computations or load tensors and models (default is None). If None, ARTIST will automatically select the most appropriate device (CUDA or CPU) based on availability and OS.

Raises

NotImplementedError: Whenever called (abstract base class method).

abstractmethod align_surfaces_with_motor_positions(motor_positions: torch.Tensor, active_heliostats_mask: torch.Tensor, device: torch.device | None = None) → None

Align surface points and surface normals with motor positions.

Parameters

motor_positionstorch.Tensor: The motor positions for all active heliostats. Shape is [number_of_active_heliostats, 2].
active_heliostats_masktorch.Tensor: A mask where 0 indicates a deactivated heliostat and 1 an activated one. An integer greater than 1 indicates that this heliostat is regarded multiple times. Shape is [number_of_heliostats].
devicetorch.device | None: The device on which to perform computations or load tensors and models (default is None). If None, ARTIST will automatically select the most appropriate device (CUDA or CPU) based on availability and OS.

Raises

NotImplementedError: Whenever called (abstract base class method).

activate_heliostats(active_heliostats_mask: torch.Tensor | None = None, device: torch.device | None = None) → None

Activate certain heliostats for alignment, raytracing or optimization.

Select and repeat indices of all active heliostat and kinematics parameters once according to the mask. Doing this once instead of slicing every time when accessing one of those parameter tensors saves memory.

Parameters

active_heliostats_masktorch.Tensor | None: A mask where 0 indicates a deactivated heliostat and 1 an activated one (default is None). An integer greater than 1 indicates that this heliostat is regarded multiple times. If no mask is provided, all heliostats in the scenario will be activated once. Shape is [number_of_heliostats].
devicetorch.device | None: The device on which to perform computations or load tensors and models (default is None). If None, ARTIST will automatically select the most appropriate device (CUDA or CPU) based on availability and OS.