Difference between revisions of "FAQ/Wiki/Ideas"

From OpenFOAMWiki
< FAQ‎ | Wiki
(Kick off the ideas page)
 
(Description: idea lists have been populated)
Line 8: Line 8:
 
== Ideas for new pages ==
 
== Ideas for new pages ==
  
TODO: Will populate in a few minutes...
+
=== The page [[Installation/Linux/OpenFOAM-2.2.x]] does not yet exist ===
 +
The page [[Installation/Linux/OpenFOAM-2.2.x]] doesn't exist yet, because it's waiting for the page [[Installation/Linux/OpenFOAM-2.1.x]] to be completed, so that a quick ''copy-paste-adapt procedure'' could be performed.
 +
 
 +
Nonetheless, feel free to write a new one, even if only partially based on the incomplete one [[Installation/Linux/OpenFOAM-2.1.x]].
 +
 
 +
 
 +
=== Create a new page for gathering links and bibliography on comparisons between OpenFOAM and commercial CFD ===
 +
 
 +
This is a frequent question asked on the forum and we haven't got yet a complete list on OpenFOAM vs commercial CFD.
 +
 
 +
This was originally suggested by [http://www.cfd-online.com/Forums/members/far.html Far] to [http://www.cfd-online.com/Forums/members/wyldckat.html Wyldckat], with this link on CFX vs OpenFOAM: [http://www.forwind.de/sowe/Site/Program_files/SOWE2013_Dose.pdf]
 +
 
 +
 
 +
=== Create the page for [[multiphaseEulerFoam]] ===
 +
Create the page for [[multiphaseEulerFoam]] and add this valuable information: [http://www.cfd-online.com/Forums/openfoam/113823-multiphaseeulerfoam.html]
 +
 
 +
 
 +
=== How to install navalFoam ===
 +
Create an HowTo page for this: [http://www.cfd-online.com/Forums/openfoam-installation/118174-openfoam-installation-navalfoam.html#post432934]
 +
 
 +
Keep in mind that navalFoam and shipFoam are somewhat related to each other.
 +
 
 +
=== Create the dedicated section for function objects ===
 +
 
 +
Create the dedicated section for [[Main_OFFunctionObjects]] and move the following pages to there:
 +
* [[Tip Function Object systemCall|Using the function object systemCall]]
 +
* [[Tip Function Object writeRegisteredObject|Using the function object writeRegisteredObject]]
 +
* [[Tip Function Object jobControl|Using the function object jobControl]]
 +
 
 +
In addition, add a redirect for the page [[functionObjects]], which is very used in a lot of the utilities [[Main_OFUtilities]].
  
  
 
== Ideas for improving existing pages ==
 
== Ideas for improving existing pages ==
  
TODO: Will populate in a few minutes...
+
=== Ideas for new FAQ entries ===
 +
 
 +
==== How to provide a test case for the forum ====
 +
Many of new OpenFOAM users haven't got a clear idea on how example cases should be provided on the forum, so that it's easier to assist them. Therefore, we need a FAQ entry that explains how to prepare such a case.
 +
 
 +
 
 +
==== How to find dictionary files ====
 +
This is one of those basic finds on Linux and Mac OS X, which should be as simple as running the command:
 +
<bash>find $WM_PROJECT_DIR -name "*Dict"</bash>
 +
 
 +
 
 +
==== Create entry that explains how to update the OF version images ====
 +
Basically, the idea is to Copy-paste-improve [[Help_talk:Editing]] onto [[http://openfoamwiki.net/index.php/FAQ/Wiki]]. The template package was created and ''dropped'' at [[Help_talk:Editing]], but no specific instructions are provided on how to use them and apply them.
 +
 
 +
==== Compile information on ParaView/paraFoam ====
 +
[[User:Wyldckat]] has already created several helpful posts at [http://www.cfd-online.com/Forums/ CFD-Online's forums] on how to use ParaFoam and ParaView:
 +
* [http://www.cfd-online.com/Forums/paraview/ ParaView forum]
 +
* [http://www.cfd-online.com/Forums/openfoam-paraview/ ParaView & paraFoam forum]
 +
 
 +
The objective is to compile the a FAQ list on all of the explained topics so far, so that it'll be easier to find said solutions.
 +
 
 +
 
 +
=== Improvements for [[HowTo_debugging]] ===
 +
 
 +
==== Add information on how to to make sure flags defined for custom boundary conditions get processed ====
 +
This is explained: [http://www.cfd-online.com/Forums/openfoam-programming-development/123923-debug-switches.html#post454191 here]

Revision as of 10:53, 2 November 2013

1 Description

The objective of this page is to provide a centralized list of ideas for new wiki pages and ideas for improving existing pages.

If you want to add a new idea, simple add it to the correct section. If you want to discuss or ask about any one of the still open idea topics, please use the discussion page Talk:FAQ/Wiki/Ideas.


1.1 Ideas for new pages

1.1.1 The page Installation/Linux/OpenFOAM-2.2.x does not yet exist

The page Installation/Linux/OpenFOAM-2.2.x doesn't exist yet, because it's waiting for the page Installation/Linux/OpenFOAM-2.1.x to be completed, so that a quick copy-paste-adapt procedure could be performed.

Nonetheless, feel free to write a new one, even if only partially based on the incomplete one Installation/Linux/OpenFOAM-2.1.x.


1.1.2 Create a new page for gathering links and bibliography on comparisons between OpenFOAM and commercial CFD

This is a frequent question asked on the forum and we haven't got yet a complete list on OpenFOAM vs commercial CFD.

This was originally suggested by Far to Wyldckat, with this link on CFX vs OpenFOAM: [1]


1.1.3 Create the page for multiphaseEulerFoam

Create the page for multiphaseEulerFoam and add this valuable information: [2]


1.1.4 How to install navalFoam

Create an HowTo page for this: [3]

Keep in mind that navalFoam and shipFoam are somewhat related to each other.

1.1.5 Create the dedicated section for function objects

Create the dedicated section for Main_OFFunctionObjects and move the following pages to there:

In addition, add a redirect for the page functionObjects, which is very used in a lot of the utilities Main_OFUtilities.


1.2 Ideas for improving existing pages

1.2.1 Ideas for new FAQ entries

1.2.1.1 How to provide a test case for the forum

Many of new OpenFOAM users haven't got a clear idea on how example cases should be provided on the forum, so that it's easier to assist them. Therefore, we need a FAQ entry that explains how to prepare such a case.


1.2.1.2 How to find dictionary files

This is one of those basic finds on Linux and Mac OS X, which should be as simple as running the command:

find $WM_PROJECT_DIR -name "*Dict"


1.2.1.3 Create entry that explains how to update the OF version images

Basically, the idea is to Copy-paste-improve Help_talk:Editing onto [[4]]. The template package was created and dropped at Help_talk:Editing, but no specific instructions are provided on how to use them and apply them.

1.2.1.4 Compile information on ParaView/paraFoam

User:Wyldckat has already created several helpful posts at CFD-Online's forums on how to use ParaFoam and ParaView:

The objective is to compile the a FAQ list on all of the explained topics so far, so that it'll be easier to find said solutions.


1.2.2 Improvements for HowTo_debugging

1.2.2.1 Add information on how to to make sure flags defined for custom boundary conditions get processed

This is explained: here