Interspectus — INTERpolation of SPECTra Using Sum rules
The code interspectus, described in the article Phys. Rev. B 79, 094102 (2009), performs the interpolation between positive-definite spectra that obey a sum rule. Examples are the spectra of electron energy-loss spectroscopy for varying momentun transfer or the absorption spectra of nanocrystals with varying size. For a description of the interpolation method, please refer to the above-mentioned article. For any work in which the code has been used, please cite this article. The code comes in both fortran and python versions. Both come with lots of explanations and examples. Both are free software.
Fortran Version
The code interspectus, described in the article Phys. Rev. B 79, 094102 (2009), performs the interpolation between positive-definite spectra that obey a sum rule. A tar package of the code is available HERE . Spectra to be interpolated must be positive-definite, and they must follow a common sum rule. For a description of the interpolation method, please refer to the above-mentioned article. Here we describe the code and its functionality. For any work in which the code has been used, please cite this article.
Files to work with: The code needs the two input files input.pars and input.files to specify the general parameters of the calculation as well as the names the respective parameter values of the input data files. For a description please see the example files which are extensively commented. Moreover, the file sum_rule.f90 must be adjusted to use the correct sum rule and scaling (see below). Unfortunately, the code has to be recompiled after that.
The input data files that contain the spectra between which we want to interpolate have to be in two-column form (ω,f(ω)) Their names must be specified in “input.files”. They need not all contain the same number of lines. However, the inputs need to be non-negative everywhere, and they have to start at ω=0. (However, equal spacing along the ω axis is not necessary.) If portions of the spectra are exactly zero (as for instance in the case of a Gaussian model curve, due to the fast decrease of the function) problems can arise because the inverted integrals are then not monotonous. A small constant can be added or a small broadening applied to the spectra which solves the problem.
The output data files that contain the spectra created by the interpolation are likewise in two-column form (ω,f(ω)) Their names are given by the root that is specified in “input.files” with the corresponding parameter value appended.
Examples
The tar package comes with two example inputs (input files, input data files, and sum_rule.f90 adjusted to the examples) in order to show how it works. The two examples are (i) a linear interpolation between two Lorentz curves, with an additional given curve for comparison, and (ii) the realistic example of the energy-loss function of silicon for finite momentum transfers, set up to work with three inputs, while two more are provided for comparison. The examples are precisely the results reported in Figs. 3 and 10 of the manuscript.
In order to run the code for the example inputs, copy the input files from the example directory to the directory where the code is (don't forget that the sum_rule.f90 has to be correct and the code then recompiled after any change of the file, cf. next section). In the original package, this is the SRC directory which contains already the EELS example. After (re)compiling the code, you can start to play with the examples.
Specification of the sum rule — the file sum_rule.f90
The correct sum rule must be entered in the file sum_rule.f90. The program treats the sum rule as given in equation (2) of the article. Sum rules of the form of equation (3) have to be brought to form (2) by the transformation necessary to transform the quantity in question to the quantity that obeys the sum rule, and by scaling according to the C(q). An example is the dynamic structure factor of Eq. (4). This equation can be brought into the form of Eq. (2) by the transformation f(q,ω) = 2 S(q,ω) * ω / q^2. The inverse of this transformation (which depends on the respective parameter value q) has to be applied to the outputs before they are written out.
This is done using the function “sum_rule_func” which is defined in the file “sum_rule.f90”. This function does the transformation in order to make the inputs into f(q,ω), while “sum_rule_func_inv“ in the same file contains the inverse of this function. Useful examples are (already given in fortran notation; they can be used directly in the program):
- If the inputs obey already the sum rule in the form Eq. (2), we don't have to do anything and just enter the equality:
sum_rule_func = f
sum_rule_func_inv = f
- The case of the electron energy-loss function:
sum_rule_func = f*omega
in which case the inverse transformation issum_rule_func_inv = f /(omega+.0000000001)
(The added small constant avoids the division by zero at ω=0). A more complex example is the case of the dielectric function of a Ge-Si alloy. We can use the screening sum rule Eq. (6) as well as the interpolation for ε∞ = (16.2 - 4.5 * x) that characterizes the dependence on the composition (here q stands for the composition x).
sum_rule_func = f /(omega+.000001) / (16.2 - 4.5 * q)
sum_rule_func_inv = f *(omega) * (16.2 - 4.5 * q)
Compilation
The code needs the gsl library as well as the cblas. It is written in FORTAN 90 with a wrapper to use the gsl which is in C. The parser used for the input file has been taken from the DP code. The FORTRAN as well as the C compiler need to be specified in the makefile (presently set to ifort and cc). Compilation will make the executable interspectus.x. Please DO NOT FORGET TO CHANGE THE SUM RULE ACCORDING TO YOUR PROBLEM!
The code in the directory SRC is already set up (file sum_rule.f90 and input files input.pars and input.files) to work with the example in the Examples/EELS directory. The respective input files tdlda* are also in the SRC directory even though they do not belong to the source files.
Licence
The code is released under the GNU General Public License version 2.
Hans-Christian Weissker, 02/2009
Python Version
This module is a Python transcript of the Fortran code of Hans-Christian Weissker explained above.
Download the attached tar-file and extract the content using tar -xvf interspectus_r46.tar
. Remember to add the install path to the shell variable PYTHONPATH
. Examples are included at the end of each file and can be executed using python <file>.
Prerequisites
- Python (>2.6)
- Python modules: numpy, scipy, matplotlib
- (suggested) DPio-module
Copyright (c) 2011, Ralf Hambach, Hans-Christian Weissker. All rights reserved. See LICENSE file for use of this source code (BSD license, open source).