README for loto

feram logo mark

Time-stamp: <2014-03-09 17:14:13 takeshi>

Table of Contents:

Homepage and DOWNLOAD

loto's homepage is http://loto.sourceforge.net/loto/ .

You can download a tar ball of loto (loto-X.YY.ZZ.tar.gz) from http://sourceforge.net/projects/loto/files/loto/ .

What is loto?

Keywords: materials science, computational physics, optical phonon, LO-TO splitting, dipole-dipole interaction, crystal structure, Ewald sum technique, Fortran 95/2003

This program, loto, analyzes dipole-dipole interactions in the systems with periodic boundary conditions. 3-dimensional bulks, 2-dimensional films and 1-dimensional wires can be treated. loto can plot dispersion diagrams of optical phonons for the dipolar systems, as shown in examples below.

loto is named after a mysterious physics phenomenon; the LO-TO splitting (longitudinal and transverse optical phonon splitting).

For more details in physics, see doc/theory.pdf .

doc/figures/DipoleCrystal.jpg
Figure 1: Schematic illustration of a dipole crystal. Thin solid lines indicate unit cell boundary. Thick dashed lines are super cell boundary (BvonK boundary condition). Arrows Are dipoles. I is index for dipoles in a unit cell, u_I is dipole moment or strength, r_I is vector to each dipole in a unit cell, and R is vector to each unit cell in a super cell.

References

What is NOT loto

loto has nothing to do with lotteries, e.g. http://www.loto.fr/ or http://www.takarakuji.mizuhobank.co.jp/miniloto/ . Good luck!

Installation instructions

INSTALL or INSTALL.html describe installation instructions for loto.

How to use loto

loto can read parameters from the standard input as well as from the file(s) given by the argument(s).

$ loto < an_input_file
$ cat an_input_file | loto
$ loto input_file ...

examples:

$ loto < triangular
$ loto 2d/kagome
$ loto sc bcc fcc

You can plot a dispersion relation with a generated gnuplot script.

$ loto square
$ ls square*
square
square.dispersion
square.example.gp
$ gnuplot square.example.gp
$ gv square.energy.eps
$ loto 3d/diamond1 3d/diamond2
$ gnuplot 3d/diamond1.example.gp 3d/diamond2.example.gp
$ gv 3d/diamond1.energy.eps
$ gv 3d/diamond2.energy.eps

How to write an input file

The input file for loto is a text file consisting of comment lines and 'tag = value(s)' lines.

Comment

Lines beginning with '#' are ignored. Blank lines are also ignored.

# This is a comment line.
# Here are two more
# comment lines.

Tags

tag = value(s)

You must put ' = ', space-equal-space, between a tag and value(s) as:

tag = 1.0
tag = -2.0 -3.0 -4.0
tag =  5.0  6.0  7.0

Followings are currently available tags alphabetically ordered.

Descriptions of tags

atom

position 0.0 0.0 -0.5, effective_mass 1.0, effective_charge 1.0:

atom = 0.0 0.0 -0.5   1.0  1.0

position 1.0 0.0 0.5, effective_mass 1.2, effective_charge_tensor 1.0 2.0 3.0 0.1 0.1 0.1:

atom = 1.0 0.0 0.5   1.2  1.0 2.0 3.0 0.1 0.1 0.1
axis

See "k-point and axis" below.

dimension
dimension = 3
dimension = 2
dimension = 1
dipole

position, effective mass, strength, initial direction of a dipole. Use this tag for the 0-dimensional cases instead of the 'atom' tag.

example (position 0.0 0.0 0.0, mass 1.0, strength 1.0, initial direction 1.0 0.0 0.0):

dipole = 0.0 0.0 0.0  1.0  1.0  1.0 0.0 0.0
epsilon

Optical dielectric constant tensor (square of the refractive index).

epsilon = 1.0 1.0 1.0 0.0 0.0 0.0 (default)
epsilon = 1.0 2.0 3.0 4.0 5.0 6.0
                        1.0 6.0 5.0
   means  epsilon_inf = 6.0 2.0 4.0
                        5.0 4.0 3.0
G_max

