[GerhardHolzinger]

I would like to share some of my knowledge on OpenFOAM.

What started as an attempt to write a beginners manual for following colleagues on my department turned into a large pile of accumulated know-how.

You can find this document at the following site:

https://github.com/OSCCAR-PFM/OSCCAR...Manual_PFM.pdf

It is a collection of stuff I care about, I wanted to know or attempted to learn. It goes without saying, that this collection is fragmentary and ther may be errors.
However, it may contain stuff you might find useful.

[wyldckat]

Dear Gerhard,

Many, many thanks for sharing this document!

I've been eager to ask you the following questions as soon as I read your post, but only now did I manage to come here, so here goes:

1. What's the license for this document? The repository has what seems to be the (somewhat) default GPL v3 license: https://github.com/OSCCAR-PFM/OSCCAR...master/LICENSE - the only problem is that said license is usually meant for source code and not for documentation. The respective GNU license for documentation is usually the GFDL: http://www.gnu.org/copyleft/fdl.html
2. Can most of the contents of this document be re-written in wiki form at openfoamwiki.net? The content at that wiki would then be automatically licensed under the GFDL 1.3 as well.
3. Would it be possible to also reuse the content for creating documents for the Cocoons Project? http://www.cocoons-project.org/ - it's essentially under the same license with a few additions: http://www.cocoons-project.org/the-c...roject-license

I ask this because there is so much information in your document, that it feels like it should be expanded on by as many people that are willing to help!


In addition, if your response is that you allow to use this material in one or either formats, and although it's somewhat easy to copy-paste-adapt the text directly from PDF to wiki format, I have to ask: could the original document/files be used as a basis for easier copy-paste-adapting? If you don't want the original to be made public, the people responsible for copy-paste-adapting could keep a copy of said files privately only for the duration of transposition.

Best regards,
Bruno

[GerhardHolzinger]

Hi,

thanks for the positive feedback.

1. I haven't given much thought on licensing up to now. I will have a look into that one.
2. The contents can be rewritten for the wiki, I have no problem with that.
3. Also, reusing this stuff for e.g. the CoCoons project is also ok with me. In fact I already started a document about blockMesh with the CoCoons template, but I haven't gotten far yet.

The document is written with LyX http://www.lyx.org/, thats a graphical LaTeX editor, which has a bit of a word-like feeling, but it uses plain LaTeX for document creation.

I chose to upload only the pdf to spare the internets the ugliness of my LaTeX coding. However, if somebody want's to put my stuff into the wiki, I can share my source files.

[Astrodan]

I just had a few glances at the document, got confused, tested, and realized its a not my fault :

Page 157, Listing 233 misses the last line and should be:

The pointer points to 42
The pointer points to 13
The pointer points to 11

Anyway, thanks for sharing, seems to be a lot of useful information.

[GerhardHolzinger]

Originally Posted by Astrodan

I just had a few glances at the document, got confused, tested, and realized its a not my fault :

Page 157, Listing 233 misses the last line and should be:



Anyway, thanks for sharing, seems to be a lot of useful information.

Fixed with the latest push.

[Astrodan]

Page 213, above equation (215) the sentence does not seem complete.

Apart from that nice explanation of phi. I read it instead of searching for what I was after in the first place...

[GerhardHolzinger]

Thanks for the report. Now, I have to find out what I wanted to say. It has been a while since I wrote this stuff.

[GerhardHolzinger]

I tried to fix it somehow, I hope I didn't mess up the explanation.

[GerhardHolzinger]

The online-location of the collection moved to https://github.com/pfm-admin/OSCCAR-doc

I am not sure how long the old repo will be online, however, any further updates will be pushed to the new location.

[elvis]

Sorry Gerhard,

the link you provide leads to an error message

page not found

404
this is not the web page you are looking for

Can you please fix that

thanks for sharing your knowledge

[GerhardHolzinger]

My bad,

I was posting the wrong link, noticeable by the admin in the path, sorry for that.

Here is the correct link: https://github.com/ParticulateFlow/osccar-doc

[rudolf.hellmuth]

Thanks Dr. Holzinger, this is the best manual for coding OpenFOAM I have ever found!


The link to your github should definitively be on wiki:Frontpage_Learn! Would you mind if I put a link to your manual's github on the wiki?

[GerhardHolzinger]

Feel free to proceed.

[rudolf.hellmuth]

Originally Posted by GerhardHolzinger

Feel free to proceed.

Done! The link to your github is on block 3: Learn of the wiki.

[GerhardHolzinger]

Hi,

please change the link to https://github.com/ParticulateFlow/osccar-doc since the old repo will at some point be discontinued.

[rudolf.hellmuth]

Originally Posted by GerhardHolzinger

Hi,

please change the link to https://github.com/ParticulateFlow/osccar-doc since the old repo will at some point be discontinued.

Done!
In the case you don't know, anyone can modify the wiki page.

[Delcraft]

Hello Gerhard,

What a great work! Thank you so much, it's exactly what I looked for!

[GerhardHolzinger]

Originally Posted by Delcraft

Hello Gerhard,

What a great work! Thank you so much, it's exactly what I looked for!

It is great that you find it useful. The thing is gradually and slowly expanded, so check the git repo occasionally. However, right now, I am supposed to write my thesis. So, there won't be much growth in the near future.
When I am finished with my thesis, some parts of it, may find their way into the manual.

[GerhardHolzinger]

I am shamelessly bumping my old thread announcing my so-called manual.

The manual continues to be hosted on the site of my old employer, and it has recieved sporadic attention over the years. The page count stands now at 383.

The manual serves its purpose for me, to record and document stuff I found out about OpenFOAM, persistently well.

If you find it also useful, good for you. Since I am not writing a text book, I spend less (no) effort on achieving a good didactic structure. Sorry for that.

https://github.com/ParticulateFlow/OSCCAR-doc

[GerhardHolzinger]

Once, again I am shamelessly promoting my old thread on my so-called manual.

Another one of the sporadic updates has been made, and the page count has surpassed 400.

If you find the manual useful, good for you. Since it has been a long time since I have started the manual, and I am only adding to it, there might be many outdated sections. I do not check whether certain sections are still valid with current OpenFOAM installation, sorry for that.

https://github.com/ParticulateFlow/OSCCAR-doc