~ubuntu-branches/ubuntu/maverick/atlc/maverick

« back to all changes in this revision

Viewing changes to docs/html-docs/atlc.1.html

  • Committer: Bazaar Package Importer
  • Author(s): Bdale Garbee
  • Date: 2005-06-03 04:53:28 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050603045328-pohnuy5yryiv9s6o
Tags: 4.6.0-1
* new upstream version
* move make check from binary to build target so it doesn't run as root
* lose --with-threads from configure call, since it causes regression suite
  to fail many tests and upstream's README.threads is discouraging
* various tweaks to make lintian happier

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<HTML>
2
 
<HEAD>
3
 
<meta name="generator" content="HTML Tidy, see www.w3.org">
4
 
<meta name="GENERATOR" content="Bluefish 0.6 and vi on a Sun SPARCstation 20">
5
 
<meta name="Reply-to" content="drkirkby@ntlworld.com">
6
 
<meta name="KEYWORDS" content="transmission lines, tranmission line, CAD, electrical, atlc, impedance, Z0, transmission, line, lines, arbitrary, cross, section, shape, Zo">
7
 
<meta name="DESCRIPTION" content="A finite difference program for computing the  properties of any transmission line ">
8
 
<title>atlc - Arbitrary Transmission Line Calculator</title>
9
 
</HEAD>
10
2
<BODY>
11
3
<PRE>
12
4
<!-- Manpage converted by man2html 3.0.1 -->
19
11
</PRE>
20
12
<H2>SYNOPSIS</H2><PRE>
21
13
     <B>atlc</B>  <B>[-C]</B> <B>[-s]</B> <B>[-S]</B> <B>[-v]</B> <B>[-c</B>  <B>cutoff]</B>  <B>[-d</B>  <B>rrggbb=Er]</B>  <B>[-i</B>
22
 
     <B>factor]</B> <B>[-t</B> <B>threads]</B> <B>[-r</B> <B>rate_multiplier]</B> <B>bitmapfile</B>
 
14
     <B>factor]</B>  <B>[-i</B>  <B>prefix]</B> <B>[-t</B> <B>threads]</B> <B>[-r</B> <B>rate_multiplier]</B> <B>bit-</B>
 
15
     <B>mapfile</B>
23
16
 
24
17
 
25
18
</PRE>
26
19
<H2>WARNING</H2><PRE>
27
 
     This man page is not a complete set  of  documentation.  See
28
 
     the  html  files for more complete information. So far, I've
29
 
     not managed to install the html files  into  /usr/local,  so
30
 
     you  will  have  to  look into the atlc-X.Y.Z/docs/html-docs
31
 
     directory for them.
 
20
     This man page is not a complete set of documentation  -  the
 
21
     complexity  of the atlc project makes man pages not an ideal
 
22
     way to document it, although out of completeness, man  pages
 
23
     are produced. The best documentation that was current at the
 
24
     time the version was produced should be found on  your  hard
 
25
     drive, usually at
 
26
     /usr/local/share/atlc/docs/html-docs/index.html
 
27
     although it might be elsewhere if your system  administrator
 
28
     chose  to  install  the package elsewhere. Sometimes, errors
 
29
     are  corrected  in   the   documentation   and   placed   at
 
30
     http://atlc.sourceforge.net/ before a new release of atlc is
 
31
     released.  Please, if you notice a problem with the documen-
 
32
     tation - even spelling errors and typos, please let me know.
 
33
 
32
34
 
33
35
 
34
36
</PRE>
35
37
<H2>DESCRIPTION</H2><PRE>
36
 
     <B>atlc</B> is a finite difference programme that is used to calcu-
 
38
     <B>atlc</B> is a finite difference program that is used  to  calcu-
37
39
     late  the properties of a two-conductor electrical transmis-
38
40
     sion line of arbitrary cross section. It  is  used  whenever
39
41
     there are no analytical formula known, yet you still require
41
43
        The impedance Zo  (in Ohms)
42
44
        The capacitance per unit length (pF/m)
43
45
        The inductance per unit length (nF/m)
44
 
        The velocity of propogation v (m/s)
 
46
        The velocity of propagation v (m/s)
45
47
        The velocity factor, v/c, which is dimensionless.
46
48
 
47
49
     A bitmap file (usually with the extension .bmp or  .BMP)  is
48
50
     drawn  in  a  graphics  package  such as <B>Gimp</B> available from
49
51
     http://www.gimp.org. The bitmap file <B>must</B> be saved as a  24-
50
 
     bit  (16 million colour) uncompressed file. The colours used
 
52
     bit  (16,777,216 colour) uncompqessed file. The colours used
51
53
     in the bitmap indicate whether the  region  is  a  conductor
52
54
     (pure  red,  pure  green or pure blue) or a dielectric (any-
53
55
     thing else). Pure white is assumed to be  a  vacuum  dielec-
54
 
     tric,  but other colours have diferent meanings. See COLOURS
 
56
     tric, but other colours have different meanings. See COLOURS
55
57
     below for precise definitions of the colours.
56
58
 
57
59
 
