coordfunction.hh

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_GEOGRID_COORDFUNCTION_HH
#define DUNE_GEOGRID_COORDFUNCTION_HH

#include <cassert>

#include <dune/common/fvector.hh>
#include <dune/common/std/type_traits.hh>

namespace Dune
{

  // Internal Forward Declarations
  // -----------------------------

  template< class ct, unsigned int dimD, unsigned int dimR, class Impl >
  class AnalyticalCoordFunction;

  template< class ct, unsigned int dimR, class Impl >
  class DiscreteCoordFunction;



  // AnalyticalCoordFunctionInterface
  // --------------------------------

  template< class ct, unsigned int dimD, unsigned int dimR, class Impl >
  class AnalyticalCoordFunctionInterface
  {
    typedef AnalyticalCoordFunctionInterface< ct, dimD, dimR, Impl > This;

    friend class AnalyticalCoordFunction< ct, dimD, dimR, Impl >;

  public:
    typedef This Interface;
    typedef Impl Implementation;

    typedef ct ctype;

    static const unsigned int dimDomain = dimD;
    static const unsigned int dimRange = dimR;

    typedef FieldVector< ctype, dimDomain > DomainVector;
    typedef FieldVector< ctype, dimRange > RangeVector;

  private:
    AnalyticalCoordFunctionInterface () = default;
    AnalyticalCoordFunctionInterface ( const This & ) = default;
    AnalyticalCoordFunctionInterface ( This && ) = default;
    ~AnalyticalCoordFunctionInterface () = default;
    This &operator= ( const This & ) = default;
    This &operator= ( This && ) = default;

    // helper for picking the correct version of evaluate further down
    template<typename F, typename DV>
    using has_operator_parentheses = decltype(std::declval<F>()(std::declval<DV>()));

  public:

#ifdef DOXYGEN

    void evaluate ( const DomainVector &x, RangeVector &y ) const;

#else

    template<typename DV>
    std::enable_if_t<
      Std::is_detected<has_operator_parentheses,Impl,DV>::value
      >
    evaluate ( const DV &x, RangeVector &y ) const
    {
      y = asImp()(x);
    }

    template<typename DV>
    std::enable_if_t<
      not Std::is_detected<has_operator_parentheses,Impl,DV>::value
      >
    evaluate ( const DV &x, RangeVector &y ) const
    {
      assert(
        static_cast<void(This::*)(const DomainVector&, RangeVector&) const>(&This::evaluate) !=
        static_cast<void(Impl::*)(const DomainVector&, RangeVector&) const>(&Impl::evaluate) &&
        "You need to implement either operator() or evaluate() in your coordinate function!");
      asImp().evaluate( x, y );
    }

#endif // DOXYGEN

  protected:

    const Implementation &asImp () const
    {
      return static_cast< const Implementation & >( *this );
    }

    Implementation &asImp ()
    {
      return static_cast< Implementation & >( *this );
    }
  };



  // AnalyticalCoordFunction
  // -----------------------
  template< class ct, unsigned int dimD, unsigned int dimR, class Impl >
  class AnalyticalCoordFunction
    : public AnalyticalCoordFunctionInterface< ct, dimD, dimR, Impl >
  {
    typedef AnalyticalCoordFunction< ct, dimD, dimR, Impl > This;
    typedef AnalyticalCoordFunctionInterface< ct, dimD, dimR, Impl > Base;

  public:
    typedef typename Base :: DomainVector DomainVector;
    typedef typename Base :: RangeVector RangeVector;

  protected:
    AnalyticalCoordFunction () = default;
    AnalyticalCoordFunction ( const This & ) = default;
    AnalyticalCoordFunction ( This && ) = default;
    ~AnalyticalCoordFunction () = default;
    This &operator= ( const This & ) = default;
    This &operator= ( This && ) = default;

  private:

  };



  // DiscreteCoordFunctionInterface
  // ------------------------------

