git.gag.com Git - debian/atlc/blob - docs/html-docs/atlc.1.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5
   6 </PRE>
   7 <H2>NAME</H2><PRE>
   8      <B>atlc</B> - an Arbitrary Transmission Line Calculator
   9
  10
  11 </PRE>
  12 <H2>SYNOPSIS</H2><PRE>
  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>
  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>
  16
  17
  18 </PRE>
  19 <H2>WARNING</H2><PRE>
  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
  34
  35
  36 </PRE>
  37 <H2>DESCRIPTION</H2><PRE>
  38      <B>atlc</B> is a finite difference program that is used  to  calcu-
  39      late  the properties of a two-conductor electrical transmis-
  40      sion line of arbitrary cross section. It  is  used  whenever
  41      there are no analytical formula known, yet you still require
  42      an answer. It can calculate:
  43         The impedance Zo  (in Ohms)
  44         The capacitance per unit length (pF/m)
  45         The inductance per unit length (nF/m)
  46         The velocity of propagation v (m/s)
  47         The velocity factor, v/c, which is dimensionless.
  48
  49      A bitmap file (usually with the extension .bmp or  .BMP)  is
  50      drawn  in  a  graphics  package  such as <B>Gimp</B> available from
  51      http://www.gimp.org. The bitmap file <B>must</B> be saved as a  24-
  52      bit  (16,777,216 colour) uncompqessed file. The colours used
  53      in the bitmap indicate whether the  region  is  a  conductor
  54      (pure  red,  pure  green or pure blue) or a dielectric (any-
  55      thing else). Pure white is assumed to be  a  vacuum  dielec-
  56      tric, but other colours have different meanings. See COLOURS
  57      below for precise definitions of the colours.
  58
  59
  60 </PRE>
  61 <H2>OPTIONS</H2><PRE>
  62      <B>-C</B>
  63      print copyright, licensing and copying information.
  64      <B>-s</B>
  65      Skip writing the Ex, Ey, E, V, U and Er bitmap (.bmp)  files
  66      <B>-S</B>
  67      Skip writing the Ex, Ey, E, V, U and Er binary (.bin) files
  68      <B>-v</B>
  69      makes the output more verbose/talkative.
  70      <B>-c</B> <B>cutoff</B>
  71      Sets the convergence criteria of the finite difference  pro-
  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.
  76
  77      <B>-d</B> <B>rrggbb=Er</B>
  78      is used to indicate the colour 0xrrggbb  in  the  bitmap  is
  79      used  to represent a material with permittivity Er. See also
  80      COLOURS below
  81
  82      <B>-i</B> <B>factor</B>
  83      is used to lighten or darken the .bmp electric field profile
  84      images  produced  by  atlc.  Set  factor  &gt;  2 to lighten or
  85      between 1 and 2 to darken.
  86
  87      <B>-r</B> <B>ratemultiplier</B>
  88      Sets the parameter 'r' used internally  when  computing  the
  89      voltage  at  a point w,h.  The default, which is (as of ver-
  90      sion 3.0.0) 1.95, results in what is believed to be  optimal
  91      results.  Setting to 1.0 will avoid the use of the fast con-
  92      vergence method, which is generally not a good idea.
  93
  94      <B>-p</B> <B>prefix</B>
  95      Adds 'prefix', which is usually a directory name,  in  front
  96      of the output files.
  97
  98
  99 </PRE>
 100 <H2>COLOURS</H2><PRE>
 101      The 24-bitmaps that  atlc  uses  have  8  bits  assigned  to
 102      represent  the  amount  of  red, 8 for blue and 8 for green.
 103      Hence there are 256 levels of red, green and blue, making  a
 104      total of 256*256*256=16777216 colours. Every one of the pos-
 105      sible 16777216 colours can be defined precisely by the stat-
 106      ing the exact amount of red, green and blue, as in:
 107
 108      red         = 255,000,000 or 0xff0000
 109      green       = 000,255,000 or 0x00ff00
 110      blue        = 000,000,255 or 0x0000ff
 111      black       = 000,000,000 or 0x000000
 112      white       = 255,255,255 or 0xffffff
 113      Brown       = 255,000,255 or 0xff00ff
 114      gray        = 142,142,142 or 0x8e8e8e
 115
 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).
 124      red    = 255,000,000 or 0xFF0000 is the live conductor.
 125      green  = 000,255,000 or 0x00FF00 is the grounded conductor.
 126      blue   = 000,000,255 or 0x0000FF is the negative conductor
 127
 128      All bitmaps <B>must</B> have the live (red)  and  grounded  (green)
 129      conductor. The blue conductor is used to indicate a negative
 130      conductor, is needed when the program  is  used  to  analyse
 131      directional couplers.
 132
 133      The following dielectrics are reconised by atlc<B>:</B>
 134
 135      white     255,255,255 or 0xFFFFFF as Er=1.0    (vacuum)
 136      pink      255,202,202 or 0xFFCACA as Er=1.0006 (air)
 137      L. blue   130,052,255 or 0x8235EF as Er=2.1    (PTFE)
 138      Mid gray  142,242,142 or 0x8E8E8E as Er=2.2    (duroid 5880)
 139      mauve     255.000,255 or 0xFF00FF as Er=2.33  (polyethylene)
 140      yellow    255,255,000 or 0xFFFF00 as Er=2.5    (polystyrene)
 141      sandy     239,203,027 or 0xEFCC1A as Er=3.3    (PVC)
 142      brown     188,127,096 or 0xBC7F60 as Er=3.335  (epoxy resin)
 143      L. yellow 223,247,136 or 0xDFF788 as Er=3.7    (FR4 PCB)
 144      Turquoise 026,239,179 or 0x1AEFB3 as Er=4.8    (glass PCB)
 145      Dark gray 142,142,142 or 0x696969 as Er=6.15   (duroid 6006)
 146      L. gray   240,240,240 or 0xDCDCDC as Er=10.2  (duroid 6010)
 147      D. orange 213,160,067 or 0xD5A04D as  Er=100.0  (mainly  for
 148      test purposes)
 149
 150
 151 </PRE>
 152 <H2>EXAMPLES</H2><PRE>
 153      Here are a few examples of the use of atlc. Again,  see  the
 154      html documentation in atlc-X.Y.Z\e9ocsl-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.
 158
 159      <B>ex_1</B> <B>%</B> <B>atlc</B> <B>coax2.bmp</B>
 160      This is a simple example (ex_1), in which the geometry of  a
 161      transmission  line is defined in coax2.bmp. In this example,
 162      only the predefined dielectrics (Er =1.0, 1.0006, 2.1,  2.2,
 163      2.33,  2.5,  3.3,  3.335, 3.7, 4.8, 6.15 or 10.2) could have
 164      been used in the bitmap, which would have been done with one
 165      of  13  different colours. white (0xFFFFFF) for Er=1.0, pink
 166      (0xFFCACA) for 1.0006 etc.   No  other  colour  (dielectric)
 167      could have been used, since it was not specified with the -d
 168      option.
 169
 170      <B>ex_2</B> <B>%</B> <B>atlc</B> <B>-d</B> <B>f9e77d=2.43</B> <B>somefile.bmp</B>
 171      In ex_2, a dielectric with Er=2.43 was wanted. A colour with
 172      the  RGB  values  of  0xF9E7&amp;d was used. The -d option tells
 173      atlc what Er this colour refers to.
 174
 175      <B>ex_3</B> <B>%</B> <B>atlc</B> <B>-v</B> <B>coax2.bmp</B>
 176      In ex_3, atlc has been instructed to print  the  results  of
 177      intermediate  calculations  to  stdout.   Normally, only the
 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.
 181
 182
 183 </PRE>
 184 <H2>FILES</H2><PRE>
 185      bitmapfile.bmp
 186         Original bitmap file. Must be 24-bit colour uncompressed.
 187      bitmapfile.Ex.bmp
 188         X-component of E-field as a bitmap. Red=+dV/dx,  blue  =-
 189      dV/dx
 190      bitmapfile.Ey.bmp
 191         y-component of E-field as a bitmap. Red=+y, blue =-y
 192      bitmapfile.E.bmp
 193         E-field, as E=sqrt(Ex^2+Ey^2).
 194      bitmapfile.V.bin
 195         Voltage as a bitmap, red= positive, blue =negative.
 196      bitmapfile.Er.bin
 197         Bitmap showing the permittivity as a  grayscale.  Lighter
 198      is a higher
 199         permittivity.
 200      bitmapfile.U.bmp
 201         Energy.
 202
 203      In addition to the bitmaps, the data is also saved in binary
 204      files.
 205
 206      All the saved binary files (.bin's) are saved  as  a  double
 207      precision number for each of the pixels. The first double is
 208      the top left, the last the bottom  right.  If  the  original
 209      image  has width W and height H, the saved binary files will
 210      be W-1 by H-1.
 211
 212      All the saved bitmap files  are  24-bit  uncompressed,  just
 213      like the input files.
 214
 215
 216 </PRE>
 217 <H2>SEE ALSO</H2><PRE>
 218      <B>atlc(1)</B>                       <B>create_bmp_for_circ_in_circ(1)</B>
 219      <B>create_bmp_for_circ_in_rect(1)</B>
 220      <B>create_bmp_for_microstrip_coupler(1)</B>
 221      <B>create_bmp_for_rect_cen_in_rect(1)</B>
 222      <B>create_bmp_for_rect_cen_in_rect_coupler(1)</B>
 223      <B>create_bmp_for_rect_in_circ(1)</B>
 224      <B>create_bmp_for_rect_in_rect(1)</B>
 225      <B>create_bmp_for_stripline_coupler(1)</B>
 226      <B>create_bmp_for_symmetrical_stripline(1)</B>    <B>design_coupler(1)</B>
 227      <B>find_optimal_dimensions_for_microstrip_coupler(1)</B> <B>readbin(1)</B>
 228
 229      http://atlc.sourceforge.net                - Home page
 230      http://sourceforge.net/projects/atlc       - Download area
 231      atlc-X.Y.Z/docs/html-docs/index.html       - HTML docs
 232      atlc-X.Y.Z/docs/qex-december-1996/atlc.pdf - theory paper
 233      atlc-X.Y.Z/examples                        - examples
 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
 281
 282
 283 </PRE>
 284 <HR>
 285 <ADDRESS>
 286 Man(1) output converted with
 287 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 288 </ADDRESS>
 289 </BODY>
 290 </HTML>