/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2018 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

\mainpage Free, Open Source Software from the OpenFOAM Foundation

\section about About OpenFOAM

    OpenFOAM is a free, open source CFD software package released free and
    open-source under the GNU General Public License by the,
    <a href="http://openfoam.org">OpenFOAM Foundation</a>.  It has a large
    user base across most areas of engineering and science, from both commercial
    and academic organisations.  OpenFOAM has an extensive range of features to
    solve anything from complex fluid flows involving chemical reactions,
    turbulence and heat transfer, to solid dynamics and electromagnetics.
    <a href="http://openfoam.org/features">More ...</a>

\section layout OpenFOAM Directory Structure

    OpenFOAM comprises of four main directories:
    - \b src: the core OpenFOAM libraries
    - \b applications: solvers and utilities
    - \b tutorials: cases that demonstrate a wide-range of OpenFOAM
         functionality
    - \b test: cases that test and validate individual models or aspects of
         OpenFOAM functionality
    - \b etc: configuration files
    - \b bin: scripts
    - \b doc: documentation

\*---------------------------------------------------------------------------*/