parallel_vector.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 */
 
#ifndef __H__LIB_ALGEBRA__PARALLELIZATION__PARALLEL_VECTOR__
#define __H__LIB_ALGEBRA__PARALLELIZATION__PARALLEL_VECTOR__
 
#include "pcl/pcl.h"
#include "parallel_index_layout.h"
#include "parallelization_util.h"
#include "parallel_storage_type.h"
#include "algebra_layouts.h"
#include "common/assert.h"
 
namespace ug
{
 
 
 
template <typename TVector>
class ParallelVector : public TVector
{
  public:
    typedef typename TVector::value_type value_type;
    typedef size_t size_type;
    typedef typename TVector::vector_type vector_type;
    typedef ParallelVector<TVector> this_type;
 
  private:
  //  disallow copy constructor
    //ParallelVector(const ParallelVector&);
 
    template<typename T> this_type &operator =(T t);
 
 
  public:
    ParallelVector()
      : TVector(), m_type(PST_UNDEFINED), m_spAlgebraLayouts(new AlgebraLayouts)
    {}
 
    ParallelVector(size_t length)
      : TVector(length), m_type(PST_UNDEFINED), m_spAlgebraLayouts(new AlgebraLayouts)
    {}
 
    ParallelVector(ConstSmartPtr<AlgebraLayouts> layouts)
      : TVector(), m_type(PST_UNDEFINED), m_spAlgebraLayouts(layouts)
    {}
 
    // Storage type handling
 
    ConstSmartPtr<AlgebraLayouts> layouts() const {return m_spAlgebraLayouts;}
 
    void set_layouts(ConstSmartPtr<AlgebraLayouts> layouts) {m_spAlgebraLayouts = layouts;}
 
 
    void set_storage_type(uint type) {m_type = type;}
 
 
    void add_storage_type(uint type) {m_type |= type;}
 
 
    void remove_storage_type(uint type) {m_type &= ~type;}
 
    bool change_storage_type(ParallelStorageType type);
 
 
    bool has_storage_type(uint type) const
      {return type == PST_UNDEFINED ? m_type == PST_UNDEFINED : (m_type & type) == type;}
 
    uint get_storage_mask() const { return m_type; }
    ParallelStorageType get_storage_type() const { return (ParallelStorageType) m_type; }
 
    void check_storage_type() const;
 
    void enforce_consistent_type();
 
    // overwritten functions of sequential vector
 
 
    number norm() const;
 
    number maxnorm() const;
 
 
    inline number dotprod(const this_type& v);
 
    number operator = (number d);
 
    void set(number w, ParallelStorageType type);
 
    void set(number w){return set(w, PST_CONSISTENT);}
 
    void set_random(number from, number to, ParallelStorageType type);
    void set_random(number from, number to){return set_random(from, to, PST_CONSISTENT);}
 
    this_type &operator =(const this_type &v);
 
 
    this_type &operator -=(const this_type &v);
 
    this_type &operator +=(const this_type &v);
 
    SmartPtr<this_type> clone() const;
 
    SmartPtr<this_type> clone_without_values() const;
 
  protected:
    virtual this_type* virtual_clone() const;
 
    virtual this_type* virtual_clone_without_values() const;
 
  private:
  //  type of storage  (i.e. consistent, additive, additive unique)
  //  holds or-combiation of constants enumerated in ug::ParallelStorageType.
    uint m_type;
 
    ConstSmartPtr<AlgebraLayouts> m_spAlgebraLayouts;
};
 
} // end namespace ug
 
#include "parallel_vector_impl.h"
 
#endif /* __H__LIB_ALGEBRA__PARALLELIZATION__PARALLEL_VECTOR__ */