  template< class ct, unsigned int dimR, class Impl >
  class DiscreteCoordFunctionInterface
  {
    typedef DiscreteCoordFunctionInterface< ct, dimR, Impl > This;

    friend class DiscreteCoordFunction< ct, dimR, Impl >;

  public:
    typedef This Interface;
    typedef Impl Implementation;

    typedef ct ctype;

    static const unsigned int dimRange = dimR;

    typedef FieldVector< ctype, dimRange > RangeVector;

  private:
    DiscreteCoordFunctionInterface () = default;
    DiscreteCoordFunctionInterface ( const This & ) = default;
    DiscreteCoordFunctionInterface ( This && ) = default;
    ~DiscreteCoordFunctionInterface () = default;
    This &operator= ( const This & ) = default;
    This &operator= ( This && ) = default;

  public:
    template< class HostEntity >
    void evaluate ( const HostEntity &hostEntity, unsigned int corner,
                    RangeVector &y ) const
    {
      asImp().evaluate( hostEntity, corner, y );
    }

    void adapt ()
    {
      asImp().adapt();
    }

  protected:
    const Implementation &asImp () const
    {
      return static_cast< const Implementation & >( *this );
    }

    Implementation &asImp ()
    {
      return static_cast< Implementation & >( *this );
    }
  };



  // DiscreteCoordFunction
  // ---------------------
  //
  template< class ct, unsigned int dimR, class Impl >
  class DiscreteCoordFunction
    : public DiscreteCoordFunctionInterface< ct, dimR, Impl >
  {
    typedef DiscreteCoordFunction< ct, dimR, Impl > This;
    typedef DiscreteCoordFunctionInterface< ct, dimR, Impl > Base;

  public:
    typedef typename Base :: RangeVector RangeVector;

  protected:
    DiscreteCoordFunction () = default;
    DiscreteCoordFunction ( const This & ) = default;
    DiscreteCoordFunction ( This && ) = default;
    ~DiscreteCoordFunction () = default;
    This &operator= ( const This & ) = default;
    This &operator= ( This && ) = default;

    void adapt ()
    {}

  private:
    template< class HostEntity >
    void evaluate ( const HostEntity &hostEntity, unsigned int corner,
                    RangeVector &y ) const;
  };



  namespace GeoGrid
  {

    // isCoordFunctionInterface
    // ------------------------

    template< class CoordFunctionInterface >
    struct isCoordFunctionInterface
    {
      static const bool value = false;
    };

    template< class ct, unsigned int dimD, unsigned int dimR, class Impl >
    struct isCoordFunctionInterface
    < AnalyticalCoordFunctionInterface< ct, dimD, dimR, Impl > >
    {
      static const bool value = true;
    };

    template< class ct, unsigned int dimR, class Impl >
    struct isCoordFunctionInterface
    < DiscreteCoordFunctionInterface< ct, dimR, Impl > >
    {
      static const bool value = true;
    };



    // isDiscreteCoordFunctionInterface
    // --------------------------------

    template< class CoordFunctionInterface >
    struct isDiscreteCoordFunctionInterface
    {
      static const bool value = false;
    };

    template< class ct, unsigned int dimR, class Impl >
    struct isDiscreteCoordFunctionInterface
    < DiscreteCoordFunctionInterface< ct, dimR, Impl > >
    {
      static const bool value = true;
    };



    // AdaptCoordFunction
    // ------------------

    template< class CoordFunctionInterface >
    struct AdaptCoordFunction
    {
      static void adapt ( CoordFunctionInterface & )
      {}
    };

    template< class ct, unsigned int dimR, class Impl >
    struct AdaptCoordFunction< DiscreteCoordFunctionInterface< ct, dimR, Impl > >
    {
      typedef DiscreteCoordFunctionInterface< ct, dimR, Impl > CoordFunctionInterface;

      static void adapt ( CoordFunctionInterface &coordFunction )
      {
        coordFunction.adapt();
      }
    };

  } // namespace GeoGrid

} // namespace Dune

#endif // #ifndef DUNE_GEOGRID_COORDFUNCTION_HH