58
60
</PRE>
59
61
<H2>OPTIONS</H2><PRE>
60
62
     <B>-C</B>
61
 
     print copyright, licencing and copying information.
 
63
     print copyright, licensing and copying information.
62
64
     <B>-s</B>
63
65
     Skip writing the Ex, Ey, E, V, U and Er bitmap (.bmp)  files
64
66
     <B>-S</B>
67
69
     makes the output more verbose/talkative.
68
70
     <B>-c</B> <B>cutoff</B>
69
71
     Sets the convergence criteria of the finite difference  pro-
70
 
     gramme.  The  default is 0.0001, meaning two separate itera-
71
 
     tions must be within 01% for the programme to  stop  iterat-
72
 
     ing.  Setting  to a smaller positive number gives more accu-
73
 
     racy, but takes longer.
 
72
     gram. The default is 0.0001, meaning two separate iterations
 
73
     must be within 01% for the program to stop  iterating.  Set-
 
74
     ting  to  a smaller positive number gives more accuracy, but
 
75
     takes longer.
74
76
 
75
77
     <B>-d</B> <B>rrggbb=Er</B>
76
78
     is used to indicate the colour 0xrrggbb  in  the  bitmap  is
85
87
     <B>-r</B> <B>ratemultiplier</B>
86
88
     Sets the parameter 'r' used internally  when  computing  the
87
89
     voltage  at  a point w,h.  The default, which is (as of ver-
88
 
     sion 3.0.0) 1.95, results in what is belived to  be  optimal
 
90
     sion 3.0.0) 1.95, results in what is believed to be  optimal
89
91
     results.  Setting to 1.0 will avoid the use of the fast con-
90
92
     vergence method, which is generally not a good idea.
91
93
 
92
 
     <B>-t</B> <B>threads</B>
93
 
     tells atlc to run using that number  of  threads,  to  speed
94
 
     calculation.  This option is only valid if atlc was compiled
95
 
     with the --with-threads option to  configure.  The  pthreads
96
 
     library  (or  similar) <B>must</B> be installed in order to compile
97
 
     with support for more than one CPU. Generally,  setting  the
98
 
     number  of threads to the number of cpus is a good idea, but
99
 
     it is worth experimenting. The number can  be  changed  per-
100
 
     manently   by   editing   the   parameter   MAX_THREADS   in
101
 
     definitions.h.
 
94
     <B>-p</B> <B>prefix</B>
 
95
     Adds 'prefix', which is usually a directory name,  in  front
 
96
     of the output files.
102
97
 
103
98
 
104
99
</PRE>
107
102
     represent  the  amount  of  red, 8 for blue and 8 for green.
108
103
     Hence there are 256 levels of red, green and blue, making  a
109
104
     total of 256*256*256=16777216 colours. Every one of the pos-
110
 
     sible i16777216 colours can  be  defined  precisely  by  the
111
 
     stating the exact amount of red, green and blue, as in:
 
105
     sible 16777216 colours can be defined precisely by the stat-
 
106
     ing the exact amount of red, green and blue, as in:
112
107
 
113
108
     red         = 255,000,000 or 0xff0000
114
109
     green       = 000,255,000 or 0x00ff00
118
113
     Brown       = 255,000,255 or 0xff00ff
119
114
     gray        = 142,142,142 or 0x8e8e8e
120
115
 
121
 
     Some colours, such as pink, terquiose,  sandy,  brown,  gray
122
 
     etc  may mean slightly different things to different prople.
123
 
     This is not so with  atlc,  as  the  programme  expects  the
124
 
     colours  below  to  be exactly defined as given. Whether you
125
 
     feel the colour is sandy or yellow is up to you, but if  you
126
 
     use  it  in your bitmap, then it either needs to be a colour
127
 
     reconised by atlc, <B>or</B> you <B>must</B> define it with a command line
128
 
     option (see OPTIONS).
 
116
     Some colours, such as pink, turquiose,  sandy,  brown,  gray
 
117
     etc  may mean slightly different things to different people.
 
118
     This is not so with atlc, as the program expects the colours
 
119
     below  to  be exactly defined as given. Whether you feel the
 
120
     colour is sandy or yellow is up to you, but if you use it in
 
121
     your  bitmap,  then it either needs to be a colour reconised
 
122
     by atlc, <B>or</B> you <B>must</B> define it with a  command  line  option
 
123
     (see OPTIONS).
129
124
     red    = 255,000,000 or 0xFF0000 is the live conductor.
130
125
     green  = 000,255,000 or 0x00FF00 is the grounded conductor.
131
126
     blue   = 000,000,255 or 0x0000FF is the negative conductor
132
127
 
133
128
     All bitmaps <B>must</B> have the live (red)  and  grounded  (green)
134
129
     conductor. The blue conductor is used to indicate a negative
135
 
     conductor, is needed when the programme is used  to  analyse
 
130
     conductor, is needed when the program  is  used  to  analyse
136
131
     directional couplers.
137
132
 
138
 
     The following dielectrics are recognised by atlc<B>:</B>
 
133
     The following dielectrics are reconised by atlc<B>:</B>
139
134
 
