Difference between revisions of "Tutorials/Before Getting Started"

From OpenFOAMWiki
m (Wyldckat moved page OpenFOAM/Getting Started to Tutorials/Before Getting Started without leaving a redirect: Better location for it)
(revised the already written text and added a bit more structure)
Line 7: Line 7:
  
  
Requirements before you continue reading:
+
Requirements before you continue reading this page (feel free to skip this at your own risk):
 
# Be aware that OpenFOAM technology is open and free as a technology and as in ''freedom'', as described by the Free Software Foundation: [https://www.gnu.org/philosophy/free-sw.html What is free software?]
 
# Be aware that OpenFOAM technology is open and free as a technology and as in ''freedom'', as described by the Free Software Foundation: [https://www.gnu.org/philosophy/free-sw.html What is free software?]
 
#* This does '''not''' mean that it's cost-free. The primary cost associated to using OpenFOAM technology is ''Time''... and since ''time is money'', that's where its real costs reside.
 
#* This does '''not''' mean that it's cost-free. The primary cost associated to using OpenFOAM technology is ''Time''... and since ''time is money'', that's where its real costs reside.
 
# OpenFOAM and any and all of its variants and forks are bound by the GNU General Public License. It's advisable that you get a bit familiar with what this allows you to do or not, as described here: [http://www.gnu.org/licenses/gpl-faq.html Frequently Asked Questions about the GNU Licenses]
 
# OpenFOAM and any and all of its variants and forks are bound by the GNU General Public License. It's advisable that you get a bit familiar with what this allows you to do or not, as described here: [http://www.gnu.org/licenses/gpl-faq.html Frequently Asked Questions about the GNU Licenses]
# Be prepared to read a lot of information!
+
# OPENFOAM® is a trade mark. So much that you'll see this very often: <blockquote>This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM®  and OpenCFD®  trade marks.</blockquote>
 +
#* For more details: [http://openfoam.com/legal/trademark-policy.php OpenCFD Limited Trade Mark Policy]
 +
# '''Be prepared to read a lot of information!'''
  
  
Line 23: Line 25:
  
 
= State of Mind  =
 
= State of Mind  =
Looks like a weird section name, isn't it? Well, this is because OpenFOAM technology defies the currently traditional mind set of software users. You're probably use friendly and forgiving Graphical User Interfaces, with varying degrees of friendliness. And possibly want to use OpenFOAM in Windows or Mac OS X.
+
Looks like a weird section name, isn't it? Well, this is because OpenFOAM technology defies the currently traditional mind set of most software users.
  
Well, if you're looking for any or all of those, then have a look at the following wiki pages:
+
You're probably more familiar with friendly and forgiving ''Graphical User Interfaces'' (GUI), with varying degrees of friendliness. And you possibly want to use OpenFOAM technology in Windows or Mac OS X. Well, if you're looking for any or all of those, then have a look at the following wiki pages:
 
* Known Graphical User Interfaces for using OpenFOAM: [[GUI]]
 
* Known Graphical User Interfaces for using OpenFOAM: [[GUI]]
 
* Known ways to install and use OpenFOAM on Windows: [[Windows]]
 
