[Doc] Improve class documentation

parent 704015f9
......@@ -10,6 +10,22 @@
namespace Dune{
namespace Dorie{
/*-------------------------------------------------------------------------*//**
* @brief Traits for the class RichardsTransportCouplingSimulation.
* @details This class extends BaseTraits to be used for the implementation
* of the Richards and Transport simulations.
* @author Santiago Ospina De Los Ríos
* @date 2018-2019
* @ingroup TransportModel
* @ingroup RichardsModel
*
* @tparam BaseTraits Traits defining domain and range field properties
* of the simulation.
* @tparam RichardsOrder Order of the polynomial degree used for the basis
* functions in the Richards DG method.
* @tparam TransportOrder Order of the polynomial degree used for the basis
* functions in the Transport DG/FV method.
*/
template<class BaseTraits, unsigned int RichardsOrder, unsigned int TransportOrder>
struct RichardsTransportCouplingSimulationTraits : public BaseTraits
{
......@@ -35,6 +51,21 @@ public:
};
/*-------------------------------------------------------------------------*//**
* @brief Class for richards transport coupling simulation.
* @details For given RichardsTransportCouplingSimulationTraits, this class
* manages the simulation for the coupling between transport and
* richards simulations.
* @author Santiago Ospina De Los Ríos
* @date 2018-2019
* @ingroup TransportModel
* @ingroup RichardsModel
*
* @todo Implement source term.
*
* @tparam T Traits containing the type definitions which this class
* will use. (see RichardsTransportCouplingSimulationTraits)
*/
template<class T>
class RichardsTransportCouplingSimulation : public SimulationBase
{
......@@ -98,6 +129,7 @@ public:
*/
void mark_grid() override
{
// select model and mark the grid
if (adaptivity_policy() == AdaptivityPolicy::WaterFlux)
{
_richards->set_policy(adaptivity_policy());
......
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