Ranges for the reciprocal-space summation. The ranges will be -G_max(i)-1 ... G_max(i).

G_max = 0 0 0 (default)
G_max = 1 1 1
gamma

Dumping factor for minimization scheme for 0-dimensional systems. See src/finite_force_matrix.F .

gamma = 0.1 (default)
gamma = 0.2 (faster convergence, lager possibility of failure)
k-point and axis
k-point = index_letter coordinates
axis    = axis_label dividing_number

dividing_number depends on L. example:

k-point = 'M'           0.5 0.5 0.0
axis    = '{/Symbol S}' 16
k-point = '{/Symbol G}' 0.0 0.0 0.0
axis    = '{/Symbol D}' 16
k-point = 'X'           0.5 0.0 0.0
axis    = 'Z'           16
k-point = 'M'           0.5 0.5 0.0
L

Super cell size. In another word, k-point mesh.

L = 32 32 32
L = 32 32  1
L = 1 1 1
n_max

Ranges for the real-space summation. The ranges will be -n_max(i)-1 ... n_max(i).

n_max = 0 0 0 (default)
n_max = 1 1 0
n_max_Gamma

Ranges for the real-space summation only for the Gamma point of the layered 2-dimensional case.

n_max_Gamma = 12 12 0
prim1, prim2, prim3

Primitive cell vectors.

prim1 =  1.0 0.0 0.0
prim2 =  0.0 1.0 0.0
prim3 =  0.0 0.0 1.0
title
title = 'Example Title'
title = 'Example for the enhanced postscript terminal in gnuplot:  {/Times-Italic a}_1'

Output .dispersion file

foo.dispersion is something like this:

# k-point: {/Symbol G}
# axis: {/Symbol D}
#
   0.000000   0.000000   0.000000   0.000000  -2.046653  -2.046653  -2.046653
#     0.00000   0.00000     1.00000   0.00000     0.00000   0.00000
#     0.00000   0.00000     0.00000   0.00000    -1.00000   0.00000
#    -1.00000   0.00000     0.00000   0.00000    -0.00000   0.00000
#
   0.031250   0.031250   0.000000   0.000000  -2.048200   2.896593  -2.048200
#    -0.00000   0.00000     1.00000   0.00000     0.00000   0.00000
#    -0.44785  -0.00000     0.00000   0.00000     0.89411   0.00000
#     0.89411   0.00000     0.00000   0.00000     0.44785   0.00000
#
   0.062500   0.062500   0.000000   0.000000  -2.052774   2.903060  -2.052774
#    -0.00000   0.00000     1.00000   0.00000     0.00000   0.00000
#    -0.19598   0.00000     0.00000   0.00000     0.98061   0.00000
#     0.98061   0.00000     0.00000   0.00000     0.19598   0.00000
#
         .
         .
         .

Lines starting with '#' are comments.

Data lines are containing:

x_plot k_1 k_2 k_3 frequency_1 frequency_2 ... frequency_3N

where N is the number of atoms. Imaginary frequencies are indicated as negative values.

Examples

3-dimensional bulks

3-dimensional simple cubic dipole lattice

Input file: examples/3d/sc

doc/figures/3d/sc.BZ.jpg
Figure 2: First Brillouin zone for simple cubic (sc) crystal. Symmetric k-points and axes are indicated.
doc/figures/3d/sc.energy.without-correction.jpg
Figure 3: Dipole-dipole interaction energy of simple cubic dipole lattice. The LO-TO splitting is not yet corrected at the Gamma point.
doc/figures/3d/sc.energy.jpg
Figure 4: Dipole-dipole interaction energy of simple cubic dipole lattice. You have to introduce the LO-TO splitting at the Gamma point by your hands. Minimum is at the M point.
doc/figures/3d/sc.M.jpg
Figure 5: Most stable antiferro structure of sc dipole infinite crystal. The structure is of the M point in the first Brillouin zone. -up-up-up-up-up- rods and -down-down-down-down-down- rods are forming a checkerboard configuration.
doc/figures/3d/sc.frequency.jpg
Figure 6: Frequency of optical phonon. Crystal which has one dipole per primitive cell does not has acoustic phonon. There are only 3 optical phonon branches.
doc/figures/3d/oscillation.jpg
Figure 7: Schematic illustration of longitudinal oscillation of a dielectric thin film. Polarization P_z perpendicular to the film causes surface charges P_z. The surface charges result in depolarization field E_d=-4 pi P_z in the film.

