From dc45319ccd8fa92a73319f3c8fda498fa54661eb Mon Sep 17 00:00:00 2001
From: seitz <gabriele.seitz@iws.uni-stuttgart.de>
Date: Wed, 2 Oct 2019 16:19:54 +0200
Subject: [PATCH] [exercise-grids] use file naming convention and fix a few
typos
---
exercises/exercise-grids/CMakeLists.txt | 2 +-
exercises/exercise-grids/README.md | 4 ++--
.../exercise-grids/{exercisegrids.cc => main.cc} | 2 +-
.../{exercise_grids.input => params.input} | 0
.../{injection2pproblem.hh => problem.hh} | 10 +++++-----
...{injection2pspatialparams.hh => spatialparams.hh} | 0
exercises/solution/exercise-grids/CMakeLists.txt | 2 +-
.../{exercisegrids_solution.cc => main.cc} | 2 +-
.../{exercise_grids_solution.input => params.input} | 0
.../{injection2pproblem.hh => problem.hh} | 12 ++++++------
...{injection2pspatialparams.hh => spatialparams.hh} | 0
11 files changed, 17 insertions(+), 17 deletions(-)
rename exercises/exercise-grids/{exercisegrids.cc => main.cc} (99%)
rename exercises/exercise-grids/{exercise_grids.input => params.input} (100%)
rename exercises/exercise-grids/{injection2pproblem.hh => problem.hh} (97%)
rename exercises/exercise-grids/{injection2pspatialparams.hh => spatialparams.hh} (100%)
rename exercises/solution/exercise-grids/{exercisegrids_solution.cc => main.cc} (99%)
rename exercises/solution/exercise-grids/{exercise_grids_solution.input => params.input} (100%)
rename exercises/solution/exercise-grids/{injection2pproblem.hh => problem.hh} (97%)
rename exercises/solution/exercise-grids/{injection2pspatialparams.hh => spatialparams.hh} (100%)
diff --git a/exercises/exercise-grids/CMakeLists.txt b/exercises/exercise-grids/CMakeLists.txt
index b83a9f84..092f93db 100644
--- a/exercises/exercise-grids/CMakeLists.txt
+++ b/exercises/exercise-grids/CMakeLists.txt
@@ -1,6 +1,6 @@
# the grid exercise simulation program
dune_add_test(NAME exercise_grids
- SOURCES exercisegrids.cc)
+ SOURCES main.cc)
# add tutorial to the common target
add_dependencies(test_exercises exercise_grids)
diff --git a/exercises/exercise-grids/README.md b/exercises/exercise-grids/README.md
index 08b2a508..4edb8961 100644
--- a/exercises/exercise-grids/README.md
+++ b/exercises/exercise-grids/README.md
@@ -9,8 +9,8 @@ Here we will expand on what we've covered in the basics exercise, and the proble
* Navigate to the directory `dumux-course/exercises/exercise-grids/`
We'll be editing the following files during this exercise:
-* The __input file__: `exercise_grids.input` ,
-* and the __problem file__: `injection2pproblem.hh`
+* The __input file__: `params.input` ,
+* and the __problem file__: `problem.hh`
Currently our grid is defined using the following input parameters in the input file:
diff --git a/exercises/exercise-grids/exercisegrids.cc b/exercises/exercise-grids/main.cc
similarity index 99%
rename from exercises/exercise-grids/exercisegrids.cc
rename to exercises/exercise-grids/main.cc
index 8ffbc325..9e094d98 100644
--- a/exercises/exercise-grids/exercisegrids.cc
+++ b/exercises/exercise-grids/main.cc
@@ -47,7 +47,7 @@
#include <dumux/io/grid/gridmanager.hh>
// The problem file, where setup-specific boundary and initial conditions are defined.
-#include "injection2pproblem.hh"
+#include "problem.hh"
////////////////////////
// the main function
diff --git a/exercises/exercise-grids/exercise_grids.input b/exercises/exercise-grids/params.input
similarity index 100%
rename from exercises/exercise-grids/exercise_grids.input
rename to exercises/exercise-grids/params.input
diff --git a/exercises/exercise-grids/injection2pproblem.hh b/exercises/exercise-grids/problem.hh
similarity index 97%
rename from exercises/exercise-grids/injection2pproblem.hh
rename to exercises/exercise-grids/problem.hh
index b38ca805..680ea9ab 100644
--- a/exercises/exercise-grids/injection2pproblem.hh
+++ b/exercises/exercise-grids/problem.hh
@@ -32,7 +32,7 @@
#include <dumux/porousmediumflow/problem.hh>
#include <dumux/material/fluidsystems/h2on2.hh>
-#include "injection2pspatialparams.hh"
+#include "spatialparams.hh"
namespace Dumux {
@@ -84,15 +84,15 @@ struct FluidSystem<TypeTag, TTag::Injection2p> { using type = FluidSystems::H2ON
*
* The domain is sized 60 m times 40 m.
*
- * For the mass conservation equation neumann boundary conditions are used on
- * the top, on the bottom and on the right of the domain, while dirichlet conditions
+ * For the mass conservation equation Neumann boundary conditions are used on
+ * the top, on the bottom and on the right of the domain, while Dirichlet conditions
* apply on the left boundary.
*
* Gas is injected at the right boundary from 7 m to 15 m at a rate of
- * 0.001 kg/(s m), the remaining neumann boundaries are no-flow
+ * 0.001 kg/(s m), the remaining Neumann boundaries are no-flow
* boundaries.
*
- * At the dirichlet boundaries a hydrostatic pressure and a gas saturation of zero a
+ * At the Dirichlet boundaries a hydrostatic pressure and a gas saturation of zero a
*
* This problem uses the \ref TwoPModel model.
*/
diff --git a/exercises/exercise-grids/injection2pspatialparams.hh b/exercises/exercise-grids/spatialparams.hh
similarity index 100%
rename from exercises/exercise-grids/injection2pspatialparams.hh
rename to exercises/exercise-grids/spatialparams.hh
diff --git a/exercises/solution/exercise-grids/CMakeLists.txt b/exercises/solution/exercise-grids/CMakeLists.txt
index 7f68884b..4598aa8e 100644
--- a/exercises/solution/exercise-grids/CMakeLists.txt
+++ b/exercises/solution/exercise-grids/CMakeLists.txt
@@ -1,6 +1,6 @@
# the grid exercise simulation program
dune_add_test(NAME exercise_grids_solution
- SOURCES exercisegrids_solution.cc)
+ SOURCES main.cc)
# add tutorial to the common target
add_dependencies(test_exercises exercise_grids_solution)
diff --git a/exercises/solution/exercise-grids/exercisegrids_solution.cc b/exercises/solution/exercise-grids/main.cc
similarity index 99%
rename from exercises/solution/exercise-grids/exercisegrids_solution.cc
rename to exercises/solution/exercise-grids/main.cc
index e69194da..ea52463b 100644
--- a/exercises/solution/exercise-grids/exercisegrids_solution.cc
+++ b/exercises/solution/exercise-grids/main.cc
@@ -47,7 +47,7 @@
#include <dumux/io/grid/gridmanager.hh>
// The problem file, where setup-specific boundary and initial conditions are defined.
-#include "injection2pproblem.hh"
+#include "problem.hh"
////////////////////////
// the main function
diff --git a/exercises/solution/exercise-grids/exercise_grids_solution.input b/exercises/solution/exercise-grids/params.input
similarity index 100%
rename from exercises/solution/exercise-grids/exercise_grids_solution.input
rename to exercises/solution/exercise-grids/params.input
diff --git a/exercises/solution/exercise-grids/injection2pproblem.hh b/exercises/solution/exercise-grids/problem.hh
similarity index 97%
rename from exercises/solution/exercise-grids/injection2pproblem.hh
rename to exercises/solution/exercise-grids/problem.hh
index b51f4f8c..3b4d250b 100644
--- a/exercises/solution/exercise-grids/injection2pproblem.hh
+++ b/exercises/solution/exercise-grids/problem.hh
@@ -32,7 +32,7 @@
#include <dumux/porousmediumflow/problem.hh>
#include <dumux/material/fluidsystems/h2on2.hh>
-#include "injection2pspatialparams.hh"
+#include "spatialparams.hh"
namespace Dumux {
@@ -92,15 +92,15 @@ struct FluidSystem<TypeTag, TTag::Injection2p> { using type = FluidSystems::H2ON
*
* The domain is sized 60 m times 40 m.
*
- * For the mass conservation equation neumann boundary conditions are used on
- * the top, on the bottom and on the right of the domain, while dirichlet conditions
+ * For the mass conservation equation Neumann boundary conditions are used on
+ * the top, on the bottom and on the right of the domain, while Dirichlet conditions
* apply on the left boundary.
*
* Gas is injected at the right boundary from 7 m to 15 m at a rate of
- * 0.001 kg/(s m), the remaining neumann boundaries are no-flow
+ * 0.001 kg/(s m), the remaining Neumann boundaries are no-flow
* boundaries.
*
- * At the dirichlet boundaries a hydrostatic pressure and a gas saturation of zero a
+ * At the Dirichlet boundaries a hydrostatic pressure and a gas saturation of zero a
*
* This problem uses the \ref TwoPModel model.
*/
@@ -203,7 +203,7 @@ public:
}
/*!
- * \brief Evaluate the boundary conditions for a neumann
+ * \brief Evaluate the boundary conditions for a Neumann
* boundary segment.
*
* \param globalPos The position of the integration point of the boundary segment.
diff --git a/exercises/solution/exercise-grids/injection2pspatialparams.hh b/exercises/solution/exercise-grids/spatialparams.hh
similarity index 100%
rename from exercises/solution/exercise-grids/injection2pspatialparams.hh
rename to exercises/solution/exercise-grids/spatialparams.hh
--
GitLab