viperleed.calc.classes.slab.surface\_slab.SurfaceSlab
=====================================================

.. currentmodule:: viperleed.calc.classes.slab.surface_slab

.. autoclass:: SurfaceSlab

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~SurfaceSlab.__init__
      ~SurfaceSlab.apply_matrix_transformation
      ~SurfaceSlab.apply_scaling
      ~SurfaceSlab.check_a_b_in_plane
      ~SurfaceSlab.check_atom_collisions
      ~SurfaceSlab.check_vacuum_gap
      ~SurfaceSlab.clear_symmetry_and_ucell_history
      ~SurfaceSlab.collapse_cartesian_coordinates
      ~SurfaceSlab.collapse_fractional_coordinates
      ~SurfaceSlab.create_layers
      ~SurfaceSlab.create_sublayers
      ~SurfaceSlab.detect_bulk
      ~SurfaceSlab.ensure_minimal_bulk_ab_cell
      ~SurfaceSlab.from_ase
      ~SurfaceSlab.from_slab
      ~SurfaceSlab.full_update
      ~SurfaceSlab.getSurfaceAtoms
      ~SurfaceSlab.get_bulk_repeat
      ~SurfaceSlab.get_minimal_ab_cell
      ~SurfaceSlab.get_nearest_neighbours
      ~SurfaceSlab.has_atoms_in_multiple_c_cells
      ~SurfaceSlab.identify_bulk_repeat
      ~SurfaceSlab.initSites
      ~SurfaceSlab.is_equivalent
      ~SurfaceSlab.is_mirror_symmetric
      ~SurfaceSlab.is_rotation_symmetric
      ~SurfaceSlab.is_translation_symmetric
      ~SurfaceSlab.make_bulk_slab
      ~SurfaceSlab.make_subcell
      ~SurfaceSlab.make_supercell
      ~SurfaceSlab.mirror_atoms
      ~SurfaceSlab.project_c_to_z
      ~SurfaceSlab.remove_duplicate_atoms
      ~SurfaceSlab.remove_vacuum_at_bottom
      ~SurfaceSlab.restoreOriState
      ~SurfaceSlab.revert_unit_cell
      ~SurfaceSlab.rotate_atoms
      ~SurfaceSlab.rotate_unit_cell
      ~SurfaceSlab.sort_by_element
      ~SurfaceSlab.sort_by_z
      ~SurfaceSlab.sort_original
      ~SurfaceSlab.transform_unit_cell_2d
      ~SurfaceSlab.translate_atoms_2d
      ~SurfaceSlab.translate_atoms_c
      ~SurfaceSlab.update_atom_numbers
      ~SurfaceSlab.update_cartesian_from_fractional
      ~SurfaceSlab.update_element_count
      ~SurfaceSlab.update_fractional_from_cartesian
      ~SurfaceSlab.update_layer_coordinates
      ~SurfaceSlab.with_extra_bulk_units
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~SurfaceSlab.ab_cell
      ~SurfaceSlab.angle_between_ucell_and_coord_sys
      ~SurfaceSlab.bottom_atom
      ~SurfaceSlab.bulk_atoms
      ~SurfaceSlab.bulk_layers
      ~SurfaceSlab.c_vector
      ~SurfaceSlab.elements
      ~SurfaceSlab.fewest_atoms_sublayer
      ~SurfaceSlab.interlayer_gaps
      ~SurfaceSlab.is_bulk
      ~SurfaceSlab.n_atoms
      ~SurfaceSlab.n_layers
      ~SurfaceSlab.n_sublayers
      ~SurfaceSlab.non_bulk_layers
      ~SurfaceSlab.smallest_interlayer_gap
      ~SurfaceSlab.thickness
      ~SurfaceSlab.top_atom
      ~SurfaceSlab.vacuum_gap