140
135
     white     255,255,255 or 0xFFFFFF as Er=1.0    (vacuum)
141
136
     pink      255,202,202 or 0xFFCACA as Er=1.0006 (air)
146
141
     sandy     239,203,027 or 0xEFCC1A as Er=3.3    (PVC)
147
142
     brown     188,127,096 or 0xBC7F60 as Er=3.335  (epoxy resin)
148
143
     L. yellow 223,247,136 or 0xDFF788 as Er=3.7    (FR4 PCB)
149
 
     Terquoise 026,239,179 or 0x1AEFB3 as Er=4.8    (glass PCB)
 
144
     Turquoise 026,239,179 or 0x1AEFB3 as Er=4.8    (glass PCB)
150
145
     Dark gray 142,142,142 or 0x696969 as Er=6.15   (duroid 6006)
151
146
     L. gray   240,240,240 or 0xDCDCDC as Er=10.2  (duroid 6010)
152
147
     D. orange 213,160,067 or 0xD5A04D as  Er=100.0  (mainly  for
156
151
</PRE>
157
152
<H2>EXAMPLES</H2><PRE>
158
153
     Here are a few examples of the use of atlc. Again,  see  the
159
 
     html documentation in atlc-X.Y.Z9ocsl-docs for for examples.
 
154
     html documentation in atlc-X.Y.Z9ocsl-docs, the documentation
 
155
     on         your         system         (normally          at
 
156
     /usr/local/share/atlc/docs/html-docs/index.html  ) or online
 
157
     at http://atlc.sourceforge.net for examples.
160
158
 
161
159
     <B>ex_1</B> <B>%</B> <B>atlc</B> <B>coax2.bmp</B>
162
160
     This is a simple example (ex_1), in which the geometry of  a
165
163
     2.33,  2.5,  3.3,  3.335, 3.7, 4.8, 6.15 or 10.2) could have
166
164
     been used in the bitmap, which would have been done with one
167
165
     of  13  different colours. white (0xFFFFFF) for Er=1.0, pink
168
 
     (0xFFCACA) for 1.0006 etc.  No other colour(dilectric) could
169
 
     have  been  used,  since  it  was  not specified with the -d
 
166
     (0xFFCACA) for 1.0006 etc.   No  other  colour  (dielectric)
 
167
     could have been used, since it was not specified with the -d
170
168
     option.
171
169
 
172
170
     <B>ex_2</B> <B>%</B> <B>atlc</B> <B>-d</B> <B>f9e77d=2.43</B> <B>somefile.bmp</B>
173
 
     In ex_2, a dielectic with Er=2.43 was wanted. A colour  with
 
171
     In ex_2, a dielectric with Er=2.43 was wanted. A colour with
174
172
     the  RGB  values  of  0xF9E7&amp;d was used. The -d option tells
175
173
     atlc what Er this colour refers to.
176
174
 
177
 
     <B>ex_3</B> <B>%</B> <B>atlc</B> <B>-v</B> <B>.bmp</B> <B>coax2.bmp</B>
 
175
     <B>ex_3</B> <B>%</B> <B>atlc</B> <B>-v</B> <B>coax2.bmp</B>
178
176
     In ex_3, atlc has been instructed to print  the  results  of
179
177
     intermediate  calculations  to  stdout.   Normally, only the
180
 
     final result is printed.
181
 
 
 
178
     final result is printed. Using -vv even more information may
 
179
     be produced, but this is really of only use to the developer
 
180
     of the project.
182
181
 
183
182
 
184
183
</PRE>
226
225
     <B>create_bmp_for_stripline_coupler(1)</B>
227
226
     <B>create_bmp_for_symmetrical_stripline(1)</B>    <B>design_coupler(1)</B>
228
227
     <B>find_optimal_dimensions_for_microstrip_coupler(1)</B> <B>readbin(1)</B>
 
228
 
229
229
     http://atlc.sourceforge.net                - Home page
230
230
     http://sourceforge.net/projects/atlc       - Download area
231
231
     atlc-X.Y.Z/docs/html-docs/index.html       - HTML docs
232
232
     atlc-X.Y.Z/docs/qex-december-1996/atlc.pdf - theory paper
233
233
     atlc-X.Y.Z/examples                        - examples
234
 
     http://www.david-kirkby.co.uk              - my home page
235
 
     http://www.david-kirkby.co.uk/ham          - ham radio pages
 
234
 
 
235
 
 
236
 
 
237
 
 
238
 
 
239
 
 
240
 
 
241
 
 
242
 
 
243
 
 
244
 
 
245
 
 
246
 
 
247
 
 
248
 
 
249
 
 
250
 
 
251
 
 
252
 
 
253
 
 
254
 
 
255
 
 
256
 
 
257
 
 
258
 
 
259
 
 
260
 
 
261
 
 
262
 
 
263
 
 
264
 
 
265
 
 
266
 
 
267
 
 
268
 
 
269
 
 
270
 
 
271
 
 
272
 
 
273
 
 
274
 
 
275
 
 
276
 
 
277
 
 
278
 
 
279
 
 
280
 
236
281
 
237
282
 
238
283
</PRE>