Skip to content

Commit

Permalink
Moving directory tree one level higher.
Browse files Browse the repository at this point in the history
  • Loading branch information
@myurkin
myurkin committed Nov 24, 2008
1 parent 57f1079 commit a97374f
Show file tree
Hide file tree
Showing 65 changed files with 8,533 additions and 12,429 deletions.
153 changes: 71 additions & 82 deletions doc/README
View file
Original file line number Diff line number Diff line change
@@ -1,73 +1,72 @@
## ##### ## ##### ## ##
/#### /##### /## /##### /## /####
/ ### // / / ### // / / ### / ###
/## / / / ### / / / ### /##
/ ## / / ### / / ### / ##
/ ## ## ## ## ## ## ## / ##
/ ## ## ## ## ## ## ## / ##
/ ## ## ## ## ## ## ## / ##
/ ## ## ## ## ## ## ## / ##
/######## ## ## ## ## ## ## /########
/ ## # ## ## # ## ## / ##
# ## / / / / # ##
/#### ## /###/ / /###/ / /#### ##
/ #### ## / / ########/ / ########/ / #### ## /
/ ## #/ / #### / #### / ## #/
# # # #
## ## ## ##



Maxim A. Yurkin

Institute of Chemical Kinetics and Combustion,
Siberian Branch of the Russian Academy of Sciences,
Institutskaya 3, Novosibirsk, 630090, Russia,
tel: +7-383-333-3240, fax: +7-383-334-2350

Alfons G. Hoekstra

Faculty of Science, Section Computational Science,
of the University of Amsterdam,
ADDA 0.74
*********
"Amsterdam DDA"

Maxim A. Yurkin(1,2) and Alfons G. Hoekstra(1)

(1) Faculty of Science, Section Computational Science,
of the University of Amsterdam,
Kruislaan 403, 1098 SJ, Amsterdam, The Netherlands,
tel: +31-20-525-7530, fax: +31-20-525-7490


email: [email protected]

$Date:: $

Copyright (C) 2006-2008 University of Amsterdam
(2) Institute of Chemical Kinetics and Combustion,
Siberian Branch of the Russian Academy of Sciences,
Institutskaya 3, Novosibirsk 630090 Russia,
tel: +7-3832-333240, fax: +7-3832-342350

email: [email protected], [email protected]

last revised: 28 March 2006

Copyright (C) 2006 M.A. Yurkin and A.G. Hoekstra
This software package is covered by the GNU General Public License.



1. INTRODUCTION
***************

ADDA is a C software package to calculate scattering and absorption of
electromagnetic waves by particles of arbitrary geometry using the Discrete
Dipole Approximation (DDA). In this approximation the volume of the scatterer
## ##### ## ##### ## ##
/#### /##### /## /##### /## /####
/ ### // / / ### // / / ### / ###
/## / / / ### / / / ### /##
/ ## / / ### / / ### / ##
/ ## ## ## ## ## ## ## / ##
/ ## ## ## ## ## ## ## / ##
/ ## ## ## ## ## ## ## / ##
/ ## ## ## ## ## ## ## / ##
/######## ## ## ## ## ## ## /########
/ ## # ## ## # ## ## / ##
# ## / / / / # ##
/#### ## /###/ / /###/ / /#### ##
/ #### ## / / ########/ / ########/ / #### ## /
/ ## #/ / #### / #### / ## #/
# # # #
## ## ## ##


1. INTRODUCTION
***************

ADDA is a C software package to calculate scattering and absorption of
electromagnetic waves by particles of arbitrary geometry using the Discrete
Dipole Approximation (DDA). In this approximation the volume of the scatterer
is divided into small cubical subvolumes ("dipoles"), interaction of which is
considered approximately based on the integral equation for the electric field.
Initially DDA (sometimes referred to as the "coupled dipole approximation") was
proposed replacing the scatterer by a set of point dipoles (hence the name of
the technique).
the technique).

ADDA is a C implementation of the DDA developed by the authors. The
development has been conducted by Hoekstra and coworkers for more than 10 years
at the University of Amsterdam. From the very beginning the code was intended to
run on a multiprocessor system (parallelizing a single DDA simulation). Recently
the code was significantly rewritten and improved by Yurkin. ADDA is intended to
be a versatile tool, suitable for a wide variety of applications ranging from
development was conducted by Hoekstra and coworkers for more than 10 years in
University of Amsterdam. From the very beginning the code was intended to run on
a multiprocessor system (parallelizing a single DDA simulation). Recently the
code was significantly rewritten and improved by Yurkin. ADDA is intended to be
a versatile tool, suitable for a wide variety of applications ranging from
interstellar dust and atmospheric aerosols to biological particles; its
applicability is limited only by available computer resources. As provided, ADDA
should be usable for many applications without modification, but the program is
written in a modular form, so that modifications, if required, should be fairly
straightforward.
straightforward.

