Commit e5c13de6 authored by Santiago Ospina's avatar Santiago Ospina

Add richards and transport models to the doxygen groups [ci skip].

Signed-off-by: Santiago Ospina De Los Ríos's avatarSantiago Ospina <santiago.ospina@iup.uni-heidelberg.de>
parent 0bdea0b3
/** /**
@defgroup Common Common @defgroup Common Common
@{ @{
......
...@@ -19,6 +19,7 @@ ...@@ -19,6 +19,7 @@
#include <dune/dorie/common/time_controller.hh> #include <dune/dorie/common/time_controller.hh>
#include <dune/dorie/common/grid_mapper.hh> #include <dune/dorie/common/grid_mapper.hh>
#include <dune/dorie/common/grid_function_writer.hh> #include <dune/dorie/common/grid_function_writer.hh>
#include <dune/dorie/model/richards/adaptivity/handler.hh> #include <dune/dorie/model/richards/adaptivity/handler.hh>
#include <dune/dorie/model/richards/parameterization/interface.hh> #include <dune/dorie/model/richards/parameterization/interface.hh>
#include <dune/dorie/model/richards/parameterization/richards.hh> #include <dune/dorie/model/richards/parameterization/richards.hh>
...@@ -39,6 +40,8 @@ namespace Dorie{ ...@@ -39,6 +40,8 @@ namespace Dorie{
* class extends BaseTraits to be used for the DG implementation of * class extends BaseTraits to be used for the DG implementation of
* the Richards simulation * the Richards simulation
* *
* @ingroup RichardsModel
*
* @tparam BaseTraits Traits defining domain and range field properties of * @tparam BaseTraits Traits defining domain and range field properties of
* the simulation. * the simulation.
* @tparam order Order of the polynomial degree used for the basis * @tparam order Order of the polynomial degree used for the basis
...@@ -134,6 +137,8 @@ struct RichardsSimulationTraits : public BaseTraits ...@@ -134,6 +137,8 @@ struct RichardsSimulationTraits : public BaseTraits
* for the richards equation. It can perform time-steps and print * for the richards equation. It can perform time-steps and print
* the solution * the solution
* *
* @ingroup RichardsModel
*
* @tparam RichardsSimulationTraits Traits containing the type definitions * @tparam RichardsSimulationTraits Traits containing the type definitions
* for Richards Simulation * for Richards Simulation
*/ */
......
...@@ -22,6 +22,7 @@ ...@@ -22,6 +22,7 @@
#include <dune/dorie/common/grid_mapper.hh> #include <dune/dorie/common/grid_mapper.hh>
#include <dune/dorie/common/grid_function_writer.hh> #include <dune/dorie/common/grid_function_writer.hh>
#include <dune/dorie/common/cfl_condition.hh> #include <dune/dorie/common/cfl_condition.hh>
#include <dune/dorie/model/transport/solute_initial.hh> #include <dune/dorie/model/transport/solute_initial.hh>
#include <dune/dorie/model/transport/solute_boundary.hh> #include <dune/dorie/model/transport/solute_boundary.hh>
#include <dune/dorie/model/transport/local_operator_FV.hh> #include <dune/dorie/model/transport/local_operator_FV.hh>
...@@ -34,6 +35,8 @@ namespace Dorie{ ...@@ -34,6 +35,8 @@ namespace Dorie{
* class extends BaseTraits to be used for the DG implementation of * class extends BaseTraits to be used for the DG implementation of
* the Transport simulation * the Transport simulation
* *
* @ingroup TransportModel
*
* @tparam BaseTraits Traits defining domain and range field * @tparam BaseTraits Traits defining domain and range field
* properties of the simulation. * properties of the simulation.
* @tparam GFWaterFluxType Grid Function type of the water flux * @tparam GFWaterFluxType Grid Function type of the water flux
...@@ -124,6 +127,8 @@ struct TransportSimulationTraits : public BaseTraits ...@@ -124,6 +127,8 @@ struct TransportSimulationTraits : public BaseTraits
* @todo Implement adaptivity. * @todo Implement adaptivity.
* @todo Implement DG local operator. * @todo Implement DG local operator.
* *
* @ingroup TransportModel
*
* @tparam TransportSimulationTraits Traits containing the type definitions * @tparam TransportSimulationTraits Traits containing the type definitions
* which this class will use. * which this class will use.
*/ */
......
...@@ -9,7 +9,7 @@ except NameError: ...@@ -9,7 +9,7 @@ except NameError:
pass pass
# paths set by cmake # paths set by cmake
DORIEDIR = "/home/saospina/Codes/DUNE_INSTALL/Release/dorie" DORIEDIR = "/home/saospina/Codes/DUNE_INSTALL/Debug/dorie"
MPIEXEC = "/usr/bin/mpiexec" MPIEXEC = "/usr/bin/mpiexec"
MPIEXEC_NUMPROC_FLAG = "-n" MPIEXEC_NUMPROC_FLAG = "-n"
MPIEXEC_PREFLAG = "" MPIEXEC_PREFLAG = ""
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment