Home Documentation Using the R.I.N.G.S. code The R.I.N.G.S. code 'options' file

The R.I.N.G.S. code 'options' file

E-mail Print

In order to setup a calculation using the R.I.N.G.S. 2 files are needed:

1) an input file - name does not matter
2) a file which must be named "options"

The "options" file describes the analysis that will be performed when running the R.I.N.G.S. code.

An sample version of the R.I.N.G.S. "options" file is given thereafter with an explanation of each variable.

 

    #######################################
R.I.N.G.S. options file #
#######################################
(1) PBC             .true.               #
(2) Frac            .false.              #
(3) g(r)            .false.              #
(4) S(q)            .false.              #

(5) S(k)            .false.              #
(6) gfft(r)         .false.              #
(7) MSD             .false.              #
(8) atMSD          .false.      #
(9) Bonds          .true. #
(10) Angles          .false.              #

(11) Chains        .true.   #
----- ! Chain statistics options ! -----
(12) Species    0                #
(13) AAAA  .false.     #
(14) ABAB      .false.     #
(15) 1221     .false.             #

---------------------------------------
(16) Rings         .true.   #
----- ! Ring statistics options ! -----
(17) Species    0                #
(18) ABAB  .false.     #
(19) Rings0     .false.     #
(20) Rings1    .false.             #
(21) Rings2        .false.   #
(22) Rings3    .true.       #
(23) Rings4     .true.            #
(24) Prim_Rings      .true.               #
(25) Str_Rings   .false.           #
(26) BarycRings     .false.    #
(27) Prop-1         .false.    #
(28) Prop-2   .false.              #
(29) Prop-3         .false.         #
(30) Prop-4         .false.       #
(31) Prop-5         .false. #
---------------------------------------
(32) Vacuum   .false.          #
#######################################
Outputting options     #
#######################################
(33) Evol           .false.   #
(34) Dxout         .false.    #
-- ! OpenDX visualization options !  --
(35) RadOut         .false.     #
(36) RingsOut     .false.       #
(37) DRngOut     .false.          #
(38) VoidsOut .false.        #
(39) TetraOut     .false.            #
(40) TrajOut     .false.        #
---------------------------------------
(41) Output        my-output.out    #
#######################################
(1) Use or not the periodic boundary conditions.
=> LOGICAL (.true. / .false.)

(2) Fractional (.true.) or real (.false.) atomic coordinates.

The default option in the RINGS code is to use fractional coordinates of the [lattice parameters] then the point having (0,0,0)
for coordinate is a corner of the simulation box, nevertheless it is possible to modify this option and to use fractional coordinates
of the [lattice parameters]/2.0 then the point having (0,0,0) coordinate is the center of the simulation box.
This can be done by editing the file "parameters.F90":

238 INTEGER :: FRACTYPE=0
in
238 INTEGER :: FRACTYPE=1
=> LOGICAL (.true. / .false.)

(3) Evaluation of the radial distribution functions, g(r):
- Total g(r) and G(r).
- Partial gαβ(r) and Gαβ(r).
- Bhatia-Thornton g(r) [a].
- Various neutron weighted functions (D(r), G(r), T(r), g(r)) [b].

=> LOGICAL (.true. / .false.)
(4) Evaluation of the neutron and X-rays structure factors, S(q), from FFT of the g(r) [depends on (3)]:
- Faber-Ziman partials S(q) [c]
- Ashcroft-Langreth partials S(q) [d, e, f]
- Bhatia-Thornton partials S(q) [g]
=> LOGICAL (.true. / .false.)
(5) Evaluation of the neutron and X-rays structure factors, S(q), from single atomic correlations (Debye equation):
- Faber-Ziman partials S(q) [c]
- Ashcroft-Langreth partials S(q) [d, e, f]
- Bhatia-Thornton partials S(q) [g]
=> LOGICAL (.true. / .false.)

(6) Evaluation of the radial distribution functions, g(r)
from the Fourier transform of the structure factor calculated using the Debye equation [depends on (5)]:
- Total g(r) and G(r).
- Partial gαβ(r) and Gαβ(r).
- Bhatia-Thornton g(r) [a].
- Various neutron weighted functions (D(r), G(r), T(r), g(r)) [b].

=> LOGICAL (.true. / .false.)
(7) Evaluation of the Mean Square Displacement MSD *
- Atomic species MSD.
- Directional MSD (x, y, z, xy, xz, yz).
- Directional MSD (x, y, z, xy, xz, yz).
- Drift of the center of mass.
- Diffusion constant.
=> LOGICAL (.true. / .false.)
(8) MSD for each single atom *. => LOGICAL (.true. / .false.)
* Computations can be performed either with or without applying a self-correlation on the results.
(9) Properties of the chemical bonds:
- Coordination.
- Proportions of the different structural environments.
- Proportions of tetrahedra.
- Proportions of inter-tetrahedral bonds.
=> LOGICAL (.true. / .false.)
(10) Bond angles and dihedral angles distribution. => LOGICAL (.true. / .false.)
(11) Activation of the chain statistics. => LOGICAL (.true. / .false.)

- (12) Chemical species used to initiate the search :
- 0 = All atoms are used
- 1 < xTotal number of chemical species: only the atoms of the x species are used,
x follows the order of appearance of the chemical species in the file that contains the atomic coordinates.

=> INTEGER
- (13) Only look for AAAA chains. => LOGICAL (.true. / .false.)
- (14) Only look for ABAB chains, homopolar bonds are taken into account when creating the nearest neighbors table. => LOGICAL (.true. / .false.)
- (15) Only look for 1-(2)n-1 coordinated atoms chains, ie. isolated chains. => LOGICAL (.true. / .false.)
(16) Activation of the ring statistics. => LOGICAL (.true. / .false.)

- (17) Chemical species used to initiate the search:
- 0 = All atoms are used
- 1 < xTotal number of chemical species: only the atoms of the x species are used,
x follows the order of appearance of the chemical species in the file that contains the atomic coordinates.

=> INTEGER
- (18) Only look for ABAB rings.
- Homopolar bonds are ignored when creating the nearest neighbors table.
- Allows to look for primitive ABAB rings.
- Look for ABAB rings in systems with more than 2 chemical species.
- The option affects all the R.I.N.G.S. code as well as options (22) and (23).
=> LOGICAL (.true. / .false.)
- (19) Look for all closed paths in the box. => LOGICAL (.true. / .false.)
- (20) Look for King's shortest path rings [h, i] - homopolar bond(s) do not affect the search. => LOGICAL (.true. / .false.)
- (21) Look for Guttman's shortest path rings [j] - homopolar bond(s) do not affect the search. => LOGICAL (.true. / .false.)
- (22) Look for King's shortest path rings [h, i] - homopolar bond(s) can shortcut the rings. => LOGICAL (.true. / .false.)
- (23) Look for Guttman's shortest path rings [j] - homopolar bond(s) can shortcut the rings. => LOGICAL (.true. / .false.)
- (24) Look for primitive rings. [k, l, m]. => LOGICAL (.true. / .false.)
- (25) Look for strong rings [l]. => LOGICAL (.true. / .false.)
- (26) Positions of the barycenter of the rings.
- Create an input file for visualization using OpenDX.
=> LOGICAL (.true. / .false.)
- (27) Analysis of standard properties for atoms involved in rings:
- Inter-atomic distances in rings with n nodes.
- Bond angles in rings with n nodes.
- Dihedral angles in rings with n nodes.
- Coordination numbers in rings with n nodes.
- "Vis-a-vis" distances in rings with n nodes.
=> LOGICAL (.true. / .false.)
- (28) Advanced properties of the barycenter of the rings: => LOGICAL (.true. / .false.)
- (29) Advanced properties of the atoms involved in rings 1:
Neutron structure factor of particles at the origin of rings with n nodes ***
=> LOGICAL (.true. / .false.)
- (30) Advanced properties of the atoms involved in rings 2: => LOGICAL (.true. / .false.)

- (31) Advanced properties of the rings:
- Average neutron structure factors of a ring with n nodes ***

=> LOGICAL (.true. / .false.)
** Computations can be performed using the Faber-Ziman [c], as well as the Ashcroft-Langreth [d, e, f] formalisms.
*** Computations can be performed using the Faber-Ziman [c], the Ashcroft-Langreth [d, e, f] as well as the Bhatia-Thornton [g] formalisms.
(32) Void statistics. => LOGICAL (.true. / .false.)
(33) Evaluation and output of g(r), s(q), ... for each configuration. => LOGICAL (.true. / .false.)
(34) OpenDX visualization file options - default color map is the atomic mass => LOGICAL (.true. / .false.)
- (35) Use atomic radius given in the 'input' file as color map => LOGICAL (.true. / .false.)
- (36) Use the connectivity factor Fc [b] as color map. => LOGICAL (.true. / .false.)
- (37) Use Fc [b] as color map. => LOGICAL (.true. / .false.)
- (38) Add voids positions and sizes in an OpenDX visualization file. => LOGICAL (.true. / .false.)
- (39) Visualization of the tetrahedral environments using OpenDX => LOGICAL (.true. / .false.)
(40) Visualization of the trajectories of the particles of highest MSD => LOGICAL (.true. / .false.)
(41) Name of the global output file. => CHARACTER (LEN=50)

 

a
P. Salmon.
J. Non-Cryst. Solids.., 353:2959-2974, (2007).
b
S. Le Roux.
Ph.D. thesis (2008).
c
T. E. Faber and Ziman J. M.
Phil. Mag., 11(109):153-173 (1965).
d
N. W. Ashcroft and D. C. Langreth.
Phys. Rev., 156(3):685-692 (1967).
e
N. W. Ashcroft and D. C. Langreth.
Phys. Rev., 159(3):500-510 (1967).
f
N. W. Ashcroft and D. C. Langreth.
Phys. Rev., 166(3):934 (1968).
g
A. B. Bhatia and D. E. Thornton.
Phys. Rev. B, 2(8):3004-3012 (1970).
h
S. V. King.
Nature, 213:1112 (1967).
i
D. S. Franzblau.
Phys. Rev. B, 44(10):4925-4930 (1991).
j
L. Guttman.
J. Non-Cryst. Solids., 116:145-147 (1990).
k
K. Goetzke and H. J. Klein.
J. Non-Cryst. Solids., 127:215-220 (1991).
l
X. Yuan and A. N. Cormack.
Comp. Mat. Sci., 24:343-360 (2002).
m
F. Wooten.
Acta Cryst. A, 58(4):346-351 (2002).
Last Updated on Tuesday, 01 March 2016 11:29  

 Latest version

RINGS Last version logo
A new version of the RINGS code has been released !

 Mailing List

Mailing list
Join the RINGS code mailing list !

 Hosted by

Get rings-code at SourceForge.net. Fast, secure and Free Open Source software downloads