build_intrcmap¶
Generate a bare interaction map from a Geometry instance.
build_intrcmap
¶
Generate an interaction map from a Geometry instance.
Looks up the lattice builder registered for geo.lattice and delegates
to it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
geo
|
Geometry
|
Fully-resolved geometry struct, typically produced by |
required |
Returns:
| Type | Description |
|---|---|
list[Interaction2Site]
|
Interaction objects sorted by |
See Also¶
- Geometry — the input struct; construct it with
build_geometry. - build_geometry — the preceding step that produces the
Geometry. - Built-in interaction-map builders called internally:
- intrcmap_1dchain — 1D chain.
- intrcmap_square — 2D square lattice.
- intrcmap_kagome — 2D Kagome lattice.
- Custom intrcmap example — how to replace this function with a user-defined builder.