optiwindnet.synthetic
=====================

.. py:module:: optiwindnet.synthetic




Module Contents
---------------

.. py:function:: L_from_synthetic(RootC: optiwindnet.geometric.CoordPairs, TerminalC: optiwindnet.geometric.CoordPairs, BorderC: optiwindnet.geometric.CoordPairs | None = None, name: str = '', handle: str = 'synthetic') -> networkx.Graph

   Special version of L_from_site() for the synthetic location geometry generator.

   Example::
     def make_tess(radius=5600, spacing=1000):
       NodeC = equidistant(radius, center='centroid', spacing=spacing)
       RootC = np.array((0.0, 0.0))
       return L_from_synthetic(RootC, NodeC, name='SynthTess', handle='tess')


.. py:function:: equidistant(radius: float, center: str = 'centroid', spacing: float = 1.0) -> optiwindnet.geometric.CoordPairs

   Create coordinates for the vertices of a regular triangular tiling.

   :param radius: of the circular area to cover
   :param center: one of {'centroid', 'vertex'}
                  centroid: The coordinate origin is in the centroid of the central triangle.
                  vertex: The coordinate origin a vertex of the tiling.
   :param spacing: the triangle's side

   :returns: Array of coordinates of the tiling's vertices.