Help file for the Cut3D utility of the ABINIT package.

This file explains the use and i/o parameters needed for the "Cut 3-Dimensional files" code of the ABINIT package.

This code is able to analyse the files produced by ABINIT, that contain 3-Dimensional real space data, like all types of potential files, density files. Wavefunction files data can also be analysed : first, a k-point number, and the band number must be given, then, the corresponding wavefunction is transformed to real space.

In all these cases, thanks to Cut3D, one can obtain 2-Dimensional data corresponding to a cut by a plane, or 1-Dimensional data along a line. One can also translate the original formatting into many different ones.

Finally, one can also perform angular momenta analysis of wavefunctions with respect to any given atom, or computation of the Hirshfeld atomic charge (starting from a density file).

Copyright (C) 1998-2004 ABINIT group (XG,RC,GMR,JFB,MCote)
This file is distributed under the terms of the GNU General Public License, see ~ABINIT/Infos/copyright or http://www.gnu.org/copyleft/gpl.txt .
For the initials of contributors, see ~ABINIT/Infos/contributors .

Goto : ABINIT home Page | Welcome | Suggested acknowledgments | List of input variables | Tutorial home page | Bibliography
Help files : New user's guide | Abinis (main) | Abinis (respfn) | Mrgddb | Anaddb | AIM (Bader) | Cut3D

1. Running cut3d to analyse an unformatted file (_DEN, _POT, _WFK ...)

To run cut3d, simply type :
	
     cut3d

then, provide answer to the questions.
You will have to give first the name of the unformatted file. For example, t1xo_DEN.
You will have to specify whether this file is formatted or unformatted. Unformatted file corresponds to choice 1.

1.a. Unformatted file, excluding a wavefunction file

Supposing that you are not treating a wavefunction file, you will have to choose between different possibilities :

For option 1) you will have the possibility to specify a point in reduced or cartesian coordinates.

For option 2) you will have the possibility to specify a line by its two end-points in reduced or cartesian coordinates, or by it being perpendicular to some plane.

For option 3) and 4) many possibilities are offered, including specifications thanks to points defined in reduced coordinates, cartesian coordinates, or atomic positions.

For a wavefunction file, the two forms of outputs are : the bare data or a Data Explorer form. The option 10 also produce input files to draw the molecules in Data Explorer using modules and macros that JFB and MCote have developped. Those modules and macros could be made public.
To continue the analysis, simply answer the questions of the code, that should be sufficiently self-explanatory.

1.b. Unformatted wavefunction file

Instead, supposing that you are treating a wavefunction file, you will have to define the k point, the number of the band, and possibly the spin-polarization or the spinor component.
Then, you will be asked whether you want to perform the angular component analysis. You will have to provide the radius of the sphere(s) around each atom, for which the angular analysis will be performed.
Finally, you will be given the choice between different formatting of the wavefunction real-space data, including bare files, or XCrysDen or Data Explorer formatted files.


2. Starting from a formatted file.

     In the formatted case, one must have three different files :

     - the formatted 3D function (for example mos.densout)
      density or potential file in ASCII format
      with nr1 x nr2 x nr3 lines of 1 float

     - a file with complementary informations about the cell, the FFT grid ...
      (always named cut.in)
      Here is an example (6 lines):

      mos.xyz
      11.502384 6.0558159 16.295674  unit cell parameters (=acell)
      1 0 0 0 1 0 -0.215 0 0.976     orientation of the unit cell axes (=rprim)
      54 30 75                       grid size (= nr1,nr2,nr3, all three integers)
      10                             number of atoms in the unit cell (= natom, integer)
      2                              number of atomic types (=ntypat, integer)

      The first line gives the name of the file with atomic positions (Xmol format) (=filtau)
      No comment can appear on that line, in contrast with the other lines.

     - the coordinate file
      (for example mos.xyz)
      Its format (similar to XMOL) is

      On the first line the number of atoms (=natom) is provided.
      Blank line
      A list of natom lines containing :
      Char (1 or 2 characters, = atom label) + 3 float (X, Y, Z cart. coord.)

Goto : ABINIT home Page | Welcome | Suggested acknowledgments | List of input variables | Tutorial home page | Bibliography
Help files : New user's guide | Abinis (main) | Abinis (respfn) | Mrgddb | Anaddb | AIM (Bader) | Cut3D