3-dimensional body-centered cubic dipole lattice

Input file: examples/3d/bcc

doc/figures/3d/bcc.energy.jpg
Figure 8:

3-dimensional face-centered cubic dipole lattice

Input file: examples/3d/fcc

doc/figures/3d/fcc.energy.jpg
Figure 9:

3-dimensional diamond dipole lattice

Input file: examples/3d/diamond1 or examples/3d/diamond2

doc/figures/3d/diamond1.energy.jpg
Figure 10:

3-dimensional body-centered tetragonal dipole lattice

Input file: examples/3d/bct

doc/figures/3d/bct.energy.jpg
Figure 11:

3-dimensional orthorhombic dipole lattice

Input file: examples/3d/orthorhombic

doc/figures/3d/orthorhombic.energy.jpg
Figure 12: You can clearly see that the LO-TO splitting at the Gamma point depends on approaching directions.

2-dimensional films

2-dimensional square lattice

Input file: examples/2d/square

doc/figures/2d/square.BZ.jpg
Figure 13: First Brillouin zone for 2-dimensional square crystal. Symmetric k-points (Gamma, X, and M) and axes (Delta, Z, and Sigma) are indicated.
doc/figures/2d/square.energy.jpg
Figure 14: Dipole-dipole interaction energy of 2-dimensional square dipole lattice. Minimum is at the X point. Red solid lines are in-plane modes. Green dashed line is out-of-plane mode.
doc/figures/2d/kxky.jpg
Figure 15: It is known that the ground-state of the infinite periodic dipole square lattice forms a continuously degenerate manifold of antiferromagnetic states.

2-dimensional triangular lattice

Input file: examples/2d/triangular

doc/figures/2d/triangular.structure.and.BZ.jpg
Figure 16: 2-dimensional triangular crystal (left) and its first Brillouin zone (right). In the figure of triangular crystal, real-space axes a and b are indicated. a* and b* are primitive axes in reciprocal space. In the first Brillouin zone, symmetric k-points (Gamma, M, and K) and axes (Sigma, T, and T') are indicated.
doc/figures/2d/triangular.energy.jpg
Figure 17: Minimum is at the Gamma point. Therefore, ferro-state is the most stable structure for the 2-dimensional triangular crystal.

2-dimensional 1/4 depleted dipole square lattice

Input file: examples/2d/depleted

doc/figures/2d/depleted.structure.jpg
Figure 18: 2-dimensional 1/4 depleted dipole square lattice. 1/4 of sites are depleted from 2-dimensional square lattice.
doc/figures/2d/depleted.energy.jpg
Figure 19:

1-dimensional wires

1-dimensional simple dipole wire

Input file: examples/1d/simple

doc/figures/1d/simple.energy.jpg
Figure 20:

1-dimensional ladder dipole wire

Input file: examples/1d/ladder11

doc/figures/1d/ladder.structure.jpg
Figure 21:
doc/figures/1d/ladder11.energy.jpg
Figure 22:

Subversion

Instructions for developers

$ svn checkout --username=YourUsername https://svn.code.sf.net/p/loto/code loto
$ cd loto/loto/trunk/
$ ls -l
$ autoreconf -v
$ automake --add-missing
$ autoreconf -v
$ ls -l
$ emacs README
$ svn stat
$ svn diff
$ svn commit -m 'add URL of homepage'
$ svn log
$ svn update
$ svn log

Mailing list

Copying

Copyright © 2007-2014 Takeshi Nishimatsu (t-nissie{at}imr.tohoku.ac.jp)

loto is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. You can copy, modify and redistribute loto, but only under the conditions described in the GNU General Public License (the "GPL"). For more detail, see COPYING.

Acknowledgements

This project is/was partially supported by:

loto is hosted by SourceForge.net Logo .


Copyright © 2014 Takeshi Nishimatsu