Skip to content

Commit 31cd0bb

Browse files
committed
Moving directory tree one level higher.
1 parent 57f1079 commit 31cd0bb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+8344
-13013
lines changed

doc/README

Lines changed: 51 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,52 @@
1-
## ##### ## ##### ## ##
2-
/#### /##### /## /##### /## /####
3-
/ ### // / / ### // / / ### / ###
4-
/## / / / ### / / / ### /##
5-
/ ## / / ### / / ### / ##
6-
/ ## ## ## ## ## ## ## / ##
7-
/ ## ## ## ## ## ## ## / ##
8-
/ ## ## ## ## ## ## ## / ##
9-
/ ## ## ## ## ## ## ## / ##
10-
/######## ## ## ## ## ## ## /########
11-
/ ## # ## ## # ## ## / ##
12-
# ## / / / / # ##
13-
/#### ## /###/ / /###/ / /#### ##
14-
/ #### ## / / ########/ / ########/ / #### ## /
15-
/ ## #/ / #### / #### / ## #/
16-
# # # #
17-
## ## ## ##
18-
19-
20-
21-
Maxim A. Yurkin
22-
23-
Institute of Chemical Kinetics and Combustion,
24-
Siberian Branch of the Russian Academy of Sciences,
25-
Institutskaya 3, Novosibirsk, 630090, Russia,
26-
tel: +7-383-333-3240, fax: +7-383-334-2350
27-
28-
Alfons G. Hoekstra
29-
30-
Faculty of Science, Section Computational Science,
31-
of the University of Amsterdam,
1+
ADDA 0.73
2+
*********
3+
"Amsterdam DDA"
4+
5+
Maxim A. Yurkin(1,2) and Alfons G. Hoekstra(1)
6+
7+
(1) Faculty of Science, Section Computational Science,
8+
of the University of Amsterdam,
329
Kruislaan 403, 1098 SJ, Amsterdam, The Netherlands,
3310
tel: +31-20-525-7530, fax: +31-20-525-7490
3411

35-
36-
37-
38-
$Date:: $
39-
40-
Copyright (C) 2006-2008 University of Amsterdam
12+
(2) Institute of Chemical Kinetics and Combustion,
13+
Siberian Branch of the Russian Academy of Sciences,
14+
Institutskaya 3, Novosibirsk 630090 Russia,
15+
tel: +7-3832-333240, fax: +7-3832-342350
16+
17+
18+
19+
last revised: 28 February 2006
20+
21+
Copyright (C) 2006 M.A. Yurkin and A.G. Hoekstra
4122
This software package is covered by the GNU General Public License.
4223

24+
1. INTRODUCTION
25+
***************
4326

44-
45-
1. INTRODUCTION
46-
***************
47-
48-
ADDA is a C software package to calculate scattering and absorption of
49-
electromagnetic waves by particles of arbitrary geometry using the Discrete
50-
Dipole Approximation (DDA). In this approximation the volume of the scatterer
27+
ADDA is a C software package to calculate scattering and absorption of
28+
electromagnetic waves by particles of arbitrary geometry using the Discrete
29+
Dipole Approximation (DDA). In this approximation the volume of the scatterer
5130
is divided into small cubical subvolumes ("dipoles"), interaction of which is
5231
considered approximately based on the integral equation for the electric field.
5332
Initially DDA (sometimes referred to as the "coupled dipole approximation") was
5433
proposed replacing the scatterer by a set of point dipoles (hence the name of
55-
the technique).
34+
the technique).
5635

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

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

8260

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

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

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

10580
We also strongly encourage you to send email to the authors identifying
@@ -110,50 +85,43 @@ bugs, corrections, or improvements in ADDA.
11085
3. OBTAINING THE SOURCE CODE
11186
****************************
11287

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

11793
doc/ - documentation
11894
copyleft - GNU General Public License
11995
history - complete history of ADDA development
120-
faq - frequently asked questions
121-
manual.doc - source of User Manual in MS Word format
122-
manual.pdf - user Manual for ADDA in PDF format
123-
README - this file
124-
todo.xls - source of the todo list in MS Excel format
125-
todo.pdf - todo list in PDF format
96+
manual.pdf - User Manual for ADDA in PDF format.
97+
readme - this file
12698
input/ - default input files
12799
tables/ - 10 auxiliary files with tables of integrals
128100
alldir_params.dat - parameters for integral scattering quantities
129101
avg_params.dat - parameters for orientation averaging
130102
scat_params.dat - parameters for grid of scattering angles
131-
misc/ - additional files, not supported by the authors.
132103
sample/ - sample output and other files
133104
run000_sphere_g16m1_5/ - sample output directory, contains "log", "mueller",
134105
and "CrossSec-Y".
135-
test.pbs - sample PBS script for MPI system
136-
test.sge - sample SGE script for MPI system
106+
batch - sample PBS script for MPI system
137107
stdout - stdout of a sample simulation
138108
src/
139109
Makefile, make_seq, make_mpi - makefiles
140-
ADDAmain.c, CalculateE.c, calculator.c, cmplx.h, const.h, crosssec.c/h,
141-
comm.c/h, debug.c/h, fft.c, function.h, GenerateB.c, io.c/h, iterative.c,
142-
make_particle.c, matvec.c, memory.c/h, os.h, param.c/h, parbas.h,
143-
prec_time.c/h, Romberg.c/h, sinint.c, timing.c/h, types.h, vars.c/h
110+
ADDAmain.c, CalculateE.c, calculator.c, cmplx.h, const.h, crosssec.c/h,
111+
comm.c/h, debug.c/h, fft.c, GenerateB.c, io.c/h, iterative.c, make_particle.c,
112+
matvec.c, memory.c/h, prec_time.c/h, Romberg.c/h, timing.c, types.h, vars.c/h
144113
- source and header files of ADDA
145-
cfft99D.f - source file for Temperton FFT
146-
mt19937ar.c/h - source and header files for Mersenne Twister random generator.
114+
cfft99D.f - source file for Temperton FFT
147115

148116

149-
4. COMPILING AND LINKING
150-
************************
117+
4. COMPILING AND LINKING
118+
************************
151119

152-
On Unix systems, while positioned in src/, type
120+
On Unix systems, while positioned in src/, type
153121
> make seq
154-
or
122+
or
155123
> make mpi
156-
for sequential and MPI versions respectively. By default you need FFTW to be
124+
for sequential and MPI versions respectively. By default you need FFTW to be
157125
installed (www.fftw.org) on your system.
158126

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

0 commit comments

Comments
 (0)