From e661b39aa491ffeb549ed4930362e17b3b6ade53 Mon Sep 17 00:00:00 2001
From: Alexander Kissinger <alexander.kissinger@iws.uni-stuttgart.de>
Date: Fri, 1 Feb 2013 16:17:22 +0000
Subject: [PATCH] 1. In test/implicit/co2ni/heterogeneousproblem.hh: Changed
 the         problem name from HeterogeneousProblem to        
 HeterogeneousniNIProblem so that it is different from the problem        
 name in the co2 test (i.e. HeterogeneousProblem) 2. Updated the doxygen
 documentation in the rest of commited files

Reviewed by Katherina



git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@10166 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
 dumux/implicit/co2/co2model.hh                |  4 +-
 dumux/implicit/co2/co2volumevariables.hh      |  2 +-
 dumux/implicit/co2ni/co2nimodel.hh            |  4 +-
 dumux/implicit/co2ni/co2nivolumevariables.hh  |  4 +-
 test/implicit/co2/heterogeneousproblem.hh     |  2 +-
 .../co2/heterogeneousspatialparameters.hh     |  3 +-
 test/implicit/co2ni/heterogeneousproblemni.hh | 42 +++++++++----------
 test/implicit/co2ni/test_boxco2ni.cc          |  2 +-
 test/implicit/co2ni/test_ccco2ni.cc           |  2 +-
 9 files changed, 32 insertions(+), 33 deletions(-)

diff --git a/dumux/implicit/co2/co2model.hh b/dumux/implicit/co2/co2model.hh
index 840d8dc153..a2e952a110 100644
--- a/dumux/implicit/co2/co2model.hh
+++ b/dumux/implicit/co2/co2model.hh
@@ -22,7 +22,7 @@
 /*!
  * \file
  *
- * \brief Adaption of the BOX scheme to the two-phase two-component flow model without constraint solver.
+ * \brief Adaption of the BOX or CC scheme to the two-phase two-component flow model without constraint solver.
  */
 #ifndef DUMUX_CO2_MODEL_HH
 #define DUMUX_CO2_MODEL_HH
