View source for Main Page

An OpenFOAM Wiki

'''This Wiki is now open to the public.'''

* Please consult these [[main_Policy | Guidelines]] before adding content.
* Feel free to use the discussion pages to propose changes and suggest content. Especially for the [[main_FAQ|FAQ]]
* Use the [[main_TestSite| Testing site]] if you haven't worked with a Wiki before.

If you experience any problems with this Wiki please contact me at my EMail (which can be found at [[User:Bgschaid]]). 

Significant changes to the status of this Wiki can be found at [[Current_events]].


== General ==

=== About OpenFOAM ===

OpenFOAM is an OpenSource CFD Toolbox. If you havnt heard about it before check it out at [http://www.opencfd.co.uk/openfoam/index.html the official Website]. A list of the features can be fount [http://www.opencfd.co.uk/openfoam/features.html#features here].

This Website is only supplementary to the official Website. If they contradict each other the official Website is right.

=== About Wikis ===

TODO: Wikis, for those who have never seen one

== OpenFOAM-Stuff in this Wiki ==

The main portion of this Wiki: all the things that have to do with OpenFOAM.

=== Documentation ===

Stuff that is meant to supplement the official documentation.

* [[main_FAQ|FAQ]]: Everything you always wanted to know about OpenFOAM, but were afraid to ask (because someone might have asked before)

* Addenda: Remarks about the official documentation (extensions, proposals for extensions, outdated information, comments)
** [[main_UserGuideAddendum|User Guide]]
** [[main_ProgrammerGuideAddendum|Programmer's Guide]]

==== The applications ====

Descriptions of and other information about the executables that come with OpenFOAM.

* [[main_OFSolvers|Solvers]]: The solvers that come with OpenFOAM

* [[main_OFUtilities|Utilities]]: All those useful utilities

* [[main_OFTutorials|The Tutorial Cases]]: Descriptions of the tutorial cases (and what the results should look like)

OK. The last point stretches the definition of ''application'' a bit.

==== Development ====

These things are for those who want to develop their own OpenFOAM-solver or utility

* [[main_CodingConventions|Conventions and Style]]: How to write your code.

* [[main_CodeStructure|Structure of the src-directory]]: What can be found where in the src-directory

* [[main_CodeSnipplets|Code snipplets]]: How common tasks are done with the classes OpenFOAM provides

==== Usage ====

These things help you to become a better Foamer.

* [[main_HowTos|How-To do things]]: Articles about specific topics. For instance how to set up a specific kind of simulation

* [[main_TipsAndTricks|Tips and Tricks]]: Short snipplets of information. How to make certain things work. What might be wrong if a certain solver doesn't converge. Articles from this section might be moved to the [[main_FAQ|FAQ]].

* [[main_KnownBugs|Known Bugs]]: Things that are known not to work in the current release of OpenFOAM

=== User Pages  ===

Who is using OpenFOAM and for what purposes.

* [[main_Users|Users]]: Persons and Institutions that use OpenFOAM

* [[main_Projects|Projects]]: Examples of projects that have used OpenFOAM (or are still using it)

=== Contributions ===

Utilities, Solvers and Examples that people want to make available to the public.

* [[main_ContribSolvers|Solvers]]: Solvers based on OpenFOAM

* [[main_ContribUtilities|Utilities]]: Utilities contributed by users

* [[main_ContribExamples|Examples]]: Example cases

== Editor's Stuff ==

Please read this before editing this Wiki.

* [[main_Policy | Policy and  conventions]]: If you want to add something to this Wiki please honor these guidelines.

* [[Help:Editing|The basics of editing]]: Basic editing commands, extensions installed in this Wiki etc

* [[main_TestSite| Testing site]]: if there is something that you want to try out: do it here


----
--[[User:Bgschaid|Bgschaid]] 14:09, 31 May 2005 (CEST)