From bdb19346d80721fc60bf44894585b46dfd23cb16 Mon Sep 17 00:00:00 2001
From: Philipp Nuske <philipp.nuske@mailbox.org>
Date: Fri, 10 Dec 2010 11:05:31 +0000
Subject: [PATCH] correcting typos, adding minor comments, streamlining
nomenclature in tutorial_coupled
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4844 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
tutorial/tutorial_coupled.cc | 4 ++--
tutorial/tutorialproblem_coupled.hh | 4 ++--
tutorial/tutorialspatialparameters_coupled.hh | 6 ++++--
3 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/tutorial/tutorial_coupled.cc b/tutorial/tutorial_coupled.cc
index 09fceb1d54..5a847e7425 100644
--- a/tutorial/tutorial_coupled.cc
+++ b/tutorial/tutorial_coupled.cc
@@ -58,7 +58,7 @@ int main(int argc, char** argv)
std::istringstream(argv[argPos++]) >> restartTime;
}
- // read the the initial time step and the end time
+ // read the initial time step and the end time
if (argc - argPos != 2)
usage(argv[0]);
@@ -77,7 +77,7 @@ int main(int argc, char** argv)
timeManager.init(problem, 0, dt, tEnd, !restart);
// load some previously saved state from disk
if (restart)
- problem.restart(restartTime); /*@\label{tutorial-coupled:restart}@*/
+ problem.restart(restartTime); /*@\label{tutorial-coupled:begin-restart}@*/
// run the simulation
timeManager.run(); /*@\label{tutorial-coupled:execute}@*/
return 0;
diff --git a/tutorial/tutorialproblem_coupled.hh b/tutorial/tutorialproblem_coupled.hh
index c7651b62a3..1bb98cc3f4 100644
--- a/tutorial/tutorialproblem_coupled.hh
+++ b/tutorial/tutorialproblem_coupled.hh
@@ -127,7 +127,7 @@ public:
{
}
- // Specified the problem name. This is used as a prefix for files
+ // Specifies the problem name. This is used as a prefix for files
// generated by the simulation.
const char *name() const
{ return "tutorial_coupled"; }
@@ -142,7 +142,7 @@ public:
//! Returns true if the current solution should be written to disk (i.e. as a VTK file)
/*! The default behaviour is to write out the solution for
- * every time step. Else, change divisor.
+ * every time step. Else, the user has to change the divisor in this function.
*/
bool shouldWriteOutput() const /*@\label{tutorial-coupled:output}@*/
{
diff --git a/tutorial/tutorialspatialparameters_coupled.hh b/tutorial/tutorialspatialparameters_coupled.hh
index f595b6c5bd..2c8dd227a2 100644
--- a/tutorial/tutorialspatialparameters_coupled.hh
+++ b/tutorial/tutorialspatialparameters_coupled.hh
@@ -97,6 +97,8 @@ public:
BoxSpatialParameters<TypeTag>(gridView),
K_(0)
{
+ //set main diagonal entries of the permeability tensor to a value
+ //setting to one value means: isotropic, homogeneous
for (int i = 0; i < dim; i++)
K_[i][i] = 1e-7;
@@ -104,14 +106,14 @@ public:
materialParams_.setSwr(0.0); /*@\label{tutorial-coupled:setLawParams}@*/
materialParams_.setSnr(0.0);
- //linear material law
+ //parameters of Brooks & Corey Law
materialParams_.setPe(500.0);
materialParams_.setAlpha(2);
}
private:
Dune::FieldMatrix<Scalar, dim, dim> K_;
- // Object that helds the values/parameters of the selected material law.
+ // Object that holds the values/parameters of the selected material law.
MaterialLawParams materialParams_; /*@\label{tutorial-coupled:matParamsObject}@*/
};
} // end namespace
--
GitLab