Package pipe_control :: Module domain
[hide private]
[frames] | no frames]

Module domain

source code

Module containing the structural domain related functions.

Functions [hide private]
 
define(id=None, spin_id=None)
Define the domain.
source code
list of str
get_domain_ids()
Return the list of all domain ID strings.
source code
Variables [hide private]
  __package__ = None
hash(x)
Function Details [hide private]

define(id=None, spin_id=None)

source code 

Define the domain.

Parameters:
  • id (str) - The domain ID string.
  • spin_id (str) - The spin ID string for all atoms of the domain.

get_domain_ids()

source code 

Return the list of all domain ID strings.

Returns: list of str
The list of all domain IDs.