norm.hh

Go to the documentation of this file.

/*
 * norm.hh
 *
 *  Created on: May 2, 2015
 *      Author: sunayana_ghosh
 */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                           */
/*  This file is part of the library KASKADE 7                               */
/*  https://www.zib.de/research/projects/kaskade7-finite-element-toolbox     */
/*                                                                           */
/*  Copyright (C) 2015-2015 Zuse Institute Berlin                            */
/*                                                                           */
/*  KASKADE 7 is distributed under the terms of the ZIB Academic License.    */
/*    see $KASKADE/academic.txt                                              */
/*                                                                           */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#ifndef KASKADE_TIMESTEPPING_EULERSDC_NORM_HH_
#define KASKADE_TIMESTEPPING_EULERSDC_NORM_HH_
 
#include <numeric>
#include <vector>
 
//includes from Kaskade7.3
#include "utilities/linalg/scalarproducts.hh"
 
namespace Kaskade {
 
  //=======================================================================================================
  //  Implementation for enum class NormType
  //=======================================================================================================
 
  //---C++11 strongly typed enums. Would be used in the work model to call different functions.
  enum class NormType {
    ONE_NORM,         
    MAX_NORM          
  };
 
  //=======================================================================================================
  //  Implementation abstract base class Norm
  //=======================================================================================================
  template <class Vector>
  class Norm
  {
  public:
    using field_type = typename Vector::value_type;
 
 
 
    //pure virtual functions
    virtual field_type value(std::vector<Vector> const& vecs) = 0;
 
    //every abstract base class has a virtual destructor
    virtual ~Norm (){}
 
  private:
    NormType norm_t;
 
  };
 
  //=================================================================================================
  //  Implementation for derive class one norm
  //=================================================================================================
  template <class Vector>
  class OneNorm: public Norm<Vector>
  {
  public:
    using field_type = typename Vector::value_type;
 
 
 
    virtual field_type value(std::vector<Vector> const& vecs)
    {
 
      //Using Kaskade::LinAlg::OneNorm instead of one_norm for Dune::FieldVector since the one norm defined
      //in Kaskade works for stl-container, Dune::FieldVector and Dune::FieldMatrix making it more generic.
      return std::accumulate(vecs.begin(),vecs.end(),0.0,[](field_type init, Vector const& v)
          {
        Kaskade::LinAlg::OneNorm on;
        return init + on(v);
          });
    }
 
    virtual ~OneNorm () {}
  };
 
  //=======================================================================================================
  //  Implementation for derived class max norm
  //=======================================================================================================
  template <class Vector>
  class MaxNorm : public Norm<Vector>
  {
  public:
    using field_type = typename Vector::value_type;
 
    virtual field_type value(std::vector<Vector> const& vecs)
    {
      //Using Kaskade::LinAlg::OneNorm instead of one_norm for Dune::FieldVector since the one norm defined
      //in Kaskade works for stl-container, Dune::FieldVector and Dune::FieldMatrix making it more generic.
      Kaskade::LinAlg::InfinityNorm in;
      field_type max = in(vecs[0]);
      for (auto i = 1u; i < vecs.size(); ++i)
        max = std::max(max, in(vecs[i]));
 
      return max;
    }
 
    virtual ~MaxNorm () {}
  };
 
 
} //end namespace Kaskade
 
 
#endif /* KASKADE_TIMESTEPPING_EULERSDC_NORM_HH_ */