Difference between revisions of "Main Page"

Revision as of 12:09, 31 May 2005

An OpenFOAM Wiki

This Wiki is work in progress.

• The Guidelines havn't been written yet. Please contact me before adding content.
• Feel free to use the discussion pages to propose changes and suggest content. Especially for the FAQ
• Use the Testing site if you haven't worked with a Wiki before.

1 General

1.1 About OpenFOAM

TODO: General description, link to website

1.2 About Wikis

TODO: Wikis, for those who have never seen one

2 OpenFOAM-Stuff in this Wiki

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

2.1 Documentation

Stuff that is meant to supplement the official documentation.

• 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)
  • User Guide
  • Programmer's Guide

2.1.1 The applications

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

• Solvers: The solvers that come with OpenFOAM

• Utilities: All those useful utilities

• 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.

2.1.2 Development

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

• Conventions and Style: How to write your code.

• Structure of the src-directory: What can be found where in the src-directory

• Code snipplets: How common tasks are done with the classes OpenFOAM provides

2.1.3 Usage

These things help you to become a better Foamer.

• How-To do things: Articles about specific topics. For instance how to set up a specific kind of simulation

• 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 FAQ.

2.2 User Pages

Who is using OpenFOAM and for what purposes.

• Users: Persons and Institutions that use OpenFOAM

• Projects: Examples of projects that have used OpenFOAM (or are still using it)

2.3 Contributions

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

• Solvers: Solvers based on OpenFOAM

• Utilities: Utilities contributed by users

• Examples: Example cases

3 Editor's Stuff

Please read this before editing this Wiki.

• Policy and conventions: If you want to add something to this Wiki please honor these guidlines.

• Testing site: if there is something that you want to try out: do it here

--Bgschaid 14:09, 31 May 2005 (CEST)