* Known ways to install and use OpenFOAM on Windows: [[Windows]]
Line 31: Line 33:
  
  
This is because the primary target Operating System for OpenFOAM is Linux. The reason for this is explained here: [http://openfoam.com/legal/open-source.php OpenFOAM is Open Source]
+
This is because the primary target Operating System for OpenFOAM is Linux and there is no official GUI. The reasons for this are explained here:
 +
* Reason why Linux is the primary supported Operating System: [http://openfoam.com/legal/open-source.php OpenFOAM is Open Source]
 +
* Reason why there is no GUI: [[FAQ/General#Where is FoamX?|Where is FoamX?]]
  
  
But sooner or later you will need to have the following state of mind when it comes to using OpenFOAM technology:
+
But even if you find a good GUI, sooner or later you will need to have the following state of mind when it comes to using OpenFOAM technology:
# First of all, do not think about this as being ''too hard'' or ''too complex''. But it can - and it will - take a considerable amount of time to get to know it well enough.
+
# First of all, do not think about this as being ''too hard'' or ''too complex''. But it can (and it will) take a considerable amount of time to get to know it well enough.
# ''Complexity is in the eye of the beholder'' - This to say that you should never, ever, try to solve your final problem directly. At least not until you've gained enough experience.
+
# ''Complexity is in the eye of the beholder'' - This to say that you should never, '''ever''', try to solve your final problem directly... at least not until you've gained enough experience.
# Do not ''speed through'' the available instructions. You should always carefully read and study the available instructions when it comes to OpenFOAM technology and CFD.
+
#* And experience can only be gained if you start with one or more very simple example cases and then gradually add complexity, one detail at a time.
# Every single detail matters more than you're likely willing to care about. This will be exemplified in the next section [#Common mistakes|Common mistakes].
+
# Do not ''speed through'' any available instructions you can find. You should always carefully read and study the available instructions when it comes to OpenFOAM technology and CFD.
# Have a journal where you write down of what you've done, what errors you've made and how you've fixed them. Sooner or later you'll repeat those same errors and/or have to reproduce the same results.
+
# Every single detail matters more than you're likely willing to care about. This will be exemplified in the next section [[#Common mistakes|Common mistakes]].
 +
# Have a journal where you write down of what you've done, what errors you've made and how you've fixed them. Sooner or later, you'll repeat those same errors and/or have to reproduce the same results.
 
# Keep in mind that Computational Fluid Dynamics (CFD) and OpenFOAM technology are tools of science and mathematics, through the use of digital/computational power. In other words:
 
# Keep in mind that Computational Fluid Dynamics (CFD) and OpenFOAM technology are tools of science and mathematics, through the use of digital/computational power. In other words:
 
#* Science: You should always keep in mind that what you're using and doing needs to be validated whenever possible. More details in section [[#Verify/validate your results|Verify/validate your results]].
 
#* Science: You should always keep in mind that what you're using and doing needs to be validated whenever possible. More details in section [[#Verify/validate your results|Verify/validate your results]].
Line 47: Line 52:
  
 
== Common mistakes ==
 
== Common mistakes ==
TODO
+
'''TODO'''
 +
 
  
 
== Verify/validate your results ==
 
== Verify/validate your results ==
TODO
+
'''TODO'''
 +
 
  
 
== Mathematical constraints ==
 
== Mathematical constraints ==
TODO
+
'''TODO'''
 +
 
  
 
== Computational limitations ==
 
== Computational limitations ==
TODO
+
'''TODO'''
 +
 
 +
 
 +
= How to get started with OpenFOAM =
 +
Learning how to use OpenFOAM is something that has to be done gradually, whether you like it or not.
 +
 
 +
'''TODO'''
 +
 
  
 
[[Category:Incomplete pages]]
 
[[Category:Incomplete pages]]

Revision as of 15:54, 4 January 2015

1 Introduction

Actually, this is more of a disclaimer than an introduction, because:

  1. This page aims to give you, the reader, a good sense of direction when it comes to using OpenFOAM technology.
  2. This page will not explain any specific details about how to use OpenFOAM and any Forks and Variants is has (which is why we'll refer to it as OpenFOAM technology).
  3. This page is an attempt at making you, the reader, better prepared on how to get started on using OpenFOAM technology.


Requirements before you continue reading this page (feel free to skip this at your own risk):

  1. Be aware that OpenFOAM technology is open and free as a technology and as in freedom, as described by the Free Software Foundation: What is free software?
    • This does not mean that it's cost-free. The primary cost associated to using OpenFOAM technology is Time... and since time is money, that's where its real costs reside.
  2. OpenFOAM and any and all of its variants and forks are bound by the GNU General Public License. It's advisable that you get a bit familiar with what this allows you to do or not, as described here: Frequently Asked Questions about the GNU Licenses
  3. OPENFOAM® is a trade mark. So much that you'll see this very often:
    This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.
  4. Be prepared to read a lot of information!


2 Names and References

The following are the primary references when it comes to OpenFOAM technology:

Beyond this, there are several forks and variants, which are documented here: Forks and Variants - including the details on what a fork and variant is in this context.


3 State of Mind

Looks like a weird section name, isn't it? Well, this is because OpenFOAM technology defies the currently traditional mind set of most software users.

You're probably more familiar with friendly and forgiving Graphical User Interfaces (GUI), with varying degrees of friendliness. And you possibly want to use OpenFOAM technology in Windows or Mac OS X. Well, if you're looking for any or all of those, then have a look at the following wiki pages:


This is because the primary target Operating System for OpenFOAM is Linux and there is no official GUI. The reasons for this are explained here:


But even if you find a good GUI, sooner or later you will need to have the following state of mind when it comes to using OpenFOAM technology:

  1. First of all, do not think about this as being too hard or too complex. But it can (and it will) take a considerable amount of time to get to know it well enough.
  2. Complexity is in the eye of the beholder - This to say that you should never, ever, try to solve your final problem directly... at least not until you've gained enough experience.
    • And experience can only be gained if you start with one or more very simple example cases and then gradually add complexity, one detail at a time.
  3. Do not speed through any available instructions you can find. You should always carefully read and study the available instructions when it comes to OpenFOAM technology and CFD.
  4. Every single detail matters more than you're likely willing to care about. This will be exemplified in the next section Common mistakes.
  5. Have a journal where you write down of what you've done, what errors you've made and how you've fixed them. Sooner or later, you'll repeat those same errors and/or have to reproduce the same results.
  6. Keep in mind that Computational Fluid Dynamics (CFD) and OpenFOAM technology are tools of science and mathematics, through the use of digital/computational power. In other words:
    • Science: You should always keep in mind that what you're using and doing needs to be validated whenever possible. More details in section Verify/validate your results.
    • Mathematics: CFD relies on tons of mathematics, specially computational mathematics. More details in section Mathematical constraints
    • Computational power: RAM, disk space, numerical precision, and so on. These limitations will dictate what you can or cannot do with CFD and OpenFOAM technology. More details in section Computational limitations.


3.1 Common mistakes

TODO


3.2 Verify/validate your results

TODO


3.3 Mathematical constraints

TODO


3.4 Computational limitations

TODO


4 How to get started with OpenFOAM

Learning how to use OpenFOAM is something that has to be done gradually, whether you like it or not.

TODO