@@ -33,7 +33,7 @@ namespace Dumux
 {
 /*!
  * \ingroup CO2Model
- * \brief Adaption of the BOX scheme to the non-isothermal two-phase two-component flow model.
+ * \brief Adaption of the BOX or CC scheme to the non-isothermal two-phase two-component flow model.
  *   See TwoPTwoCModel for reference to the equations used.
  *   The CO2 model is derived from the 2p2c model. In the CO2 model the phase switch criterion
  *   is different from the 2p2c model.
diff --git a/dumux/implicit/co2/co2volumevariables.hh b/dumux/implicit/co2/co2volumevariables.hh
index e494aa6510..096fcb9504 100644
--- a/dumux/implicit/co2/co2volumevariables.hh
+++ b/dumux/implicit/co2/co2volumevariables.hh
@@ -30,7 +30,7 @@ namespace Dumux
  * \ingroup CO2Model
  * \ingroup ImplicitVolumeVariables
  * \brief Contains the quantities which are are constant within a
- *        finite volume in the non-isothermal two-phase, two-component
+ *        finite volume in the isothermal CO2
  *        model.
  */
 template <class TypeTag>
diff --git a/dumux/implicit/co2ni/co2nimodel.hh b/dumux/implicit/co2ni/co2nimodel.hh
index b49c14de17..bdc3142b2f 100644
--- a/dumux/implicit/co2ni/co2nimodel.hh
+++ b/dumux/implicit/co2ni/co2nimodel.hh
@@ -22,7 +22,7 @@
 /*!
  * \file
  *
- * \brief Adaption of the BOX scheme to the non-isothermal two-phase two-component flow model without constraint solver.
+ * \brief Adaption of the BOX or CC scheme to the non-isothermal two-phase two-component flow model without constraint solver.
  */
 #ifndef DUMUX_CO2NI_MODEL_HH
 #define DUMUX_CO2NI_MODEL_HH
@@ -32,7 +32,7 @@
 namespace Dumux {
 /*!
  * \ingroup CO2NIModel
- * \brief Adaption of the BOX scheme to the non-isothermal two-phase two-component flow model.
+ * \brief Adaption of the BOX or CC scheme to the non-isothermal two-phase two-component flow model.
  *   See TwoPTwoCNI model for reference to the equations.
  *   The CO2NI model is derived from the CO2 model. In the CO2 model the phase switch criterion
  *   is different from the 2p2c model.
diff --git a/dumux/implicit/co2ni/co2nivolumevariables.hh b/dumux/implicit/co2ni/co2nivolumevariables.hh
index 70af07fb85..4644d0b62a 100644
--- a/dumux/implicit/co2ni/co2nivolumevariables.hh
+++ b/dumux/implicit/co2ni/co2nivolumevariables.hh
@@ -23,7 +23,7 @@
  * \file
  *
  * \brief Contains the quantities which are constant within a
- *        finite volume in the non-isothermal two-phase, two-component
+ *        finite volume in the non-isothermal CO2
  *        model.
  */
 #ifndef DUMUX_CO2NI_VOLUME_VARIABLES_HH
@@ -38,7 +38,7 @@ namespace Dumux
  * \ingroup CO2NIModel
  * \ingroup ImplicitVolumeVariables
  * \brief Contains the quantities which are are constant within a
- *        finite volume in the non-isothermal two-phase, two-component
+ *        finite volume in the non-isothermal CO2
  *        model.
  */
 template <class TypeTag>
diff --git a/test/implicit/co2/heterogeneousproblem.hh b/test/implicit/co2/heterogeneousproblem.hh
index a1634854cd..5e99a0335a 100644
--- a/test/implicit/co2/heterogeneousproblem.hh
+++ b/test/implicit/co2/heterogeneousproblem.hh
@@ -121,7 +121,7 @@ SET_BOOL_PROP(HeterogeneousProblem, VtkAddVelocity, false);
  * between different parts of the boundary.
  * These boundary ids can be imported into the problem where the boundary conditions can then be assigned accordingly.
  *
- * To run the simulation execute the following line in shell:
+ * To run the simulation execute the following line in shell (works with the box and cell centered spatial discretization method):
  * <tt>./test_ccco2 </tt> or <tt>./test_boxco2 </tt>
  */
 template <class TypeTag >
diff --git a/test/implicit/co2/heterogeneousspatialparameters.hh b/test/implicit/co2/heterogeneousspatialparameters.hh
index 81202442ba..c804083aa0 100644
--- a/test/implicit/co2/heterogeneousspatialparameters.hh
+++ b/test/implicit/co2/heterogeneousspatialparameters.hh
@@ -69,8 +69,7 @@ public:
 /*!
  * \ingroup CO2Model
  * \ingroup BoxTestProblems
- * \brief Definition of the spatial parameters for the injection
- *        problem which uses the non-isothermal or isothermal CO2NI box or cc model
+ * \brief Definition of the spatial parameters for the HeterogeneousProblem and HeterogeneousNIProblem
  */
 template<class TypeTag>
 class HeterogeneousSpatialParams : public ImplicitSpatialParams<TypeTag>
diff --git a/test/implicit/co2ni/heterogeneousproblemni.hh b/test/implicit/co2ni/heterogeneousproblemni.hh
index d03d7bfa6a..28e5d85464 100644
--- a/test/implicit/co2ni/heterogeneousproblemni.hh
+++ b/test/implicit/co2ni/heterogeneousproblemni.hh
@@ -46,54 +46,54 @@ namespace Dumux
 {
 
 template <class TypeTag>
-class HeterogeneousProblem;
+class HeterogeneousNIProblem;
 
 namespace Properties
 {
-NEW_TYPE_TAG(HeterogeneousProblem, INHERITS_FROM(TwoPTwoCNI, HeterogeneousSpatialParams));
-NEW_TYPE_TAG(HeterogeneousBoxProblem, INHERITS_FROM(BoxModel, HeterogeneousProblem));
-NEW_TYPE_TAG(HeterogeneousCCProblem, INHERITS_FROM(CCModel, HeterogeneousProblem));
+NEW_TYPE_TAG(HeterogeneousNIProblem, INHERITS_FROM(TwoPTwoCNI, HeterogeneousSpatialParams));
+NEW_TYPE_TAG(HeterogeneousNIBoxProblem, INHERITS_FROM(BoxModel, HeterogeneousNIProblem));
+NEW_TYPE_TAG(HeterogeneousNICCProblem, INHERITS_FROM(CCModel, HeterogeneousNIProblem));
 
 
 // Set the grid type
 #if HAVE_ALUGRID
-SET_TYPE_PROP(HeterogeneousProblem, Grid, Dune::ALUGrid<2, 2, Dune::cube, Dune::nonconforming>);
+SET_TYPE_PROP(HeterogeneousNIProblem, Grid, Dune::ALUGrid<2, 2, Dune::cube, Dune::nonconforming>);
 #else
-SET_TYPE_PROP(HeterogeneousProblem, Grid, Dune::YaspGrid<2>);
+SET_TYPE_PROP(HeterogeneousNIProblem, Grid, Dune::YaspGrid<2>);
 #endif
 
 // Set the problem property
-SET_PROP(HeterogeneousProblem, Problem)
+SET_PROP(HeterogeneousNIProblem, Problem)
 {
-    typedef Dumux::HeterogeneousProblem<TypeTag> type;
+    typedef Dumux::HeterogeneousNIProblem<TypeTag> type;
 };
 
 // Set fluid configuration
-SET_PROP(HeterogeneousProblem, FluidSystem)
+SET_PROP(HeterogeneousNIProblem, FluidSystem)
 {
     typedef Dumux::BrineCO2FluidSystem<TypeTag> type;
 };
 
 // Set the CO2 table to be used; in this case not the the default table
-SET_TYPE_PROP(HeterogeneousProblem, CO2Table, Dumux::Heterogeneous::CO2Tables);
+SET_TYPE_PROP(HeterogeneousNIProblem, CO2Table, Dumux::Heterogeneous::CO2Tables);
 // Set the salinity mass fraction of the brine in the reservoir
-SET_SCALAR_PROP(HeterogeneousProblem, ProblemSalinity, 1e-1);
+SET_SCALAR_PROP(HeterogeneousNIProblem, ProblemSalinity, 1e-1);
 
 //! the CO2 Model and VolumeVariables properties
-SET_TYPE_PROP(HeterogeneousProblem, Model, CO2NIModel<TypeTag>);
-SET_TYPE_PROP(HeterogeneousProblem, VolumeVariables, CO2NIVolumeVariables<TypeTag>);
+SET_TYPE_PROP(HeterogeneousNIProblem, Model, CO2NIModel<TypeTag>);
+SET_TYPE_PROP(HeterogeneousNIProblem, VolumeVariables, CO2NIVolumeVariables<TypeTag>);
 
 // Enable gravity
-SET_BOOL_PROP(HeterogeneousProblem, ProblemEnableGravity, true);
+SET_BOOL_PROP(HeterogeneousNIProblem, ProblemEnableGravity, true);
 
-SET_BOOL_PROP(HeterogeneousProblem, ImplicitEnableJacobianRecycling, false);
-SET_BOOL_PROP(HeterogeneousProblem, VtkAddVelocity, false);
+SET_BOOL_PROP(HeterogeneousNIProblem, ImplicitEnableJacobianRecycling, false);
+SET_BOOL_PROP(HeterogeneousNIProblem, VtkAddVelocity, false);
 }
 
 
 /*!
  * \ingroup CO2NIModel
- * \ingroup BoxTestProblems
+ * \ingroup ImplicitTestProblems
  * \brief Problem where CO2 is injected under a low permeable layer in a depth of 1200m.
  *
  * The domain is sized 200m times 100m and consists of four layers, a
@@ -108,11 +108,11 @@ SET_BOOL_PROP(HeterogeneousProblem, VtkAddVelocity, false);
  * between different parts of the boundary.
  * These boundary ids can be imported into the problem where the boundary conditions can then be assigned accordingly.
  *
- * To run the simulation execute the following line in shell:
- * <tt>./test_co2 </tt>
+ * To run the simulation execute the following line in shell (works with the box and cell centered spatial discretization method):
+ * <tt>./test_ccco2ni </tt> or <tt>./test_boxco2ni </tt>
  */
 template <class TypeTag >
-class HeterogeneousProblem : public ImplicitPorousMediaProblem<TypeTag>
+class HeterogeneousNIProblem : public ImplicitPorousMediaProblem<TypeTag>
 {
     typedef ImplicitPorousMediaProblem<TypeTag> ParentType;
 
@@ -174,7 +174,7 @@ public:
      * \param timeManager The time manager
      * \param gridView The grid view
      */
-    HeterogeneousProblem(TimeManager &timeManager,
+    HeterogeneousNIProblem(TimeManager &timeManager,
                      const GridView &gridView)
         : ParentType(timeManager, GridCreator::grid().leafView()),
           //Boundary Id Setup:
diff --git a/test/implicit/co2ni/test_boxco2ni.cc b/test/implicit/co2ni/test_boxco2ni.cc
index b5223b0adf..1bd1ef8061 100644
--- a/test/implicit/co2ni/test_boxco2ni.cc
+++ b/test/implicit/co2ni/test_boxco2ni.cc
@@ -66,7 +66,7 @@ void usage(const char *progName, const std::string &errorMsg)
 int main(int argc, char** argv)
 {
 #if HAVE_ALUGRID
-    typedef TTAG(HeterogeneousBoxProblem) ProblemTypeTag;
+    typedef TTAG(HeterogeneousNIBoxProblem) ProblemTypeTag;
     return Dumux::start<ProblemTypeTag>(argc, argv, usage);
 #else
     std::cout << "Test skipped, it needs ALUGrid." << std::endl;
diff --git a/test/implicit/co2ni/test_ccco2ni.cc b/test/implicit/co2ni/test_ccco2ni.cc
index 73cf6ccc45..978046bfd2 100644
--- a/test/implicit/co2ni/test_ccco2ni.cc
+++ b/test/implicit/co2ni/test_ccco2ni.cc
@@ -66,7 +66,7 @@ void usage(const char *progName, const std::string &errorMsg)
 int main(int argc, char** argv)
 {
 #if HAVE_ALUGRID
-    typedef TTAG(HeterogeneousCCProblem) ProblemTypeTag;
+    typedef TTAG(HeterogeneousNICCProblem) ProblemTypeTag;
     return Dumux::start<ProblemTypeTag>(argc, argv, usage);
 #else
     std::cout << "Test skipped, it needs ALUGrid." << std::endl;
-- 
GitLab