STYLE: Fixes to application documentation headers
[freefoam.git] / ChangeLog.html
blobc79b8018283d29626e528f9c40ae761d9cbdf9b9
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.4.4-dev" />
7 <title>Change Log for FreeFOAM</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Workarounds for IE6's broken and incomplete CSS2. */
344 div.sidebar-content {
345 background: #ffffee;
346 border: 1px solid silver;
347 padding: 0.5em;
349 div.sidebar-title, div.image-title {
350 color: #527bbd;
351 font-family: sans-serif;
352 font-weight: bold;
353 margin-top: 0.0em;
354 margin-bottom: 0.5em;
357 div.listingblock div.content {
358 border: 1px solid silver;
359 background: #f4f4f4;
360 padding: 0.5em;
363 div.quoteblock-attribution {
364 padding-top: 0.5em;
365 text-align: right;
368 div.verseblock-content {
369 white-space: pre;
371 div.verseblock-attribution {
372 padding-top: 0.75em;
373 text-align: left;
376 div.exampleblock-content {
377 border-left: 2px solid silver;
378 padding-left: 0.5em;
381 /* IE6 sets dynamically generated links as visited. */
382 div#toc a:visited { color: blue; }
383 </style>
384 <script type="text/javascript">
385 /*<![CDATA[*/
386 window.onload = function(){generateToc(2)}
387 /* Author: Mihai Bazon, September 2002
388 * http://students.infoiasi.ro/~mishoo
390 * Table Of Content generator
391 * Version: 0.4
393 * Feel free to use this script under the terms of the GNU General Public
394 * License, as long as you do not remove or alter this notice.
397 /* modified by Troy D. Hanson, September 2006. License: GPL */
398 /* modified by Stuart Rackham, October 2006. License: GPL */
400 function getText(el) {
401 var text = "";
402 for (var i = el.firstChild; i != null; i = i.nextSibling) {
403 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
404 text += i.data;
405 else if (i.firstChild != null)
406 text += getText(i);
408 return text;
411 function TocEntry(el, text, toclevel) {
412 this.element = el;
413 this.text = text;
414 this.toclevel = toclevel;
417 function tocEntries(el, toclevels) {
418 var result = new Array;
419 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
420 // Function that scans the DOM tree for header elements (the DOM2
421 // nodeIterator API would be a better technique but not supported by all
422 // browsers).
423 var iterate = function (el) {
424 for (var i = el.firstChild; i != null; i = i.nextSibling) {
425 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
426 var mo = re.exec(i.tagName)
427 if (mo)
428 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
429 iterate(i);
433 iterate(el);
434 return result;
437 // This function does the work. toclevels = 1..4.
438 function generateToc(toclevels) {
439 var toc = document.getElementById("toc");
440 var entries = tocEntries(document.getElementsByTagName("body")[0], toclevels);
441 for (var i = 0; i < entries.length; ++i) {
442 var entry = entries[i];
443 if (entry.element.id == "")
444 entry.element.id = "toc" + i;
445 var a = document.createElement("a");
446 a.href = "#" + entry.element.id;
447 a.appendChild(document.createTextNode(entry.text));
448 var div = document.createElement("div");
449 div.appendChild(a);
450 div.className = "toclevel" + entry.toclevel;
451 toc.appendChild(div);
453 if (entries.length == 0)
454 document.getElementById("header").removeChild(toc);
456 /*]]>*/
457 </script>
458 </head>
459 <body>
460 <div id="header">
461 <h1>Change Log for FreeFOAM</h1>
462 <span id="author">Michael Wild</span><br />
463 <span id="email"><tt>&lt;<a href="mailto:themiwi@users.sourceforge.net">themiwi@users.sourceforge.net</a>&gt;</tt></span><br />
464 <span id="revnumber">version 0.1.0rc4,</span>
465 <span id="revdate">2009-06-04</span>
466 <div id="toc">
467 <div id="toctitle">Table of Contents</div>
468 <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
469 </div>
470 </div>
471 <div id="preamble">
472 <div class="sectionbody">
473 <div class="paragraph"><p><a href="http://freefoam.sourceforge.net">http://freefoam.sourceforge.net</a></p></div>
474 <div class="paragraph"><p>This file describes the most important changes made between FreeFOAM versions.
475 It does not include changes made by the upstream developers (i.e.
476 <a href="http://openfoam.org">OpenFOAM&#174;</a>). For the detailed changes refer to the log
477 provided by the <a href="http://repo.or.cz/w/freefoam.git">GIT repository</a>.</p></div>
478 </div>
479 </div>
480 <h2 id="_changes_in_freefoam_0_1_0rc4">1. Changes in FreeFOAM 0.1.0rc4</h2>
481 <div class="sectionbody">
482 <div class="ulist"><ul>
483 <li>
485 Improved building of METIS and ParMetis (no non-standard headers and
486 feature detection of mallinfo).
487 </p>
488 </li>
489 <li>
491 Improved detection of backtrace() and backtrace_symbols() availability.
492 </p>
493 </li>
494 <li>
496 Improved detection of SIGFPE handling capabilities.
497 </p>
498 </li>
499 <li>
501 More flexible -doc and -srcDoc options using an index file. It is now
502 possible to use the online documentation and have FreeFOAM output
503 the location of the documentation file instead of trying to open it
504 using a browser.
505 </p>
506 </li>
507 <li>
509 Fixed some bugs in the build system and some utility scripts.
510 </p>
511 </li>
512 <li>
514 Merged with upstream (OpenFOAM-1.5.x), up to revision
515 <a href="http://repo.or.cz/w/OpenFOAM-1.5.x.git?a=commit;h=5f9a16">5f9a16</a>.
516 </p>
517 </li>
518 </ul></div>
519 </div>
520 <h2 id="_changes_in_freefoam_0_1_0rc3">2. Changes in FreeFOAM 0.1.0rc3</h2>
521 <div class="sectionbody">
522 <div class="ulist"><ul>
523 <li>
525 Fixed typo in new dummyPrintStack.C.
526 </p>
527 </li>
528 </ul></div>
529 </div>
530 <h2 id="_changes_in_freefoam_0_1_0rc2">3. Changes in FreeFOAM 0.1.0rc2</h2>
531 <div class="sectionbody">
532 <div class="ulist"><ul>
533 <li>
535 Only print stack trace if the system supports it and then only don&#8217;t
536 try to shell-escape and use addr2line for file/line information.
537 </p>
538 </li>
539 <li>
541 Use full version number for default installation directory names and
542 use the hyphen to separate it from the directory name instead of creating a
543 subdirectory.
544 </p>
545 </li>
546 <li>
548 Configure global.C instead of using preporcessor defines. This
549 solves unnecessary recompiles of the complete OpenFOAM library.
550 </p>
551 </li>
552 </ul></div>
553 </div>
554 <h2 id="_changes_in_freefoam_0_1_0rc1">4. Changes in FreeFOAM 0.1.0rc1</h2>
555 <div class="sectionbody">
556 <div class="ulist"><ul>
557 <li>
559 CMake based build system
560 </p>
561 </li>
562 <li>
564 New, automatically created include-structure in the build tree,
565 corresponding to the install tree:
566 </p>
567 <div class="literalblock">
568 <div class="content">
569 <pre><tt>&lt;binary_dir&gt;/
570 include/
571 OpenFOAM/
572 Scalar.H -&gt; includes &lt;source_dir&gt;/src/OpenFOAM/primitives/Scalar/Scalar.H
573 Scalar.C -&gt; includes &lt;source_dir&gt;/src/OpenFOAM/primitives/Scalar/Scalar.C
575 finiteVolume/
577 compressibleRASModels/
579 incompressibleRASModels/
581 compressibleLESModels/
583 incompressibleLESModels/
585 ..</tt></pre>
586 </div></div>
587 </li>
588 <li>
590 All source files (with a few exceptions) use the new
591 <tt>#include &lt;libname/filename&gt;</tt> scheme
592 </p>
593 </li>
594 <li>
596 Renamed files/directories with ambiguous names (distinguish only through
597 capitalization)
598 </p>
599 </li>
600 <li>
602 Applied B. Gschaider&#8217;s Mac OS X Patches versions 1 and 3
603 </p>
604 </li>
605 <li>
607 Made the interfaces of sig{Fpe,Int,Quit,Segv} OS-agnostic
608 </p>
609 </li>
610 <li>
612 Moved <em>Pstream</em> implementations into loadable modules
613 </p>
614 </li>
615 <li>
617 Configurable search path for plugins
618 </p>
619 </li>
620 <li>
622 Removed all dependencies on environment variables
623 </p>
624 </li>
625 <li>
627 Removed wmake build system and shell init scripts
628 </p>
629 </li>
630 <li>
632 Removed obsolete, useless and black-magick scripts from <tt>bin/</tt>
633 </p>
634 </li>
635 <li>
637 Adapted Doxygen creation to FreeFOAM
638 </p>
639 </li>
640 <li>
642 Use a user-configurable template string for running parallel jobs with <em>foamJob</em>
643 </p>
644 </li>
645 <li>
647 Moved non-essential utility scripts to <tt>data/utilities</tt>
648 </p>
649 </li>
650 <li>
652 Moved <tt>bin/tools</tt> into <tt>data/shellFunctions</tt>
653 </p>
654 </li>
655 <li>
657 Turned <tt>bin/{newSource,newSourceTemplate}</tt> into shell-functions
658 </p>
659 </li>
660 <li>
662 Added <tt>~FreeFOAM/</tt> to be expanded like <tt>~OpenFOAM/</tt>
663 </p>
664 </li>
665 <li>
667 Improved <em>dotFoam()</em> search for config files
668 </p>
669 </li>
670 <li>
672 Rebranded source templates, Doxygen doc, <em>IOobject::writeBanner()</em> and the
673 scripts in <tt>bin/</tt>
674 </p>
675 </li>
676 <li>
678 Do not run <tt>XiFoam/moriyoshiHomogeneousPart2</tt> when testing
679 </p>
680 </li>
681 </ul></div>
682 <hr />
683 <div class="paragraph"><p><a href="http://openfoam.org">OpenFOAM&#174;</a> is a registered trademark of
684 <a href="http://opencfd.co.uk">OpenCFD&#174; Ltd.</a></p></div>
685 </div>
686 <div id="footer">
687 <div id="footer-text">
688 Version 0.1.0rc4<br />
689 Last updated 2009-06-04 10:05:31 CEST
690 </div>
691 </div>
692 </body>
693 </html>