CFD Online Logo CFD Online URL
Home > Forums > Software User Forums > OpenFOAM

Documentation question source availability license

Register Blogs Members List Search Today's Posts Mark Forums Read

LinkBack Thread Tools Search this Thread Display Modes
Old   December 5, 2005, 21:50
Default (I know this is going to come
Posts: n/a
(I know this is going to come off as a bit pedantic and picky, and I apologize for that, but I do think this sort of thing is important -- particularly when I consider basic long-term projects on OpenFOAM.)

Is the LaTeX source (and the source for the figures) for the OpenFOAM Users Guide and Programmers Guide available for download? I couldn't find it on the web page. If it's not available, can it be made available?

There's a particular reason why I think it's vitally important to provide this source code, and why I think a link to something like a LaTeX-source tarball (with all the figures and such needed to recreate the document) should be prominently placed next to the download for the PDF version: the documentation is licensed under the GNU Free Documentation License (GFDL). And, in clause 3 of the GFDL, the restriction is made that "If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material." (In this phrasing, an Opaque copy is a copy that cannot be edited, such as the .pdf file, and a Transparent copy would be something such as the tarball of source and images that I mentioned.

Thus, unless I myself have a Transparent copy of the documentation, I am not practically allowed by the license to distribute it in any quantity, and it is thus not as nearly open in a practical sense as the license would imply. (The lack of a Transparent copy of the documentation also makes it rather difficult to modify and reuse portions of it, despite the permission to do so granted by the license.) This bothers me, because it seems like an accidental oversight that doesn't reflect OpenCFD's intentions to make the code and documentation free.

Alternately, if OpenCFD does not wish to distribute the source to the documentation, would it be possible to also license it under something such as one of the Creative Commons licenses that do not require redistribution to include Transparent copies?

Thanks very much! And if there is anything that I can do to help make it possible to publish the source code (testing tarballs on a clean system, etc.), please feel free to ask.
  Reply With Quote

Old   December 6, 2005, 18:46
Default The PDF's included in OpenFOAM
Senior Member
Alberto Passalacqua
Join Date: Mar 2009
Location: Ames, Iowa, United States
Posts: 1,912
Rep Power: 34
alberto will become famous soon enoughalberto will become famous soon enough
The PDF's included in OpenFOAM is not protected, so you should be able to edit it using, for example, Adobe products.
It's not like having LaTeX sources, but it's better than nothing :-)
Alberto Passalacqua

GeekoCFD - A free distribution based on openSUSE 64 bit with CFD tools, including OpenFOAM. Available as in both physical and virtual formats (current status:
OpenQBMM - An open-source implementation of quadrature-based moment methods.

To obtain more accurate answers, please specify the version of OpenFOAM you are using.
alberto is offline   Reply With Quote

Old   December 12, 2005, 20:19
Default Thanks for the comment! Unf
Posts: n/a
Thanks for the comment!

Unfortunately, while that would enable a few typo corrections, it doesn't address the licensing issues at all. Without my having a so-called "Transparent" copy (which in this case means the LaTeX source), the GFDL license doesn't allow me to do something like redistribute the manual on my website. And that's the real problem I'm concerned about.
  Reply With Quote

Old   January 9, 2014, 15:43
New Member
Luis Cardona
Join Date: Mar 2011
Location: Medellin, Colombia
Posts: 6
Rep Power: 13
luiscardona is on a distinguished road
A little bit late but...

here there are, sources for OpenFOAM Users Guide and Programmers Guide in latex provided by OpenCAE (sorry, only in Japanese! Just better than nothing)
luiscardona is offline   Reply With Quote

Old   January 10, 2014, 13:44
Retired Super Moderator
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 10,965
Blog Entries: 45
Rep Power: 126
wyldckat is a name known to allwyldckat is a name known to allwyldckat is a name known to allwyldckat is a name known to allwyldckat is a name known to allwyldckat is a name known to all
Greetings to all!

@Luis: Good catch on a really old thread

Might as well make a status update of the current situation:
  1. The present generation of the official OpenFOAM documentation is licensed under the following license, and I quote:
    Originally Posted by
    This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  2. At, you can find two addendum pages done by the community:
  3. At this time, at least that I'm aware of, there is no public access to the LaTeX source code for the official documentation.
  4. There is a community effort in place to bring forth a community written high quality book about OpenFOAM, namely The CoCoons Project:
Best regards,
wyldckat is offline   Reply With Quote


Thread Tools Search this Thread
Search this Thread:

Advanced Search
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are Off
Pingbacks are On
Refbacks are On

Similar Threads
Thread Thread Starter Forum Replies Last Post
PBM availability. Kes FLUENT 15 June 26, 2016 02:46
Availability of previous time level values in UDF ranga sudarsan FLUENT 0 September 1, 2008 09:17
Availability of experimental combustion data? Mario Main CFD Forum 3 September 23, 2003 11:05
Scheme documentation and question MickaŽl Perrin FLUENT 0 July 4, 2002 05:21

All times are GMT -4. The time now is 22:52.