Skip to main content

neighbourhood_rule

Overloads​

NameDescription
neighbourhood_rule(integer dx) -> NeighbourhoodRuleConstructor for a neighbourhood rule.
neighbourhood_rule(const List<integer> primitive vector) -> NeighbourhoodRuleConstructor for a neighbourhood rule.
neighbourhood_rule(const LatticeCoordinate coordinate, const Constraint constraint) -> NeighbourhoodRuleConstructor for a neighbourhood rule.
neighbourhood_rule(const LatticeCoordinate coordinate) -> NeighbourhoodRuleConstructor for a neighbourhood rule.
neighbourhood_rule(integer dx, const Constraint constraint) -> NeighbourhoodRuleConstructor for a neighbourhood rule.

neighbourhood_rule(integer dx) -> NeighbourhoodRule​

Constructor for a neighbourhood rule.

Parameters​

  • dx: Index corresponding to the displacement for a one dimensional lattice.

neighbourhood_rule(const List<integer> primitive vector) -> NeighbourhoodRule​

Constructor for a neighbourhood rule.

Parameters​

  • primitive vector: Primitive vector for the displacement of the lattice coordinate.

neighbourhood_rule(const LatticeCoordinate coordinate, const Constraint constraint) -> NeighbourhoodRule​

Constructor for a neighbourhood rule.

Parameters​

  • coordinate: Coordinate corresponding to the displacement in the neighbourhood rule.
  • constraint: The constraint function that candidate lattice coordinates must satisfy.

neighbourhood_rule(const LatticeCoordinate coordinate) -> NeighbourhoodRule​

Constructor for a neighbourhood rule.

Parameters​

  • coordinate: Coordinate corresponding to the displacement in the neighbourhood rule.

neighbourhood_rule(integer dx, const Constraint constraint) -> NeighbourhoodRule​

Constructor for a neighbourhood rule.

Parameters​

  • dx: Index corresponding to the displacement for a one dimensional lattice.
  • constraint: The constraint function that lattice coordinates must satisfy.