From b5245ba0499b83dff9d7d48e06addc12ca0e6953 Mon Sep 17 00:00:00 2001
From: Timo Koch <timo.koch@iws.uni-stuttgart.de>
Date: Sat, 29 Oct 2016 01:52:05 +0200
Subject: [PATCH] [start] Put dumux message in its own header
---
dumux/common/dumuxmessage.hh | 180 +++++++++++++++++++++++++++++++++++
dumux/common/start.hh | 168 +++-----------------------------
2 files changed, 191 insertions(+), 157 deletions(-)
create mode 100644 dumux/common/dumuxmessage.hh
diff --git a/dumux/common/dumuxmessage.hh b/dumux/common/dumuxmessage.hh
new file mode 100644
index 0000000000..825857b3cf
--- /dev/null
+++ b/dumux/common/dumuxmessage.hh
@@ -0,0 +1,180 @@
+// -*- 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 2 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
+ * \brief Provides the class creating the famous dumux start and end messages
+ */
+#ifndef DUMUX_MESSAGE_HH
+#define DUMUX_MESSAGE_HH
+
+#include <iostream>
+#include <ctime>
+
+namespace Dumux
+{
+
+/*!
+ * \ingroup Start
+ * \brief Dumux start and end message.
+ */
+class DumuxMessage
+{
+ //! The current number of messages. Please adjust if you add one.
+ static const int nMessages_ = 11;
+
+public:
+
+ /*!
+ * \brief Selects random messages to write out at the start and end of a simulation run.
+ * \param firstCall Indicates if it's the first call and we have to dice (simulation is starting).
+ */
+ static void print(bool firstCall = false)
+ {
+ // initialize in case someone forgets to set first call
+ static int dice = 8;
+
+ if(firstCall)
+ {
+ // roll the dice to decide which start message will be displayed
+ std::srand(std::time(0));
+ dice = std::rand() % (nMessages_ + 1);
+ }
+
+ std::cout << std::endl;
+
+ switch (dice)
+ {
+ case 0:
+ if(firstCall)
+ std::cout << "Welcome aboard DuMuX airlines. Please fasten your seatbelts! "
+ << "Emergency exits are near the time integration." << std::endl;
+ else
+ std::cout << "We hope that you enjoyed simulating with us " << std::endl
+ << "and that you will choose us next time, too." << std::endl;
+ break;
+ case 1:
+ if(firstCall)
+ std::cout << "Let's get the cow off the ice." << std::endl;
+ else
+ std::cout << "DuMuX got the cow off the ice." << std::endl;
+ break;
+ case 2:
+ if(firstCall)
+ std::cout << "Science, my lad, is made up of mistakes, but they are "
+ << "mistakes which it is useful to make, because they lead little "
+ << "by little to the truth." << std::endl
+ << " - Jules Verne, A journey to the center of the earth" << std::endl;
+ else
+ std::cout << "[We see that] science is eminently perfectible, and that each theory has "
+ << "constantly to give way to a fresh one." << std::endl
+ << " - Jules Verne, Journey to the Center of the Earth" << std::endl;
+
+ break;
+ case 3:
+ if(firstCall)
+ std::cout << "Wherever he saw a hole he always wanted to know the depth of it. "
+ << "To him this was important." << std::endl
+ << " - Jules Verne, A journey to the center of the earth" << std::endl;
+ else
+ std::cout << "We may brave human laws, but we cannot resist natural ones." << std::endl
+ << " - Jules Verne, 20,000 Leagues Under the Sea" << std::endl;
+ break;
+ case 4:
+ if(firstCall)
+ std::cout << "Silence - to delight Bernd." << std::endl;
+ else
+ std::cout << std::endl << std::endl;
+ break;
+ case 5:
+ std::cout << "Don't panic... !" << std::endl;
+ break;
+ case 6:
+ if(firstCall)
+ std::cout << "You idiot! You signed the order to destroy Earth!" << std::endl
+ << " - Douglas Adams, HGttG" << std::endl;
+ else
+ std::cout << "Marvin: I've been talking to the main computer." << std::endl
+ << "Arthur: And?" << std::endl
+ << "Marvin: It hates me." << std::endl
+ << " - Douglas Adams, HGttG" << std::endl;
+ break;
+ case 7:
+ if(firstCall)
+ std::cout << "In the beginning the Universe was created. This has made a lot of "
+ << "people very angry and has been widely regarded as a bad move.!" << std::endl
+ << " - Douglas Adams, HGttG " << std::endl;
+ else
+ std::cout << "Forty-two. I checked it very thoroughly, and that quite definitely is the answer. I think "
+ << "the problem, to be quite honest with you, is that you\'ve never actually known what the question is." << std::endl
+ << " - Douglas Adams, HGttG " << std::endl;
+ break;
+ case 8:
+ std::cout << " ## @@@@ @ @ @ @" << std::endl;
+ std::cout << " ### # @ @ @@ @@ @ " << std::endl;
+ std::cout << " ## # @ @ @ @ @ @ @ @ @ @ @" << std::endl;
+ std::cout << " ## # @ @ @ @ @ @ @ @ " << std::endl;
+ std::cout << " # # @@@@ @@@ @ @ @@@ " << std::endl;
+ std::cout << " # # " << std::endl;
+ std::cout << " # # " << std::endl;
+ std::cout << " # ## %%% " << std::setw(8) << std::right << DUMUX_VERSION << std::endl;
+ std::cout << " # ### % % %% %% " << std::endl;
+ std::cout << "#### #%%% %% %%%%% %%%%%%%%%%%%%%%%%" << std::endl;
+ break;
+ case 9:
+ std::cout << "### # # # # " << std::endl;
+ std::cout << "# # # # ## ## # # # " << std::endl;
+ std::cout << "# # # # # # # # # # # " << std::endl;
+ std::cout << "### ## # # ## " << std::endl;
+ std::cout << " " << std::endl;
+ std::cout << "Dune for Multi-{ Phase, " << std::endl;
+ std::cout << " Component, " << std::endl;
+ std::cout << " Scale, " << std::endl;
+ std::cout << " Physics, " << std::endl;
+ std::cout << " ...} flow and transport in porous media" << std::endl;
+ break;
+ case 10:
+ if(firstCall)
+ std::cout << "Elliot Carver: Mr. Jones, are we ready to release our new software?" << std::endl
+ << "Jones: Yes, sir. As requested, it's full of bugs, which means people will be forced to upgrade for years." << std::endl
+ << " - James Bond, Tomorrow Never Dies" << std::endl;
+ else
+ {
+ std::cout << "Elliot Carver: Outstanding." << std::endl
+ << " - James Bond, Tomorrow Never Dies" << std::endl;
+ }
+ break;
+ case 11:
+ if(firstCall)
+ std::cout << "Chuck Norris has successfully compiled DuMuX." << std::endl;
+ else
+ std::cout << "Chuck Norris has compiled DuMuX even two times in a row!" << std::endl;
+ break;
+
+ // Note: If you add a case, you have to increase the number of messages (nMessages_ variable).
+
+ default: // silence to delight Bernd
+ return;
+ }
+ std::cout << std::endl;
+ }
+};
+
+} // end namespace Dumux
+
+#endif
diff --git a/dumux/common/start.hh b/dumux/common/start.hh
index 57c73fef46..f9e420d3a0 100644
--- a/dumux/common/start.hh
+++ b/dumux/common/start.hh
@@ -34,9 +34,10 @@
#include <dune/alugrid/dgf.hh>
#endif // HAVE_DUNE_ALUGRID
-#include "propertysystem.hh"
-#include "parameters.hh"
-#include "valgrind.hh"
+#include <dumux/common/propertysystem.hh>
+#include <dumux/common/parameters.hh>
+#include <dumux/common/valgrind.hh>
+#include <dumux/common/dumuxmessage.hh>
namespace Dumux
{
@@ -134,145 +135,6 @@ std::string usageTextBlock()
"\n";
}
-/*!
- * \ingroup Start
- * \brief Dumux start and end message.
- *
- * Selects random messages to write out at the start and end of a simulation run.
- * \param start Indicates if the simulation is starting (=true) or ending (=false).
- */
-void dumuxMessage_(bool start)
-{
- static int dice_;
- if(start)
- {
- std::srand(std::time(0));
- // roll the dice to decide which start message will be displayed:
- dice_ = std::rand() % 12; // has to be n+1
- }
-
-
- std::cout << "" << std::endl;
- switch (dice_)
- {
- case 0:
- if(start)
- std::cout << "Welcome aboard DuMuX airlines. Please fasten your seatbelts! "
- << "Emergency exits are near the time integration." << std::endl;
- else
- std::cout << "We hope that you enjoyed simulating with us " << std::endl
- << "and that you will choose us next time, too." << std::endl;
- break;
- case 1:
- if(start)
- std::cout << "Let's get the cow off the ice." << std::endl;
- else
- std::cout << "DuMuX got the cow off the ice." << std::endl;
- break;
- case 2:
- if(start)
- std::cout << "Science, my lad, is made up of mistakes, but they are "
- << "mistakes which it is useful to make, because they lead little "
- << "by little to the truth." << std::endl
- << " - Jules Verne, A journey to the center of the earth" << std::endl;
- else
- std::cout << "[We see that] science is eminently perfectible, and that each theory has "
- << "constantly to give way to a fresh one." << std::endl
- << " - Jules Verne, Journey to the Center of the Earth" << std::endl;
-
- break;
- case 3:
- if(start)
- std::cout << "Wherever he saw a hole he always wanted to know the depth of it. "
- << "To him this was important." << std::endl
- << " - Jules Verne, A journey to the center of the earth" << std::endl;
- else
- std::cout << "We may brave human laws, but we cannot resist natural ones." << std::endl
- << " - Jules Verne, 20,000 Leagues Under the Sea" << std::endl;
- break;
- case 4:
- if(start)
- std::cout << "Silence - to delight Bernd." << std::endl;
- else
- std::cout << "\n " << std::endl;
- break;
- case 5:
- std::cout << "Don't panic... !" << std::endl;
- break;
- case 6:
- if(start)
- std::cout << "You idiot! You signed the order to destroy Earth!" << std::endl
- << " - Douglas Adams, HGttG" << std::endl;
- else
- std::cout << "Marvin: I've been talking to the main computer.\n Arthur: And?" << std::endl
- << "Marvin: It hates me." << std::endl
- << " - Douglas Adams, HGttG" << std::endl;
- break;
- case 7:
- if(start)
- std::cout << "In the beginning the Universe was created. This has made a lot of "
- << "people very angry and has been widely regarded as a bad move.!" << std::endl
- << " - Douglas Adams, HGttG " << std::endl;
- else
- std::cout << "Forty-two. I checked it very thoroughly, and that quite definitely is the answer. I think "
- << "the problem, to be quite honest with you, is that you\'ve never actually known what the question is." << std::endl
- << " - Douglas Adams, HGttG " << std::endl;
- break;
- case 8:
- std::cout << " ## @@@@ @ @ @ @" << std::endl;
- std::cout << " ### # @ @ @@ @@ @ " << std::endl;
- std::cout << " ## # @ @ @ @ @ @ @ @ @ @ @" << std::endl;
- std::cout << " ## # @ @ @ @ @ @ @ @ " << std::endl;
- std::cout << " # # @@@@ @@@ @ @ @@@ " << std::endl;
- std::cout << " # # " << std::endl;
- std::cout << " # # " << std::endl;
- std::cout << " # ## %%% " << std::setw(8) << std::right << DUMUX_VERSION << std::endl;
- std::cout << " # ### % % %% %% " << std::endl;
- std::cout << "#### #%%% %% %%%%% %%%%%%%%%%%%%%%%%" << std::endl;
- break;
- case 9:
- std::cout << "### # # # # " << std::endl;
- std::cout << "# # # # ## ## # # # " << std::endl;
- std::cout << "# # # # # # # # # # # " << std::endl;
- std::cout << "### ## # # ## " << std::endl;
- std::cout << " " << std::endl;
- std::cout << "Dune for Multi-{ Phase, " << std::endl;
- std::cout << " Component, " << std::endl;
- std::cout << " Scale, " << std::endl;
- std::cout << " Physics, " << std::endl;
- std::cout << " ...} flow and transport in porous media" << std::endl;
- break;
- case 10:
- if(start)
- {
- std::cout << "Elliot Carver: Mr. Jones, are we ready to release our new software?" << std::endl;
- std::cout << "Jones: Yes, sir. As requested, it's full of bugs, which means people will be forced to upgrade for years." << std::endl;
- std::cout << " - James Bond, Tomorrow Never Dies" << std::endl;
- }
- else
- {
- std::cout << "Elliot Carver: Outstanding." << std::endl;
- std::cout << " - James Bond, Tomorrow Never Dies" << std::endl;
- }
- break;
- case 11:
- if(start)
- {
- std::cout << "Chuck Norris has successfully compiled DuMuX." << std::endl;
- }
- else
- {
- std::cout << "Chuck Norris has compiled DuMuX even two times in a row!" << std::endl;
- }
- break;
- // Note: If you add a case, you have to increase the modulus at the beginning of this function!
-
- default: // silence to delight Bernd
- return ;
- }
- std::cout << std::endl;
-}
-
/*!
* \ingroup Start
*
@@ -301,7 +163,7 @@ int start_(int argc,
// print dumux start message
if (mpiHelper.rank() == 0)
- dumuxMessage_(true);
+ DumuxMessage::print(/*firstCall=*/true);
////////////////////////////////////////////////////////////
// parse the command line arguments
@@ -455,22 +317,14 @@ int start_(int argc,
Problem problem(timeManager, GridCreator::grid().leafGridView());
timeManager.init(problem, restartTime, dt, tEnd, restart);
timeManager.run();
- // print dumux end message
- if (mpiHelper.rank() == 0)
- dumuxMessage_(false);
- if (printParams && mpiHelper.rank() == 0) {
- Parameters::print<TypeTag>();
- }
-
- // check if a deprecated TypeTag has been used
- Properties::TypeTagAncestors<TypeTag>::addAncestors();
- if (Properties::TypeTagAncestors<TypeTag>::contains("Decoupled"))
+ // print dumux end message and maybe the parameters
+ if (mpiHelper.rank() == 0)
{
- std::cout << "\nAt least one of the used TypeTags contains the "
- << "deprecated name \"Decoupled\":" << std::endl;
- Properties::TypeTagAncestors<TypeTag>::print(std::cout);
- std::cout << "Please use \"Sequential\" instead." << std::endl;
+ DumuxMessage::print(/*firstCall=*/false);
+
+ if (printParams)
+ Parameters::print<TypeTag>();
}
return 0;
--
GitLab