From 56dd4e3e84008a8e2e6101e25af61d17163d7abb Mon Sep 17 00:00:00 2001
From: Benjamin Faigle <benjamin.faigle@posteo.de>
Date: Fri, 1 Oct 2010 15:08:25 +0000
Subject: [PATCH] tutorial_decoupled compiles and runs again, added docu for
main file
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4342 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
tutorial/tutorial_decoupled.cc | 48 +++++++++++++--------------
tutorial/tutorialproblem_decoupled.hh | 24 ++++++++++----
2 files changed, 41 insertions(+), 31 deletions(-)
diff --git a/tutorial/tutorial_decoupled.cc b/tutorial/tutorial_decoupled.cc
index abbb913a52..4ab781d4df 100644
--- a/tutorial/tutorial_decoupled.cc
+++ b/tutorial/tutorial_decoupled.cc
@@ -15,9 +15,9 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
-#include "config.h"
+#include "config.h" /*@\label{tutorial-decoupled:include-begin}@*/
-#include "tutorialproblem_decoupled.hh"
+#include "tutorialproblem_decoupled.hh" /*@\label{tutorial-decoupled:include-problem-header}@*/
#include <dune/grid/common/gridinfo.hh>
@@ -25,36 +25,37 @@
#include <dune/common/mpihelper.hh>
#include <iostream>
-#include <boost/format.hpp>
+#include <boost/format.hpp> /*@\label{tutorial-decoupled:include-end}@*/
-////////////////////////
-// the main function
-////////////////////////
+////////////////////////////////////////////
+// function to check the input parameters
+////////////////////////////////////////////
void usage(const char *progname)
{
std::cout << boost::format("usage: %s [--restart restartTime] tEnd\n")%progname;
exit(1);
}
+////////////////////////
+// the main function
+////////////////////////
int main(int argc, char** argv)
{
try {
- typedef TTAG(TutorialProblemDecoupled) TypeTag;
- typedef GET_PROP_TYPE(TypeTag, PTAG(Scalar)) Scalar;
+ typedef TTAG(TutorialProblemDecoupled) TypeTag; /*@\label{tutorial-decoupled:set-type-tag}@*/
+ typedef GET_PROP_TYPE(TypeTag, PTAG(Scalar)) Scalar; /*@\label{tutorial-decoupled:retrieve-types-begin}@*/
typedef GET_PROP_TYPE(TypeTag, PTAG(Grid)) Grid;
typedef GET_PROP_TYPE(TypeTag, PTAG(Problem)) Problem;
- typedef Dune::FieldVector<Scalar, Grid::dimensionworld> GlobalPosition;
-
- static const int dim = Grid::dimension;
+ typedef Dune::FieldVector<Scalar, Grid::dimensionworld> GlobalPosition; /*@\label{tutorial-decoupled:retrieve-types-end}@*/
// initialize MPI, finalize is done automatically on exit
- Dune::MPIHelper::instance(argc, argv);
+ Dune::MPIHelper::instance(argc, argv); /*@\label{tutorial-decoupled:init-mpi}@*/
////////////////////////////////////////////////////////////
// parse the command line arguments
////////////////////////////////////////////////////////////
- if (argc < 2)
+ if (argc < 2) /*@\label{tutorial-decoupled:parse-args-begin}@*/
usage(argv[0]);
// deal with the restart stuff
@@ -67,7 +68,7 @@ int main(int argc, char** argv)
std::istringstream(argv[argPos++]) >> restartTime;
}
-
+ // output in case of wrong numbers of input parameters
if (argc - argPos != 1) {
usage(argv[0]);
}
@@ -75,29 +76,26 @@ int main(int argc, char** argv)
// read the initial time step and the end time
double tEnd, dt;
std::istringstream(argv[argPos++]) >> tEnd;
- dt = tEnd;
+ dt = tEnd; /*@\label{tutorial-decoupled:parse-args-end}@*/
- ////////////////////////////////////////////////////////////
// create the grid
- ////////////////////////////////////////////////////////////
- Dune::FieldVector<int,dim> N(1); N[0] = 100;
- Dune::FieldVector<double ,dim> L(0);
- Dune::FieldVector<double,dim> H(60); H[0] = 300;
- Grid grid(N,L,H);
+ Grid *gridPtr = GET_PROP(TypeTag, PTAG(Grid))::create(); /*@\label{tutorial-decoupled:create-grid}@*/
+
////////////////////////////////////////////////////////////
// instantiate and run the concrete problem
////////////////////////////////////////////////////////////
- Problem problem(grid.leafView(), L, H);
+ Problem problem(gridPtr->leafView()); /*@\label{tutorial-decoupled:instantiate-problem}@*/
// load restart file if necessarry
- if (restart)
+ if (restart) /*@\label{tutorial-decoupled:restart}@*/
problem.deserialize(restartTime);
+ // define simulation parameters
+ problem.timeManager().init(problem, 0, dt, tEnd, !restart); /*@\label{tutorial-decoupled:initTimeManager}@*/
// run the simulation
- problem.timeManager().init(problem, 0, dt, tEnd, !restart);
- problem.timeManager().run();
+ problem.timeManager().run(); /*@\label{tutorial-decoupled:execute}@*/
return 0;
}
catch (Dune::Exception &e) {
diff --git a/tutorial/tutorialproblem_decoupled.hh b/tutorial/tutorialproblem_decoupled.hh
index ebf15bda22..aea69cd038 100644
--- a/tutorial/tutorialproblem_decoupled.hh
+++ b/tutorial/tutorialproblem_decoupled.hh
@@ -25,9 +25,8 @@
#include <dune/grid/yaspgrid.hh>
#include <dune/grid/sgrid.hh>
-#include <dumux/material/components/h2o.hh>
-#include <dumux/material/components/oil.hh>
-#include <dumux/material/fluidsystems/liquidphase.hh>
+// fluid properties
+#include <dumux/material/fluidsystems/2p_system.hh>
#include <dumux/decoupled/2p/impes/impesproblem2p.hh>
#include <dumux/decoupled/2p/diffusion/fv/fvvelocity2p.hh>
@@ -53,8 +52,21 @@ NEW_TYPE_TAG(TutorialProblemDecoupled, INHERITS_FROM(DecoupledTwoP, Transport));
// Set the grid type
SET_PROP(TutorialProblemDecoupled, Grid)
{
- // typedef Dune::YaspGrid<2> type;
typedef Dune::SGrid<2, 2> type;
+ static type *create() /*@\label{tutorial-coupled:create-grid-method}@*/
+ {
+ typedef typename type::ctype ctype;
+ Dune::FieldVector<int, 2> cellRes;
+ Dune::FieldVector<ctype, 2> lowerLeft(0.0);
+ Dune::FieldVector<ctype, 2> upperRight;
+ upperRight[0] = 300;
+ upperRight[1] = 60;
+ cellRes[0] = 100;
+ cellRes[1] = 1;
+ return new Dune::SGrid<2,2>(cellRes,
+ lowerLeft,
+ upperRight);
+ } /*@\label{tutorial-decoupled:grid-end}@*/
};
// Set the problem property
@@ -65,7 +77,7 @@ public:
};
// Set the model properties
-SET_PROP(TutorialProblemDecoupled, SaturationModel)
+SET_PROP(TutorialProblemDecoupled, TransportModel)
{
typedef Dumux::FVSaturation2P<TTAG(TutorialProblemDecoupled)> type;
};
@@ -151,7 +163,7 @@ class TutorialProblemDecoupled: public IMPESProblem2P<TypeTag, TutorialProblemDe
typedef Dune::FieldVector<Scalar, dim> LocalPosition;
public:
- TutorialProblemDecoupled(const GridView &gridView, const GlobalPosition lowerLeft = 0, const GlobalPosition upperRight = 0) :
+ TutorialProblemDecoupled(const GridView &gridView, const GlobalPosition lowerLeft = GlobalPosition(0.), const GlobalPosition upperRight = GlobalPosition(0.)) :
ParentType(gridView), lowerLeft_(lowerLeft), upperRight_(upperRight)
{
}
--
GitLab