@@ -49,6 +49,7 @@ def build_general_cubic_lattice(prim_frpos: ArrayLike, prim_length: float, nrep:
4949 nrep
5050 The number of times to repeat the primitive cell along each dimension.
5151 The primitive cell will thus be repeated `nrep**3` times.
52+ The cell length of the resulting cubic cell will be `prim_length * nrep`.
5253
5354 Returns
5455 -------
@@ -73,17 +74,17 @@ def build_general_cubic_lattice(prim_frpos: ArrayLike, prim_length: float, nrep:
7374
7475
7576def build_cubic_lattice (prim_length : float , nrep : int ):
76- """Build a simple cubic lattice with given cell length and number of repetitions."""
77+ """Build a simple cubic lattice with given primitive cell length and number of repetitions."""
7778 return build_general_cubic_lattice ([[0.0 , 0.0 , 0.0 ]], prim_length , nrep )
7879
7980
8081def build_bcc_lattice (prim_length : float , nrep : int ):
81- """Build a simple cubic lattice with given cell length and number of repetitions."""
82+ """Build a simple cubic lattice with given primitive cell length and number of repetitions."""
8283 return build_general_cubic_lattice ([[0.0 , 0.0 , 0.0 ], [0.5 , 0.5 , 0.5 ]], prim_length , nrep )
8384
8485
8586def build_fcc_lattice (prim_length : float , nrep : int ):
86- """Build a simple cubic lattice with given cell length and number of repetitions."""
87+ """Build a simple cubic lattice with given primitive cell length and number of repetitions."""
8788 prim_frpos = [[0.0 , 0.0 , 0.0 ], [0.0 , 0.5 , 0.5 ], [0.5 , 0.0 , 0.5 ], [0.5 , 0.5 , 0.0 ]]
8889 return build_general_cubic_lattice (prim_frpos , prim_length , nrep )
8990
0 commit comments