Difference between revisions of "Main Page"
From OpenFOAMWiki
m |
|||
| Line 4: | Line 4: | ||
* '''The Guidelines havn't been written yet. Please contact me before adding content.''' | * '''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 [[ | + | * '''Feel free to use the discussion pages to propose changes and suggest content. Especially for the [[main_FAQ|FAQ]] |
| − | * Use the [[ | + | * Use the [[main_TestSite| Testing site]] if you haven't worked with a Wiki before. |
== General == | == General == | ||
| Line 25: | Line 25: | ||
Stuff that is meant to supplement the official 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) | * Addenda: Remarks about the official documentation (extensions, proposals for extensions, outdated information, comments) | ||
| − | ** [[ | + | ** [[main_UserGuideAddendum|User Guide]] |
| − | ** [[ | + | ** [[main_ProgrammerGuideAddendum|Programmer's Guide]] |
==== The applications ==== | ==== The applications ==== | ||
| Line 35: | Line 35: | ||
Descriptions of and other information about the executables that come with OpenFOAM. | 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. | OK. The last point stretches the definition of ''application'' a bit. | ||
| Line 47: | Line 47: | ||
These things are for those who want to develop their own OpenFOAM-solver or utility | 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 |
| Line 58: | Line 58: | ||
Who is using OpenFOAM and for what purposes. | 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 === | === Contributions === | ||
| Line 66: | Line 66: | ||
Utilities, Solvers and Examples that people want to make available to the public. | 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 == | == Editor's Stuff == | ||
| Line 76: | Line 76: | ||
Please read this before editing this Wiki. | Please read this before editing this Wiki. | ||
| − | * [[ | + | * [[main_Policy | Policy and conventions]]: If you want to add something to this Wiki please honor these guidlines. |
| − | * [[ | + | * [[main_TestSite| Testing site]]: if there is something that you want to try out: do it here |
Revision as of 17:11, 30 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.
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)
- Addenda: Remarks about the official documentation (extensions, proposals for extensions, outdated information, comments)
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'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
