Imported Upstream version 4.6.0
[debian/atlc] / man / man1 / create_bmp_for_circ_in_circ.1
1 .TH create_bmp_for_circ_in_circ 1 "atlc-4.4.2 10th Sept 2003" "Dr. David Kirkby"
2 .ds n 5
3 .SH NAME
4 \fBcreate_bmp_for_circ_in_circ\fR - bitmap generator for circular conductor inside circular conductor (part of \fBatlc\fR)
5 .SH SYNOPSIS
6 \fBcreate_bmp_for_circ_in_circ [options... ] D d O Er filename.bmp\fR
7 .br
8 .SH WARNING
9 This man page is not a complete set of documentation - the complexity of the atlc project makes man pages not an ideal way to document it, although out of completeness, man pages are produced. 
10 The best documentation that was current at the time the version was produced should be found on your
11 hard drive, usually at 
12 .br
13 /usr/local/share/atlc/docs/html\-docs/index.html 
14 .br
15 although it might be elsewhere if
16 your system administrator chose to install the package elsewhere. Sometimes, errors are corrected
17 in the documentation and placed at http://atlc.sourceforge.net/ before a new release of atlc is
18 released.  Please, if you notice a problem with the documentation - even spelling errors and typos,
19 please let me know. 
20
21 .SH DESCRIPTION
22 \fBcreate_bmp_for_circ_in_circ\fR is a pre-processor for \fBatlc\fR, the finite difference program that is used to calculate the 
23 properties of a two and three conductor electrical transmission line of arbitrary 
24 cross section. The program \fBcreate_bmp_for_circ_in_circ\fR is used as a fast way of
25 generating bitmaps (there is no need to use a graphics program), for a circular conductor inside a circular conductor (coaxial conductors), like this:
26
27 .P
28                     *****************
29 .br
30                 ****                 ****
31 .br
32              ****    <-----d------>     ****
33 .br
34            ***            *****            ***
35 .br
36          ***           ***********           ***
37 .br
38        ***            *************            ***
39 .br
40       ***            ***************            ***
41 .br
42      ***      ^      ***************             ***
43 .br
44     ***       |      ***************              ***
45 .br
46    ***        |       *************                ***
47 .br
48    **         O        ***********                  **
49 .br
50   ***         |            ***                      ***
51 .br
52   **          |                                      **
53 .br
54   *<------------------------D------------------------>*
55 .br
56   **                                                 **
57 .br
58   **                                                 **
59 .br
60   **                                                 **
61 .br
62   ***                                               ***
63 .br
64    **                                               **
65 .br
66    ***                                             ***
67 .br
68     **                                             **
69 .br
70      **                                           **
71 .br
72       **                                         **
73 .br
74        ***                                     ***
75 .br
76         ****                                 ****
77 .br
78           ****                             ****
79 .br
80             *****                       *****
81 .br
82                ******               ******
83 .br
84                    *******************
85 .br
86                            ***
87 .br
88 .P
89 The parameter 'D' is the inner dimensions of the outer conductor and 'd'
90 is the outer diameter of the inner conductor. 
91 The inner conductor is offset 'h' from the centre of the
92 outer conductor. The whole region is surrounded by a
93 dielectric of relative permittivity 'Er'. 
94 .PP 
95 .br
96 The bitmap is printed to 'outfile.bmp' - the last command line argument.
97 .P
98 .br
99 The bitmaps produced by \fBcreate_bmp_for_circ_in_circ\fR are 24-bit bit colour bitmaps, as are required by \fBatlc\fR. 
100
101 The permittivities of the dielectric 'Er' determines the
102 colours in the bitmap. If Er is 1.0, 1.006, 2.1, 2.2, 2.33, 2.5, 3.3,
103 3.335, 3,7, 4.8, 10.2 or 100, then the colour corresponding to that permittivity
104 will be set according to the colours defined in COLOURS below. If Er
105 is not one of those permittivities, the region of permittivity Er
106 will be set to the colour 0xCAFF00. The
107 program \fBatlc\fR does not know what this permittivity is, so 
108 \fBatlc\fR, must be told with the command line option -d, as in example 4
109 below.
110 .P
111 .SH OPTIONS
112 \fB-b bitmapsize\fR
113 .br
114 is used to set the size of the bitmap, and so the accuracy to which atlc
115 is able to calculate the transmission line's properties. The default
116 value for 'bitmapsize' is normally 4, although this is set at compile
117 time. The value can be set anywhere from 1 to 15, but more than 8 is
118 probably not sensible. 
119 .PP
120 \fB-f outfile\fR
121 .br
122 Set the output filename. By default, the bitmap is sent to stdout, but
123 it *must* be sent to a file, with this option, or as described above. 
124 .P
125 \fB-v \fR
126 .br
127 Causes \fBcreate_bmp_for_circ_in_circ\fR to print some data to stderr. Note, nothing
128 extra goes to standard output, as that is expected to be redirected to a
129 bitmap file.
130
131 .SH COLOURS
132 The 24-bit bitmaps that \fBatlc\fR expects, have 8 bits assigned 
133 to represent the amount of red, 8 for blue and 8 for green. Hence there are 
134 256 levels of red, green and blue, making a total of 256*256*256=16777216 colours. 
135 Every one of the possible 16777216 colours can be defined precisely by the stating the exact amount 
136 of red, green and blue, as in:
137 .PP
138 .br
139 red         = 255,000,000 or 0xff0000
140 .br
141 green       = 000,255,000 or 0x00ff00
142 .br
143 blue        = 000,000,255 or 0x0000ff
144 .br
145 black       = 000,000,000 or 0x000000
146 .br
147 white       = 255,255,255 or 0xffffff
148 .br
149 Brown       = 255,000,255 or 0xff00ff 
150 .br
151 gray        = 142,142,142 or 0x8e8e8e
152 .PP
153 Some colours, such as pink, turquoise, sandy, brown, gray etc may mean slightly
154 different things to different people. This is not so with \fBatlc\fR, as the 
155 program expects the colours below to be EXACTLY defined as given. Whether 
156 you feel the colour is sandy or yellow is up to you, but if you use it in 
157 your bitmap, then it either needs to be a colour reconised by atlc, \fBor\fR
158 you must define it with a command line option (see OPTIONS and example 5
159 below).
160 .br
161 The following conductors are reconised by atlc:
162 .br
163 red    = 255,000,000 or 0xff0000 is the live conductor. 
164 .br
165 green  = 000,255,000 or 0x00ff00 is the grounded conductor. 
166 .br
167 blue   = 000,000,000 or 0x000000 is the negative conductor 
168 .PP
169 All bitmaps \fBmust\fR have the live (red) and grounded (green) conductor. The blue
170 conductor is not currently supported, but it will be used to indicate a 
171 negative conductor, which will be needed if/when the program gets extended 
172 to analyse directional couplers. 
173 .PP
174 The following dielectrics are reconised by \fRatlc\fB and so are
175 produced by \fRcreate_bmp_for_circ_in_circ\fB. 
176 .PP
177 .br
178 white     255,255,255 or 0xFFFFFF as Er=1.0   (vacuum)
179 .br
180 pink      255,202,202 or 0xFFCACA as Er=1.0006 (air)
181 .br
182 blue      000,000,255 or 0x0000FF as Er=2.1   (PTFE)
183 .br
184 Mid gray  142,242,142 or 0x8E8E8E as Er=2.2   (duroid 5880)
185 .br
186 mauve     255.000,255 or 0xFF00FF as Er=2.33  (polyethylene)
187 .br
188 yellow    255,255,000 or 0xFFFF00 as Er=2.5   (polystyrene)
189 .br
190 sandy     239,203,027 or 0xEFCC1A as Er=3.3   (PVC)
191 .br
192 brown     188,127,096 or 0xBC7F60 as Er=3.335 (epoxy resin)
193 .br
194 Turquoise 026,239,179 or 0x1AEFB3 as Er=4.8   (glass PCB)
195 .br
196 Dark gray 142,142,142 or ox696969 as Er=6.15  (duroid 6006)
197 .br
198 L. gray   240,240,240 or 0xDCDCDC as Er=10.2  (duroid 6010)
199 .br
200 .SH NOTE 
201 Although \fBcreate_bmp_for_circ_in_circ\fR is used for circular inner and outer
202 conductors, the outside of the outer conductor is drawn as a square. This is 
203 for convenience and makes no difference to the calculations. The inside
204 is of the outer conductor is drawn as a circle. 
205 .SH EXAMPLES
206 Here are a few examples of the use of \fBcreate_bmp_for_circ_in_circ\fR. Again, see the html documentation in atlc-X.Y.Z/docs/html-docs/index.html for more examples.     
207 .P
208 1) In the first example, the outer conductor has an inside diameter of 12
209 units (inches, mm, feet etc.), the inner has an outside diameter of 3.9 units.
210 The inner is placed centrally (h=0) and the dielectric is vacuum (Er=1.0).
211 .br
212 \fB% create_bmp_for_circ_in_circ 12 3.9 0 1.0 coaxial_1.bmp
213 .br
214 % atlc coaxial_1.bmp\fR
215 .br
216 \fBatlc\fR will indicate the correct value of impedance to be 67.3667 Ohms,
217 whereas an exact analysis will show the true value to be 67.4358 Ohms,
218 so \fBatlc\fR has an error of 0.102%. 
219 .P 
220 2) In this second example, the conductor sizes are the sames as in example 1, but the inner is located 3.5 units
221 off-centre and the dielectric has a relative permittivity of 2.1 
222 (Er of PTFE) The output is sent to a file not_in_centre.bmp
223 which is then processed by \fBatlc\fR 
224 .br
225 \fB% create_bmp_for_circ_in_circ 12 3.9 3.5 2.1 not_in_centre.bmp\fR
226 .br
227 \fB% atlc not_in_centre.bmp\fR
228 .br
229 The impedance of this is theoretically 24.315342 Ohms, as create_bmp_for_circ_in_circ
230 will calculate for you. atlc's estimate is 24.2493 Ohms, an error of
231 only -0.271 %. 
232 .P
233 3) In the third example the bitmap is made larger, to increase accuracy, but
234 otherwise this is identical to the previous one. 
235 .br
236 \fB% create_bmp_for_circ_in_circ -b8 12 3.9 3.5 2.1 bigger_not_in_centre.bmp \fR
237 .br
238 \fB% atlc bigger_not_in_centre.bmp\fR
239 .br
240 This time atlc will take much longer to calculate Zo, since the bitmap is larger and so it needs to do more calculations. However,
241 the final result should be more accurate. In this case, the result reported is 24.2461 Ohms, an error that's marginally smaller than before at 0.285 %.
242 It is possible there may be something to be gained by decreasing the
243 cutoff at larger grids, so this is being investigated. However, errors
244 almost always below 0.25 %, no matter what is being analysed. 
245 .P
246 In the fourth example, a material with a relativity permittivity 7.89 of is 
247 used. There is no change in how to use \fBcreate_bmp_for_circ_in_circ\fR, but since
248 this permittivity is not one of the pre-defined values (see COLOURS), we must tell \fBatlc\fR what it is.
249 The colour will be set an olive green one, with a hexacidcal representation of red=0xCA, blue=OxFF and
250 green = 0x00. This just happens to be the default colour  used when the permittivity is unknown. So atlc
251 must be given this information, like thisL
252 .br
253 \fB% create_bmp_for_circ_in_circ 23 9 0 7.89 an_odd_er.bmp
254 .br
255 % atlc -d CAFF00=7.89 an_odd_er.bmp
256 \fR
257 This has a theoretical impedance of 20.041970 Ohms, but atlc version
258 3.0.1 will calculate it to be 20.0300, an error of -0.058 % !!! If you look at the file 
259 an_odd_er.bmp with a graphics package, you will see there are 3 colours in it 
260 - the red inner conductor, the green outer and an olive-green dielectric. 
261 \fR
262 .SH SEE ALSO
263
264 atlc(1)
265 .br
266 create_bmp_for_circ_in_rect(1)
267 .br
268 create_bmp_for_microstrip_coupler(1)
269 .br
270 create_bmp_for_rect_cen_in_rect(1)
271 .br
272 create_bmp_for_rect_cen_in_rect_coupler(1)
273 .br
274 create_bmp_for_rect_in_circ(1)
275 .br
276 create_bmp_for_rect_in_rect(1)
277 .br
278 create_bmp_for_stripline_coupler(1)
279 .br
280 create_bmp_for_symmetrical_stripline(1)
281 .br
282 design_coupler(1)
283 find_optimal_dimensions_for_microstrip_coupler(1)
284 readbin(1)
285 .P 
286 .br
287 http://atlc.sourceforge.net                - Home page 
288 .br
289 http://sourceforge.net/projects/atlc       - Download area
290 .br
291 atlc-X.Y.Z/docs/html-docs/index.html       - HTML docs
292 .br
293 atlc-X.Y.Z/docs/qex-december-1996/atlc.pdf - theory paper
294 .br
295 atlc-X.Y.Z/examples                        - examples
296 .br
297 .br
298 .br