lattice
Overloads
| Name | Description |
|---|---|
lattice(const RealMatrix primitive_vectors, const List<integer> dimensions) -> Lattice | Constructor for lattice class. |
lattice(const string geometry, const List<integer> dimensions) -> Lattice | Constructor for lattice. |
lattice(const RealMatrix primitive_vectors, const RealMatrix basis, const List<integer> dimensions) -> Lattice | Constructor for lattice. |
lattice(const RealMatrix primitive_vectors, const List<integer> dimensions, const List<BC> boundary conditions) -> Lattice | Constructor for lattice class. |
lattice(const string geometry, const List<integer> dimensions, const List<BC> boundary condition) -> Lattice | Constructor for lattice. |
lattice(const string geometry, const List<integer> dimensions, const Map parameters) -> Lattice | Constructor for lattice. |
lattice(const RealMatrix primitive vectors, const RealMatrix basis, const List<integer> dimensions, const List<BC> boundary condition) -> Lattice | Constructor for lattice. |
lattice(const string geometry, const List<integer> dimensions, const Map parameters, const List<BC> boundary condition) -> Lattice | Constructor for lattice. |
lattice(const RealMatrix primitive_vectors, const List<integer> dimensions) -> Lattice
Constructor for lattice class.
Parameters
- primitive_vectors: Primitive vectors of lattice, must give a vector for each dimension.
- dimensions: Dimensions of the lattice.
lattice(const string geometry, const List<integer> dimensions) -> Lattice
Constructor for lattice.
Parameters
- geometry: One of the predefined lattice geometries: honeycomb, honeycomb, square, oblique, triangular, rectangular, chain
- dimensions: Size of the lattice along each dimension
Example
var my_lattice = lattice("square", [100, 120])
lattice(const RealMatrix primitive_vectors, const RealMatrix basis, const List<integer> dimensions) -> Lattice
Constructor for lattice.
Parameters
- primitive_vectors: Primitive vectors of lattice, must give a vector for each dimension.
- basis: Positions of basis associated with each Bravais lattice point.
- dimensions: Dimensions of the lattice.
lattice(const RealMatrix primitive_vectors, const List<integer> dimensions, const List<BC> boundary conditions) -> Lattice
Constructor for lattice class.
Parameters
- primitive_vectors: Primitive vectors of lattice, must give a vector for each dimension.
- dimensions: Dimensions of the lattice.
- boundary conditions: Boundary conditions of the lattice.
lattice(const string geometry, const List<integer> dimensions, const List<BC> boundary condition) -> Lattice
Constructor for lattice.
Parameters
- geometry: One of the predefined lattice geometries: honeycomb, honeycomb, square, oblique, triangular, rectangular, chain
- dimensions: Size of the lattice along each dimension
- boundary condition: Boundary conditions for each dimension.
Example
var my_lattice = lattice("triangular", [100, 120], [boundary_condition.open, boundary_condition.periodic])
lattice(const string geometry, const List<integer> dimensions, const Map parameters) -> Lattice
Constructor for lattice.
Parameters
- geometry: One of the predefined lattice geometries: honeycomb, honeycomb, square, oblique, triangular, rectangular, chain
- dimensions: Size of the lattice along each dimension
- parameters: Lattice parameters. These are interpreted differently depending on the lattice.
Example
var my_lattice = lattice("oblique", [100, 120], ["a" : 1.2, "b" : 0.1, "theta" : 0.2*pi])
lattice(const RealMatrix primitive vectors, const RealMatrix basis, const List<integer> dimensions, const List<BC> boundary condition) -> Lattice
Constructor for lattice.
Parameters
- primitive vectors: Primitive vectors of lattice, must give a vector for each dimension.
- basis: Positions of basis associated with each Bravais lattice point.
- dimensions: Dimensions of the lattice.
- boundary condition: Boundary conditions for each dimension.
lattice(const string geometry, const List<integer> dimensions, const Map parameters, const List<BC> boundary condition) -> Lattice
Constructor for lattice.
Parameters
- geometry: One of the predefined lattice geometries: honeycomb, honeycomb, square, oblique, triangular, rectangular, chain
- dimensions: Size of the lattice along each dimension
- parameters: Lattice parameters. These are interpreted differently depending on the lattice.
- boundary condition: Boundary conditions for each dimension.
Example
var my_lattice = lattice("square", [10, 4], ["a" : 1.2], [boundary_condition.open, boundary_condition.open])