Skip to main content

neighbourhood_rule

Overloads​

NameDescription
neighbourhood_rule(string name, const List<LatticeCoord> deltas) -> NeighbourhoodRuleConstructor for a neighbourhood rule.
neighbourhood_rule(string name, const List<LatticeCoord> deltas, Constraint constraint) -> NeighbourhoodRuleConstructor for a neighbourhood representing a collection of lattice sites.

neighbourhood_rule(string name, const List<LatticeCoord> deltas) -> NeighbourhoodRule​

Constructor for a neighbourhood rule.

Parameters​

  • name: The name of the neighbourhood rule.
  • deltas: A list of displacements defining the neighbourhood of an arbitrary coordinate.

neighbourhood_rule(string name, const List<LatticeCoord> deltas, Constraint constraint) -> NeighbourhoodRule​

Constructor for a neighbourhood representing a collection of lattice sites.

Parameters​

  • name: The name of the neighbourhood rule.
  • deltas: The displacements for the neighbourhood.
  • constraint: The constraint function that candidate lattice sites must satisfy.