opm-simulators/opm/simulators/opm-simulators_doxygen_main.hpp

36 lines
1.1 KiB
C++
Raw Normal View History

/*
Copyright 2013, 2016 SINTEF ICT, Applied Mathematics.
This file is part of the Open Porous Media project (OPM).
OPM 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.
OPM 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 OPM. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPM_OPM-SIMULATORS_DOXYGEN_MAIN_HEADER_INCLUDED
#define OPM_OPM-SIMULATORS_DOXYGEN_MAIN_HEADER_INCLUDED
/** \mainpage Documentation for the opm-simulators library.
<h3>Solvers and simulators</h3>
The opm-simulators module is the home for the Flow reservoir
simulator, the Ebos experimental simulator and library functionality
on which they both depend.
*/
#endif // OPM_OPM-SIMULATORS_DOXYGEN_MAIN_HEADER_INCLUDED