Merge branch 'feature/initialize' into 'master'

Feature/initialize

See merge request !2928

dumux/common/initialize.hh

+// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+// vi: set et ts=4 sw=4 sts=4:
+/*****************************************************************************
+ *   See the file COPYING for full copying permissions.                      *
+ *                                                                           *
+ *   This program 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.                                     *
+ *                                                                           *
+ *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.   *
+ *****************************************************************************/
+/*!
+ * \file
+ * \ingroup Common
+ * \brief The initialize function to be called before using Dumux
+ */
+#ifndef DUMUX_COMMON_INITIALIZE_HH
+#define DUMUX_COMMON_INITIALIZE_HH
+
+#include <dune/common/parallel/mpihelper.hh>
+
+namespace Dumux {
+
+void initialize(int& argc, char* argv[])
+{
+    // initialize MPI if available
+    // otherwise this will create a sequential (fake) helper
+    Dune::MPIHelper::instance(argc, argv);
+}
+
+} // end namespace Dumux
+
+#endif

test/porousmediumflow/1p/incompressible/main.cc

@@ -38,6 +38,7 @@
 #include <dumux/common/properties.hh>
 #include <dumux/common/parameters.hh>
 #include <dumux/common/dumuxmessage.hh>
+#include <dumux/common/initialize.hh>
 
 #include <dumux/io/vtkoutputmodule.hh>
 #include <dumux/io/grid/gridmanager.hh>
@@ -82,8 +83,12 @@ int main(int argc, char** argv)
 
     using TypeTag = Properties::TTag::TYPETAG;
 
-    // initialize MPI, finalize is done automatically on exit
-    const auto& mpiHelper = Dune::MPIHelper::instance(argc, argv);
+    // initialize Dumux (parallel helpers)
+    // always call this before any other code
+    Dumux::initialize(argc, argv);
+
+    // get an instance of the MPI helper
+    const auto& mpiHelper = Dune::MPIHelper::instance();
 
     // print dumux start message
     if (mpiHelper.rank() == 0)

test/porousmediumflow/3p3c/infiltration/main.cc

@@ -31,6 +31,7 @@
 #include <dumux/common/properties.hh>
 #include <dumux/common/parameters.hh>
 #include <dumux/common/dumuxmessage.hh>
+#include <dumux/common/initialize.hh>
 #include <dumux/common/timeloop.hh>
 
 #include <dumux/linear/amgbackend.hh>
@@ -55,8 +56,12 @@ int main(int argc, char** argv)
     ////////////////////////////////////////////////////////////
     ////////////////////////////////////////////////////////////
 
-    // initialize MPI, finalize is done automatically on exit
-    const auto& mpiHelper = Dune::MPIHelper::instance(argc, argv);
+    // initialize Dumux (parallel helpers)
+    // always call this before any other code
+    Dumux::initialize(argc, argv);
+
+    // get an instance of the MPI helper
+    const auto& mpiHelper = Dune::MPIHelper::instance();
 
     // print dumux start message
     if (mpiHelper.rank() == 0)

test/porousmediumflow/richards/lens/main.cc

@@ -36,6 +36,7 @@
 #include <dumux/common/properties.hh>
 #include <dumux/common/parameters.hh>
 #include <dumux/common/dumuxmessage.hh>
+#include <dumux/common/initialize.hh>
 #include <dumux/linear/linearsolvertraits.hh>
 
 #if DUNE_VERSION_GTE(DUNE_ISTL,2,8)
@@ -68,8 +69,12 @@ int main(int argc, char** argv)
     // define the type tag for this problem
     using TypeTag = Properties::TTag::TYPETAG;
 
-    // initialize MPI, finalize is done automatically on exit
-    const auto& mpiHelper = Dune::MPIHelper::instance(argc, argv);
+    // initialize Dumux (parallel helpers)
+    // always call this before any other code
+    Dumux::initialize(argc, argv);
+
+    // get an instance of the MPI helper
+    const auto& mpiHelper = Dune::MPIHelper::instance();
 
     // print dumux start message
     if (mpiHelper.rank() == 0)