doc/index.rst

   1 *************
   2 ATOMIC module
   3 *************
   4
   5 **ATOMIC** module is a part of SALOME tutorial which consists of three modules: *ATOMIC*,
   6 *ATOMGEN* and *ATOMSOLV*.
   7
   8 .. contents:: Table of Contents
   9
  10 General description
  11 ===================
  12
  13 *ATOMIC* demonstrates a way to implement a so-called *light-weight* (or, simply, *light*)
  14 SALOME module. *Light-weight* modules are those which do not have a CORBA-based engine
  15 and do not use any CORBA-based services of SALOME platform (implemented in `SALOMEDS`,
  16 `NamingService`, `Container`, and other packages of *KERNEL* module).
  17
  18 The main goal is to prepare the data for the calculations which can be then performed
  19 in *ATOMGEN* and *ATOMSOLV* modules. It allows the user to enter the data using dialog boxes
  20 and then export the data to a file. In the *ATOMIC* component it is impossible to visualize
  21 the data in any way, neither it is intended to perform any algorithmic processing of the data.
  22
  23 *ATOMIC* data is a list of records, each containing three floating point values (Cartesian
  24 coordinates), and a string value (name). It represents molecules and atoms. An XML format
  25 is used for the exporting of data.
  26
  27 Typical study
  28 =============
  29
  30 *ATOMIC* module allows creating *atom* and *molecule* objects (a molecule is a compound of
  31 atoms). "Atom" object has three attributes describing `X`, `Y`, `Z` coordinates of atom's
  32 position within the molecule). "Molecules" and their "atoms" are shown in the Object Browser.
  33
  34 .. figure:: images/data_tree.png
  35    :align: center
  36    :alt: Typical contents of ATOMIC study
  37
  38 Operations
  39 ==========
  40
  41 The following operations are available in *ATOMIC* module:
  42
  43 * Add molecule
  44
  45 New molecule can be added to the study via main menu item *Atomic > Create molecule*.
  46 Created molecule has a name "Noname".
  47
  48 * Add atom
  49
  50 To add an atom, it is necessary to select a *parent* molecule and then invoke
  51 *Atomic > Add atom* main menu item. Alternatively, atom can be added by invoking
  52 *Add atom* item from context menu shown on right mouse button click on a molecule
  53 in the Object browser. In both cases, a dialog box is shown proposing to enter
  54 an atom's *name* and its *X*, *Y*, *Z* coordinates.
  55
  56 .. figure:: images/add_atom.png
  57    :align: center
  58    :alt: Add atom dialog
  59
  60 * Rename molecule or atom
  61
  62 To rename molecule or atom, select it in the Object browser, press right mouse button
  63 to show context menu and choose *Rename* item, then type new name in the dialog and
  64 press *Enter*.
  65
  66 * Remove molecules or atoms
  67
  68 To remove one or more molecules and/or atoms, select them in the Object browser,
  69 press right mouse button to show context menu and choose *Delete* item.
  70
  71 * Export study
  72
  73 To export an *ATOMIC* study to an XML file, invoke *File > Export...* main menu item.
  74 Then, in standard *Save File* dialog type the name of XML file and press *Save* button.
  75
  76 * Import study
  77
  78 Similarly, an *ATOMIC* study can be imported from an XML file. To do that, invoke
  79 *File > Import...* main menu item; in the standard *Open File* dialog choose an XML
  80 file to import and press *Open* button.