From b2567eccce354566496a423d2105178b7b823e03 Mon Sep 17 00:00:00 2001
From: Bernd Flemisch <bernd@iws.uni-stuttgart.de>
Date: Fri, 10 Aug 2012 18:31:15 +0000
Subject: [PATCH] Adapted tutorials to parameter naming conventions.
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@8841 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
tutorial/tutorial_coupled.cc | 14 ++++++------
tutorial/tutorial_coupled.input | 36 +++++++++++++++++++++++++------
tutorial/tutorial_decoupled.cc | 14 ++++++------
tutorial/tutorial_decoupled.input | 36 +++++++++++++++++++++++++------
4 files changed, 74 insertions(+), 26 deletions(-)
diff --git a/tutorial/tutorial_coupled.cc b/tutorial/tutorial_coupled.cc
index cadd3ece01..13bd3f9b7a 100644
--- a/tutorial/tutorial_coupled.cc
+++ b/tutorial/tutorial_coupled.cc
@@ -39,13 +39,13 @@ void usage(const char *progName, const std::string &errorMsg) /*@\label{tutoria
std::cout << errorMsg << "\n";
std::cout
<< "\n"
- << "The List of Mandatory arguments for this program is:\n"
- << "\t-tEnd The end of the simulation [s]\n"
- << "\t-dtInitial The initial timestep size [s]\n"
- << "\t-Grid.upperRightX The x-coordinate of the grid's upper-right corner [m]\n"
- << "\t-Grid.upperRightY The y-coordinate of the grid's upper-right corner [m]\n"
- << "\t-Grid.numberOfCellsX The grid's x-resolution\n"
- << "\t-Grid.numberOfCellsY The grid's y-resolution\n"
+ << "The list of mandatory arguments for this program is:\n"
+ << "\t-TEnd The end of the simulation [s]\n"
+ << "\t-DtInitial The initial timestep size [s]\n"
+ << "\t-Grid.UpperRightX The x-coordinate of the grid's upper-right corner [m]\n"
+ << "\t-Grid.UpperRightY The y-coordinate of the grid's upper-right corner [m]\n"
+ << "\t-Grid.NumberOfCellsX The grid's x-resolution\n"
+ << "\t-Grid.NumberOfCellsY The grid's y-resolution\n"
<< "\n";
}
diff --git a/tutorial/tutorial_coupled.input b/tutorial/tutorial_coupled.input
index 326a545fcb..29b9f862cd 100644
--- a/tutorial/tutorial_coupled.input
+++ b/tutorial/tutorial_coupled.input
@@ -1,7 +1,31 @@
-tEnd = 500000 # duration of the simulation [s]
-dtInitial = 10 # initial time step size [s]
+###############################################################
+# Parameter file for tutorial_coupled.
+# Everything behind a '#' is a comment.
+# Type "./tutorial_coupled --help" for more information.
+###############################################################
+
+###############################################################
+# Mandatory arguments
+###############################################################
+
+[TimeManager]
+TEnd = 500000 # duration of the simulation [s]
+DtInitial = 10 # initial time step size [s]
+
[Grid]
-upperRightX = 300 # x-coordinate of the upper-right corner of the grid [m]
-upperRightY = 60 # y-coordinate of the upper-right corner of the grid [m]
-numberOfCellsX = 100 # x-resolution of the grid
-numberOfCellsY = 1 # y-resolution of the grid
+UpperRightX = 300 # x-coordinate of the upper-right corner of the grid [m]
+UpperRightY = 60 # y-coordinate of the upper-right corner of the grid [m]
+NumberOfCellsX = 100 # x-resolution of the grid
+NumberOfCellsY = 1 # y-resolution of the grid
+
+###############################################################
+# Simulation restart
+#
+# DuMux simulations can be restarted from *.drs files
+# Set Restart to the value of a specific file,
+# e.g.: 'Restart = 27184.1' for the restart file
+# name_time=27184.1_rank=0.drs
+# Please comment in the two lines below, if restart is desired.
+###############################################################
+# [TimeManager]
+# Restart = ...
diff --git a/tutorial/tutorial_decoupled.cc b/tutorial/tutorial_decoupled.cc
index cbde8a2059..c2a7fe1576 100644
--- a/tutorial/tutorial_decoupled.cc
+++ b/tutorial/tutorial_decoupled.cc
@@ -40,13 +40,13 @@ void usage(const char *progName, const std::string &errorMsg) /*@\label{tutoria
std::cout << errorMsg << "\n";
std::cout
<< "\n"
- << "The List of Mandatory arguments for this program is:\n"
- << "\t-tEnd The end of the simulation [s]\n"
- << "\t-dtInitial The initial timestep size [s]\n"
- << "\t-Grid.upperRightX The x-coordinate of the grid's upper-right corner [m]\n"
- << "\t-Grid.upperRightY The y-coordinate of the grid's upper-right corner [m]\n"
- << "\t-Grid.numberOfCellsX The grid's x-resolution\n"
- << "\t-Grid.numberOfCellsY The grid's y-resolution\n"
+ << "The list of mandatory arguments for this program is:\n"
+ << "\t-TEnd The end of the simulation [s]\n"
+ << "\t-DtInitial The initial timestep size [s]\n"
+ << "\t-Grid.UpperRightX The x-coordinate of the grid's upper-right corner [m]\n"
+ << "\t-Grid.UpperRightY The y-coordinate of the grid's upper-right corner [m]\n"
+ << "\t-Grid.NumberOfCellsX The grid's x-resolution\n"
+ << "\t-Grid.NumberOfCellsY The grid's y-resolution\n"
<< "\n";
}
diff --git a/tutorial/tutorial_decoupled.input b/tutorial/tutorial_decoupled.input
index 65972f1a1c..e7fa2475ca 100644
--- a/tutorial/tutorial_decoupled.input
+++ b/tutorial/tutorial_decoupled.input
@@ -1,7 +1,31 @@
-tEnd = 100000 # duration of the simulation [s]
-dtInitial = 10 # initial time step size [s]
+###############################################################
+# Parameter file for tutorial_decoupled.
+# Everything behind a '#' is a comment.
+# Type "./tutorial_decoupled --help" for more information.
+###############################################################
+
+###############################################################
+# Mandatory arguments
+###############################################################
+
+[TimeManager]
+TEnd = 100000 # duration of the simulation [s]
+DtInitial = 10 # initial time step size [s]
+
[Grid]
-upperRightX = 300 # x-coordinate of the upper-right corner of the grid [m]
-upperRightY = 60 # y-coordinate of the upper-right corner of the grid [m]
-numberOfCellsX = 100 # x-resolution of the grid
-numberOfCellsY = 1 # y-resolution of the grid
\ No newline at end of file
+UpperRightX = 300 # x-coordinate of the upper-right corner of the grid [m]
+UpperRightY = 60 # y-coordinate of the upper-right corner of the grid [m]
+NumberOfCellsX = 100 # x-resolution of the grid
+NumberOfCellsY = 1 # y-resolution of the grid
+
+###############################################################
+# Simulation restart
+#
+# DuMux simulations can be restarted from *.drs files
+# Set Restart to the value of a specific file,
+# e.g.: 'Restart = 27184.1' for the restart file
+# name_time=27184.1_rank=0.drs
+# Please comment in the two lines below, if restart is desired.
+###############################################################
+# [TimeManager]
+# Restart = ...
--
GitLab