All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
foamDoc.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
25 
26 \mainpage Free, Open Source Software from the OpenFOAM Foundation
27 
28 \section about About OpenFOAM
29 
30  OpenFOAM is a free, open source CFD software package released free and
31  open-source under the GNU General Public License by the,
32  <a href="http://openfoam.org">OpenFOAM Foundation</a>. It has a large
33  user base across most areas of engineering and science, from both commercial
34  and academic organisations. OpenFOAM has an extensive range of features to
35  solve anything from complex fluid flows involving chemical reactions,
36  turbulence and heat transfer, to solid dynamics and electromagnetics.
37  <a href="http://openfoam.org/features">More ...</a>
38 
39 \section layout OpenFOAM Directory Structure
40 
41  OpenFOAM comprises of four main directories:
42  - \b src: the core OpenFOAM libraries
43  - \b applications: solvers and utilities
44  - \b tutorials: cases that demonstrate a wide-range of OpenFOAM
45  functionality
46  - \b test: cases that test and validate individual models or aspects of
47  OpenFOAM functionality
48  - \b etc: configuration files
49  - \b bin: scripts
50  - \b doc: documentation
51 
52 \*---------------------------------------------------------------------------*/