Commit 32912570 authored by Santiago's avatar Santiago

[Common] Improve initial condition docstrings

parent e5f97f4f
...@@ -8,18 +8,22 @@ ...@@ -8,18 +8,22 @@
#include <dune/common/exceptions.hh> #include <dune/common/exceptions.hh>
#include <dune/common/parametertree.hh> #include <dune/common/parametertree.hh>
#include <dune/dorie/common/interpolator.hh>
#include <dune/dorie/common/initial_condition/initial_condition.hh> #include <dune/dorie/common/initial_condition/initial_condition.hh>
namespace Dune{ namespace Dune{
namespace Dorie{ namespace Dorie{
/*-------------------------------------------------------------------------*//** /*-------------------------------------------------------------------------*//**
* @brief * @brief Class for initial conditions from hdf5 data files.
*
* @ingroup InitialConditions
* @author Santiago Ospina
* @date 2019
* *
* @ingroup InitialConditions for HDF5 files
*
* @tparam T BaseTraits * @tparam T BaseTraits
*/ */
template<class T> template<class T>
class InitialConditionH5 class InitialConditionH5
: public InitialCondition<T> : public InitialCondition<T>
...@@ -91,11 +95,12 @@ public: ...@@ -91,11 +95,12 @@ public:
} }
~InitialConditionH5() override
{
_interpolator.reset();
}
/// Evaluate the initial condition at certain position
/** \param y
* \param x Position in local element coordinates
* \param e Element enitity
*/
void evaluate ( const typename Traits::ElementType& e, void evaluate ( const typename Traits::ElementType& e,
const typename Traits::DomainType& x, const typename Traits::DomainType& x,
typename Traits::RangeType& y) const override typename Traits::RangeType& y) const override
......
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