pvfactors.geometry.pvground.TsGroundElement

class pvfactors.geometry.pvground.TsGroundElement(coords, list_ordered_cut_pts_coords=None, param_names=None, shaded=False)[source]

Special class for timeseries ground elements: a ground element has known timeseries coordinate boundaries, but it will also have a break down of its area into n+1 timeseries surfaces located in the n+1 ground zones defined by the n ground cutting points. This is crucial to calculate view factors in a vectorized way.

__init__(coords, list_ordered_cut_pts_coords=None, param_names=None, shaded=False)[source]

Initialize the timeseries ground element using its timeseries line coordinates, and build the timeseries surfaces for all the cut point zones.

Parameters

coords (TsLineCoords) – Timeseries line coordinates of the ground element
list_ordered_cut_pts_coords (list, optional) – List of all the cut point timeseries coordinates (Default = [])
param_names (list of str, optional) – List of names of surface parameters to use when creating geometries (Default = None)
shaded (bool, optional) – Flag specifying is element is a shadow or not (Default = False)

Methods

`__init__`(coords[, ...])	Initialize the timeseries ground element using its timeseries line coordinates, and build the timeseries surfaces for all the cut point zones.
`get_param_weighted`(param)	Get timeseries parameter for the ground element, after weighting by surface length.
`get_param_ww`(param)	Get timeseries parameter from the ground element with weight, i.e. after multiplying by the surface lengths.
`non_point_surfaces_at`(idx)	Return list of non-point surfaces (from left to right) at given index that make up the ground element.
`surfaces_at`(idx)	Return list of surfaces (from left to right) at given index that make up the ground element.

Attributes

`all_ts_surfaces`	List of all ts surfaces making up the ts ground element
`b1`	Timeseries coordinates of first boundary point
`b2`	Timeseries coordinates of second boundary point
`centroid`	Timeseries point coordinates of the element's centroid
`length`	Timeseries length of the ground