Merge branch 'hotfix-3.07.3'
[felt.git] / doc / misc / appendix_old.tex
blob89b288d2d03409c4787c0e95bbe9d3f12a547f29
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 % %
3 % Legal Notice %
4 % %
5 % This document is copyright (C) Jason Gobat & Darren Atkinson %
6 % %
7 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9 \begin{appendix}
11 \newpage{\pagestyle{empty}\cleardoublepage}
13 \chapter{Installing and Administering \felt{}}
14 \label{appendix.install}
16 \section{Building the \felt{} system from source}
18 The \felt{} package is intended to be easily portable. It should build on most
19 reasonable Un*x systems without any modifications. To start the build
20 {\tt cd} to the toplevel directory of the \felt{} source tree. From there
21 do a {\tt ./configure}.
22 This will try to automatically determine where to find relevant include files
23 and libraries on your system and create a new {\tt etc/Makefile.conf} file.
24 If you feel comfortable with it you can go in and tweak
25 the {\tt Makefile.conf} file by hand if something does not go right.
26 The Geompack library used for element generation is written
27 entirely in Fortran but C versions as produced by f2c are included in the
28 source distribution so there should be no need for you to f2c them yourself.
29 If you have a native Fortran compiler and know how to use it in combination
30 with C code then you can go ahead and play around with the build process to
31 make this work. The resulting code will probably be faster than if you
32 compile the f2c'd code with a C compiler, but not by much, so unless you
33 really care it's probably not worth messing with. You don't need to have the
34 f2c libraries
35 to use the converted code and the header file f2c.h is provided in the
36 distribution. After configuring, do a {\tt make clean} followed by a
37 {\tt make all}. To install the package after it has been successfully
38 built do a {\tt make install}.
40 The entire package has been compiled and tested under SunOS (4.x and 5.x),
41 and Linux (the OS under which it was developed). This version or earlier
42 versions
43 compiled under HP-UX 8.0 and 9.0 SystemV386 (R3.2.2), and various SGI, DEC,
44 and IBM workstations (using Irix, OSF/1 and Ultrix, and AIX) with little or
45 no problem.
46 The files {\em felt.exe} and {\em feltvu.exe} (a graphing application)
47 are available as pre-compiled executables for the DOS environment.
49 The most recent version of the source code for \felt{} should always be
50 available via anonymous
51 ftp at cs.ucsd.edu in the directory {\tt /pub/felt}. We also try to make
52 pre-compiled binaries available for a wide variety of platforms and operating
53 systems; the currently available set of such binaries and how to get to
54 them are listed in table~\ref{binary_table}.
55 \begin{table}
56 \begin{center}
57 \begin{tabular}{|l|l|l|}
58 \hline
59 Machine type & operating system & location \\
60 \hline\hline
61 i386/i486 & Linux 1.0.x & ftp://cs.ucsd.edu/pub/felt \\
62 Sun Sparc & SunOS 4.1.3 & ftp://cs.ucsd.edu/pub/felt \\
63 Sun Sparc & SunOS 5.3 (Solaris 2.3) & ftp://cs.ucsd.edu/pub/felt \\
64 HP 700 series & HP-UX 9.05 & \\
65 SGI Indigo & Irix 5.x & \\
66 IBM RS6000 & AIX x.xx & \\
67 DEC 5000 & Ultrix x.xx & \\
68 DEC Alpha & OSF/1 x.xx & \\
69 i386/i486 & DOS & ftp://cs.ucsd.edu/pub/felt \\
70 \hline
71 \end{tabular}
72 \end{center}
73 \caption{Type and location of pre-compiled binaries of the \felt{} system.}
74 \label{binary_table}
75 \end{table}
77 If you want to be
78 made aware of each revision of the \felt{} system then we strongly encourage
79 you to subscribe to the \felt{} mailing list. To subscribe send a one line
80 email message with ``subscribe felt-l'' (without the quotes) in the body
81 of the message to listserv@mecheng.asme.org.
82 Only major revisions and changes will be announced broadly (i.e., via Usenet).
84 \section{Translation files}
86 The translation files which map non-English terms to the English terms
87 which \felt{} expects should be installed in the library directory which
88 you specified during the build. This path will automatically be
89 searched when {\em cpp} goes looking for include files (which is really
90 what the translation files are). If they are not in some standard place,
91 users need to specify a {\tt -I} flag on the {\em felt} command line to tell
92 {\em cpp} where to look for them. The current filenames are in English,
93 you'll obviously want to link them or move them to something reasonable
94 on your system and make users aware of what the appropriate file to include
95 is called.
97 The following tables list the currently available translations (that we
98 have at least). You can look at the current {\tt german.trn} and
99 {\tt spanish.trn} files if you want to change something or provide a new
100 one. If you do write a new one, please send it to us. This is only
101 a first cut at internationalization, but as we get more translations
102 we will be in a better position to see how we can make it all work a little
103 more fluently. Also, remember that because this is a first cut all you
104 can really do is type in a \felt{} file by hand using these translations.
105 Anything {\em velvet} saves or even the file that {\em felt} writes with
106 the {\tt -debug} command will be in English even if the input file was
107 given in another language. All output is still in English. Lastly, if
108 you use these translations, you have to use them exactly as they are given
109 here. They are not case insensitive, and if there are underscores in the
110 place of spaces, you must use the underscores. Things that are user
111 specifiable to begin with (object names, problem title) can still be
112 whatever you want of course. If a keyword is not listed in a table below,
113 use the original English keyword (the English and non-English were probably
114 equivalent).
116 {\small
117 \begin{center}
118 \begin{tabular}{p{3in}p{3in}} \hline
119 \bf For German, use \dots & \bf Instead of \dots \\
120 \hline
121 problembeschreibung & problem description \\
122 titel & title \\
123 knoten & nodes \\
124 elemente & elements \\
125 krafte & force \\
126 kraefte & forces \\
127 zwangsbedingung & constraint \\
128 zwangsbedingungen & constraints \\
129 materialeigenschaften & material properties \\
130 richtung & direction \\
131 senkrecht & perpendicular \\
132 GlobalesX & GlobalX \\
133 GlobalesY & GlobalY \\
134 GlobalesZ & GlobalZ \\
135 LokalesX & LocalX \\
136 LokalesY & LocalY \\
137 LokalesZ & LocalZ \\
138 werte & values \\
139 verteilte & distributed \\
140 lasten & loads \\
141 last & load \\
142 gelenk & hinge \\
143 ende & end \\
144 \end{tabular}
145 \end{center}}
147 {\small
148 \begin{center}
149 \begin{tabular}{p{3in}p{3in}} \hline
150 \bf For Spanish, use \dots & \bf Instead of \dots \\
151 \hline
152 descripcion\_del\_problema & problem title \\
153 titulo & title \\
154 nodos & nodes \\
155 elementos & elements \\
156 fuerza & force \\
157 fuerzas & forces \\
158 restriccion & constraint \\
159 restricciones & constraints \\
160 propriedades\_del\_material & material properties \\
161 direccion & direction \\
162 paralela & parallel \\
163 valores & values \\
164 cargas\_distribuidas & distributed loads \\
165 carga & load \\
166 articulacion\_plana & hinge \\
167 final & end \\
168 \end{tabular}
169 \end{center}}
171 \section{Defaults and material databases}
173 Though the defaults files and material databases are not a necessity for
174 {\em velvet}, they are convenient and it might be desirable to install them in
175 a location where all users have easy access to them, probably the same
176 library directory as the translation files. These files too are really
177 nothing more than include files which can be included as a convenience for
178 the user.
180 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
182 \newpage{\pagestyle{empty}\cleardoublepage}
184 \chapter{Geompack Error Codes}
185 \label{appendix.geompack}
187 \section{Basic description}
189 Error codes from 1 to 99 indicate not enough space in some array.
190 Error codes $>=$ 100 mean that the input specification is incorrect,
191 there is a program bug, or the tolerance TOL is too small or large
192 (try a different TOLIN value).
194 {\small
195 \begin{tabular}[h]{cp{5.5in}}
196 \bf Error Code & \bf Description of error \\
197 \hline
198 1 & not enough space in EDGE array for routine EDGHT \\
199 2 & not enough space in HOLV array for routine DSMCPR or DSPGDC \\
200 3 & not enough space in 2-D VCL array \\
201 4 & not enough space in HVL array \\
202 5 & not enough space in PVL, IANG arrays \\
203 6 & not enough space in IWK array \\
204 7 & not enough space in WK array \\
205 8 & not enough space in STACK array for routine SWAPEC, DTRIS2, DTRIW2 \\
206 9 & not enough space in TIL array \\
207 10 & not enough space in CWALK array for routine INTTRI \\
208 11 & not enough space in FC array for 3-D \\
209 12 & not enough space in BF array for 3-D \\
210 13 & not enough space in SVCL, SFVL arrays for routine SHRNK3 \\
211 14 & not enough space in 3-D VCL array \\
212 15 & not enough space in FVL, EANG arrays for polyhedral decomposition \\
213 16 & not enough space in FACEP, NRML arrays \\
214 17 & not enough space in PFL array \\
215 18 & not enough space in HFL array \\
216 19 & not enough space in BTL array \\
217 20 & not enough space in VM array \\
218 21 & not enough space in HT array \\
219 22 & not enough space in FC array for K-D \\
220 23 & not enough space in BF array for K-D \\
221 100 & higher primes need to be added to routine PRIME \\
222 200 & abnormal return in routine DIAM2 \\
223 201 & abnormal return in routine WIDTH2 \\
224 202 & parallel lines in routine SHRNK2 \\
225 205 & horizontal ray to right does not intersect polygon in routine ROTIPG \\
226 206 & out-of-range index when popping points from stack in routine VPRGHT \\
227 207 & out-of-range index when scanning vertices in routine VPSCNA \\
228 208 & out-of-range index when scanning vertices in routine VPSCNB \\
229 209 & out-of-range index when scanning vertices in routine VPSCNC \\
230 210 & out-of-range index when scanning vertices in routine VPSCND \\
231 212 & singular matrix in routine VORNBR \\
232 215 & unmatched separator interface edge determined by routine DSPGDC \\
233 216 & all edges of an outer boundary curve are specified as hole
234 edges in input to routine DSPGDC \\
235 218 & cannot find subregion above top vertex of hole in routine JNHOLE \\
236 219 & angle at hole vertex in modified region is too far from PI due
237 to use of relative tolerance in routine JNHOLE \\
238 222 & separator not found in routine MFDEC2 (not likely to occur if
239 ANGSPC $<=$ 30 degrees and ANGTOL $<=$ 20 degrees) \\
240 224 & 2 vertices with identical coordinates (in floating point arithmetic)
241 detected in routine DTRIS2 or DTRIW2 \\
242 225 & all vertices input to DTRIS2 or DTRIW2 are collinear \\
243 226 & cycle detected in walk by routine WALKT2 \\
244 230 & invalid (CW-oriented) triangle created in routine TMERGE \\
245 231 & unsuccessful search in routine FNDTRI
246 \end{tabular}}
248 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
249 % The GNU Public License %
250 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
252 \newpage{\pagestyle{empty}\cleardoublepage}
254 \chapter{The GNU General Public License}
255 \label{appendix.gnu-license}
257 \input{misc/gpl}
259 \end{appendix}