[Transport] Add code documentation

parent f7a278e0
......@@ -2,11 +2,22 @@
#define DUNE_DORIE_HYDRODYNAMIC_DISPERSION_ADAPTER_HH
#include <dune/pdelab/common/function.hh>
// #include <dune/dorie/common/tensor_to_glyph.hh>
namespace Dune{
namespace Dorie{
/*-------------------------------------------------------------------------*//**
* @brief Converts an interface to match an effective hydrodynamic dispersion.
* @details For a given paramaterization, water flux and water content, this
* class returns the hydrodynamic dispersion tensor (od dimension
* dimRange) in an aliased vector.
*
* @tparam T The base traits
* @tparam Parameter The transport parameter class
* @tparam GFWaterFlux The water flux grid function class
* @tparam GFWaterContent The water content grid function class
* @tparam dimRange The range dimension of the aliased tensor
*/
template<class T, class Parameter, class GFWaterFlux, class GFWaterContent, int dimRange = 3>
class EffectiveHydrodynamicDispersionAdapter
: public Dune::PDELab::GridFunctionBase<
......@@ -50,12 +61,12 @@ public:
{}
/*-----------------------------------------------------------------------*//**
* @brief Evaluation of the hydrodynamic dispersion for a given entity e
* in an entity position x
* @brief Evaluation of the effective hydrodynamic dispersion for a given
* entity e in an entity position x
*
* @param[in] e Entity of a grid
* @param[in] x Position in local coordinates with respect the entity
* @param y Hydrodynamic dispersion at position x
* @param y Effective hydrodynamic dispersion at position x
*/
void evaluate ( const typename Traits::ElementType& e,
const typename Traits::DomainType& x,
......@@ -105,7 +116,7 @@ private:
const std::shared_ptr<const GFWaterContent> _gf_water_content;
};
}
}
} // namespace Dune
} // namespace Dorie
#endif
\ No newline at end of file
#endif // DUNE_DORIE_HYDRODYNAMIC_DISPERSION_ADAPTER_HH
\ No newline at end of file
......@@ -6,6 +6,14 @@
namespace Dune{
namespace Dorie{
/**
* @brief Converts an interface to match a microscopic peclet number.
*
* @tparam T The base traits
* @tparam Parameter The transport parameter class
* @tparam GFWaterFlux The water flux grid function class
* @tparam GFWaterContent The water content grid function class
*/
template<class T, class Parameter, class GFWaterFlux, class GFWaterContent>
class PecletAdapter
: public Dune::PDELab::GridFunctionBase<
......@@ -31,12 +39,14 @@ private:
using Domain = typename T::Domain;
public:
/*-------------------------------------------------------------------*//**
/*-----------------------------------------------------------------------*//**
* @brief Constructor for the PecletAdapter
*
* @param gv GridView
* @param gv GridView
* @param[in] param The parameter
* @param[in] gf_water_flux The gf water flux
* @param[in] gf_water_content The gf water content
* @param p Parametrization class
* @see RichardsEquationParameter
*/
PecletAdapter(const typename Traits::GridViewType& gv,
std::shared_ptr<const Parameter> param,
......@@ -48,13 +58,13 @@ public:
, _gf_water_content(gf_water_content)
{}
/*-------------------------------------------------------------------*//**
* @brief Evaluation of the conductivity for a given entity e in an
* entity position x
/*-----------------------------------------------------------------------*//**
* @brief Evaluation of the microscopic peclet number for a given entity
* e in an entity position x
*
* @param[in] e Entity of a grid
* @param[in] x Position in local coordinates with respect the entity
* @param y Saturated conductivity at position x
* @param y Microscopic peclet number at position x
*/
void inline evaluate ( const typename Traits::ElementType& e,
const typename Traits::DomainType& x,
......@@ -90,7 +100,8 @@ private:
const std::shared_ptr<const GFWaterFlux> _gf_water_flux;
const std::shared_ptr<const GFWaterContent> _gf_water_content;
};
}
}
#endif
\ No newline at end of file
} // namespace Dune
} // namespace Dorie
#endif // DUNE_DORIE_PECLET_ADAPTER_HH
\ No newline at end of file
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