solute_initial.hh 1.23 KB
Newer Older
1 2 3 4 5 6
#ifndef DUNE_DORIE_TRANSPORT_INITIAL_HH
#define DUNE_DORIE_TRANSPORT_INITIAL_HH

#include <dune/pdelab/function/const.hh>

namespace Dune {
7
namespace Dorie {
8

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
#ifndef DOXYGEN /* Actual code */

template<typename T>
using SoluteInitial = Dune::PDELab::ConstGridFunction<
                        typename T::GridView,
                        typename T::RangeField>;

#else /* Documentation of the code */

/**
 * @brief      Class for initial condition of the solute concentration.
 * @remark     This class is equivalent to Dune::PDELab::ConstGridFunction.
 * @author     Santiago Ospina De Los Ríos
 * @date       2018
 * @copyright  MIT License.
 * @ingroup    TransportModel
 * @see        Same as Dune::Dorie::FlowInitial.
 * 
 * @todo Implement useful shape functions (e.g. 
 *       <a href="https://en.wikipedia.org/wiki/Kernel_(statistics)">kernels</a>
 *       ) that allow more realistic boundary conditions for the transport 
 *       simulation. 
 * 
 * @tparam     Traits  The Dune::Dorie::BaseTraits that defines basic data 
 *                     types.
 */
template<typename T>
class SoluteInitial 
  : public Dune::PDELab::ConstGridFunction<
            typename T::GridView,
            typename T::RangeField> 
{};

#endif

44 45 46 47
}
}

#endif