mbuild_polybuild.aa_functional_groups.tmstb.TMSTB.add

TMSTB.add(new_child, label=None, containment=True, replace=False, inherit_periodicity=None, inherit_box=False, check_box_size=True)

Add a part to the Compound.

Note:

This does not necessarily add the part to self.children but may instead be used to add a reference to the part to self.labels. See ‘containment’ argument.

Parameters:

  • new_child (mb.Compound or list-like of mb.Compound) – The object(s) to be added to this Compound.

  • label (str, or list-like of str, optional, default None) – A descriptive string for the part; if a list, must be the same length/shape as new_child.

  • containment (bool, optional, default=True) – Add the part to self.children.

  • replace (bool, optional, default=True) – Replace the label if it already exists.

  • inherit_periodicity (bool, optional, default=True) – Replace the periodicity of self with the periodicity of the Compound being added

  • inherit_box (bool, optional, default=False) – Replace the box of self with the box of the Compound being added

  • check_box_size (bool, optional, default=True) – Checks and warns if compound box is smaller than its bounding box after adding new_child.