Detailed instructions for using ADDA and all relevant issues are contained in
the User Manual for ADDA. The User Manual is in the file "manual.pdf" in PDF
Detailed instructions for using ADDA and all relevant issuse are contained in
the User Manual for ADDA. The User Manual is in the file "manual.pdf" in PDF
format. It contains instructions for:
* compiling and linking the code;
* running a sample simulation;
Expand All @@ -77,7 +76,6 @@ format. It contains instructions for:
* specifying what scattering quantities should be calculated;
* understanding the computational aspects and timing of the code;
* understanding the command line options and formats of input and output files.
* modifying the source code for added functionality


2. AVAILABILITY
Expand All @@ -86,11 +84,8 @@ format. It contains instructions for:
The authors make this code openly available to others, in the hope that
it will prove to be a useful tool. We ask only that:

* If you publish results obtained using ADDA, you should acknowledge the source
of the code. We recommend the following general reference:
M. A. Yurkin, V. P. Maltsev, and A.G. Hoekstra, "The discrete dipole
approximation for simulation of light scattering by particles much larger than
the wavelength", J. Quant. Spectros. Radiat. Transf. 106, 546-557 (2007).
* If you publish results obtained using ADDA, please consider acknowledging the
source of the code.

* If you discover any errors in the code, please promptly communicate them to
the authors.
Expand All @@ -99,7 +94,7 @@ it will prove to be a useful tool. We ask only that:
Public License) of the Free Software Foundation: you may copy, distribute,
and/or modify the software identified as coming under this agreement. If
you distribute copies of this software, you must give the recipients all the
rights which you have. See the file "copyleft" distributed with the ADDA
rights which you have. See the file "copyleft" distributed with the ADDA
software.

We also strongly encourage you to send email to the authors identifying
Expand All @@ -110,50 +105,44 @@ bugs, corrections, or improvements in ADDA.
3. OBTAINING THE SOURCE CODE
****************************

The recent version can be downloaded from:
http://www.science.uva.nl/research/scs/Software/adda/
The package contains the following:
We are currently working to make a www page for ADDA, where it will be
possible to download it. Currently, the latest version of ADDA can be obtained
by sending a request to the authors: [email protected]. The package contains
the following:

doc/ - documentation
copyleft - GNU General Public License
history - complete history of ADDA development
faq - frequently asked questions
manual.doc - source of User Manual in MS Word format
manual.pdf - user Manual for ADDA in PDF format
manual.pdf - User Manual for ADDA in PDF format.
README - this file
todo.xls - source of the todo list in MS Excel format
todo.pdf - todo list in PDF format
input/ - default input files
tables/ - 10 auxiliary files with tables of integrals
alldir_params.dat - parameters for integral scattering quantities
avg_params.dat - parameters for orientation averaging
scat_params.dat - parameters for grid of scattering angles
misc/ - additional files, not supported by the authors.
sample/ - sample output and other files
run000_sphere_g16m1_5/ - sample output directory, contains "log", "mueller",
and "CrossSec-Y".
test.pbs - sample PBS script for MPI system
test.sge - sample SGE script for MPI system
batch - sample PBS script for MPI system
stdout - stdout of a sample simulation
src/
Makefile, make_seq, make_mpi - makefiles
ADDAmain.c, CalculateE.c, calculator.c, cmplx.h, const.h, crosssec.c/h,
comm.c/h, debug.c/h, fft.c, function.h, GenerateB.c, io.c/h, iterative.c,
make_particle.c, matvec.c, memory.c/h, os.h, param.c/h, parbas.h,
prec_time.c/h, Romberg.c/h, sinint.c, timing.c/h, types.h, vars.c/h
ADDAmain.c, CalculateE.c, calculator.c, cmplx.h, const.h, crosssec.c/h,
comm.c/h, debug.c/h, fft.c, GenerateB.c, io.c/h, iterative.c, make_particle.c,
matvec.c, memory.c/h, param.c/h, prec_time.c/h, Romberg.c/h, timing.c,
types.h, vars.c/h
- source and header files of ADDA
cfft99D.f - source file for Temperton FFT
mt19937ar.c/h - source and header files for Mersenne Twister random generator.
cfft99D.f - source file for Temperton FFT


4. COMPILING AND LINKING
************************
4. COMPILING AND LINKING
************************

On Unix systems, while positioned in src/, type
On Unix systems, while positioned in src/, type
> make seq
or
or
> make mpi
for sequential and MPI versions respectively. By default you need FFTW to be
for sequential and MPI versions respectively. By default you need FFTW to be
installed (www.fftw.org) on your system.

Please read the User Manual (manual.pdf).
Loading

0 comments on commit a97374f

Please sign in to comment.