NanotubeBundleBase

class sknano.core.structures.NanotubeBundleBase(*args, nx=1, ny=1, bundle_packing=None, bundle_geometry=None, **kwargs)[source] [edit on github][source]

Bases: sknano.core.structures.NanotubeBundleMixin, sknano.core.structures.NanoStructureBase

Nanotube bundle structure base class.

Parameters:
  • ny (nx,) –
  • bundle_packing ({None, 'hcp', 'ccp'}, optional) –
  • bundle_geometry ({None, 'hexagon', 'rectangle'}, optional) –

Attributes

Lx Axis-aligned length along the x-axis in Angstroms.
Ly Axis-aligned length along the y-axis in Angstroms.
Natoms Number of atoms in nanotube bundle.
Natoms_list list of Natoms per nanotube in bundle.
Natoms_per_bundle Alias for Natoms.
Natoms_per_tube Alias for Natoms_list.
Ntubes Number of nanotubes in bundle.
atoms Structure Atoms.
basis NanoStructureBase basis objects.
bundle_density Compute the nanotube bundle density.
bundle_geometry Bundle geometry.
bundle_mass An alias for mass.
bundle_packing Bundle packing.
crystal_cell Structure CrystalCell.
element1 Basis element 1
element2 Basis element 2
fmtstr Format string.
lattice Structure Crystal3DLattice.
lattice_shift Lattice displacement vector.
mass Bundle mass.
nx Number of nanotubes along the \(x\)-axis.
ny Number of nanotubes along the \(y\)-axis.
scaling_matrix CrystalCell.scaling_matrix.
structure An alias to self.
unit_cell Structure UnitCell.
vdw_distance Van der Waals distance.
vdw_radius Van der Waals radius

Methods

clear() Clear list of StructureMixin.atoms.
generate_bundle_coords() Generate coordinates of bundle tubes.
init_bundle_parameters() Initialize bundle attributes.
make_supercell(scaling_matrix[, wrap_coords]) Make supercell.
rotate(**kwargs) Rotate crystal cell lattice, basis, and unit cell.
todict() Return dict of constructor parameters.
transform_lattice(scaling_matrix[, ...]) Transform structure lattice.
translate(t[, fix_anchor_points]) Translate crystal cell lattice, basis, and unit cell.

Methods Summary

todict() Return dict of constructor parameters.

Methods Documentation

todict()[source] [edit on github][source]

Return dict of constructor parameters.