Difference between revisions of "Main Page"
From OpenFOAMWiki
(→General) |
|||
| Line 18: | Line 18: | ||
Stuff that is meant to supplement the official documentation. | Stuff that is meant to supplement the official documentation. | ||
| + | |||
| + | * [[mainFAQ|FAQ]]: Everything you always wanted to know about OpenFOAM, but were afraid to ask (because someone might have asked before) | ||
| + | |||
| + | ==== The applications ==== | ||
| + | |||
| + | Descriptions of and other information about the executables that come with OpenFOAM. | ||
| + | |||
| + | * [[mainOFSolvers|Solvers]]: The solvers that come with OpenFOAM | ||
| + | |||
| + | * [[mainOFUtilities|Utilities]]: All those useful utilities | ||
| + | |||
| + | * [[mainOFTutorials|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 | ||
| + | |||
| + | * [[mainCodingConventions|Conventions and Style]]: How to write your code. | ||
| + | |||
| + | * [[mainCodeStructure|Structure of the src-directory]]: What can be found where in the src-directory | ||
| + | |||
| + | * [[mainCodeSnipplets|Code snipplets]]: How common tasks are done with the classes OpenFOAM provides | ||
| + | |||
=== User Pages === | === User Pages === | ||
| Line 23: | Line 48: | ||
Who is using OpenFOAM and for what purposes. | Who is using OpenFOAM and for what purposes. | ||
| + | * [[mainUsers|Users]]: Persons and Institutions that use OpenFOAM | ||
| + | |||
| + | * [[mainProjects|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. | ||
| + | |||
| + | * [[mainContribSolvers|Solvers]]: Solvers based on OpenFOAM | ||
| + | |||
| + | * [[mainContribUtilities|Utilities]]: Utilities contributed by users | ||
| + | |||
| + | * [[mainContribExamples|Examples]]: Example cases | ||
== Editor Stuff == | == Editor Stuff == | ||
| − | Please read this before | + | Please read this before editing this Wiki. |
* [[mainPolicy | Policy and conventions]]: If you want to add something to this Wiki please honor these guidlines. | * [[mainPolicy | Policy and conventions]]: If you want to add something to this Wiki please honor these guidlines. | ||
* [[mainTestSite| Testing site]]: if there is something that you want to try out: do it here | * [[mainTestSite| Testing site]]: if there is something that you want to try out: do it here | ||
Revision as of 22:05, 23 May 2005
An OpenFOAM Wiki
Contents
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)
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.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 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
