v_sim.PairLinkIter

Fields

Name	Type	Access	Description
box	v_sim.Box	r/w	a given box to apply periodicity if needed.
buffer	float	r/w	the length of the buffer around links, in percents.
coeff	float	r/w	a value used to characterised link length with respect to buffer (1. means that length is within link characteristics, while means that link is outside characteristics plus buffer).
d2	float	r/w	the length of the link, squared.
data	v_sim.Data	r/w	the v_sim.Data this iterator have to work on.
dxyz	[float]	r/w	the current vector (within periodicity) linking node1 to node2.
iter1	v_sim.NodeArrayIter	r/w	a v_sim.NodeArrayIter.
iter2	v_sim.NodeArrayIter	r/w	a second v_sim.NodeArrayIter.
l2	[float]	r/w	the current link length, squared.
l2_buffered	[float]	r/w	like l2, but including the buffer.
parent	v_sim.PairLink	r/w	the v_sim.PairLink this iterator is inheriting his properties.
periodic	bool	r/w	a boolean specifying if periodicity is to be taken into account when computing the vector linking two nodes.
xyz1	[float]	r/w	the current coordinates of the starting node in the link.
xyz2	[float]	r/w	the current coordinates of the ending node in the link.

Methods

next ()

Details

class v_sim.PairLinkIter

An iterator used to generate pairs with the characteristics given by parent, over the node in data.

New in version 3.8.

next()

Returns:

True if iterator is still valid.

Return type:

bool

Iterate to the next v_sim.Node - v_sim.Node pair.

New in version 3.8.