algebra_layouts.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-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__UG4__LIB_ALGEBRA__PARALLELIZATION__ALGEBRA_LAYOUTS__
#define __H__UG4__LIB_ALGEBRA__PARALLELIZATION__ALGEBRA_LAYOUTS__
 
#ifdef UG_PARALLEL
#include "pcl/pcl_base.h"
#include "lib_algebra/parallelization/parallel_index_layout.h"
#endif
 
namespace ug{
 
#ifdef UG_PARALLEL
 
 
class HorizontalAlgebraLayouts
{
  public:
    HorizontalAlgebraLayouts() : m_overlapEnabled(false)  {}
 
    void clear()
    {
      masterLayout.clear();     slaveLayout.clear();
    }
 
  public:
    const IndexLayout& master() const         {return masterLayout;}
    const IndexLayout& master_overlap() const     {return masterOverlapLayout;}
    const IndexLayout& slave() const        {return slaveLayout;}
    const IndexLayout& slave_overlap() const    {return slaveOverlapLayout;}
 
    const pcl::ProcessCommunicator& proc_comm() const   {return processCommunicator;}
 
 
    pcl::InterfaceCommunicator<IndexLayout>& comm() const   {return const_cast<HorizontalAlgebraLayouts*>(this)->communicator;}
 
    void enable_overlap(bool enable)  {m_overlapEnabled = enable;}
    bool overlap_enabled() const    {return m_overlapEnabled;}
 
  public:
    IndexLayout& master()     {return masterLayout;}
    IndexLayout& master_overlap()   {return masterOverlapLayout;}
    IndexLayout& slave()      {return slaveLayout;}
    IndexLayout& slave_overlap()  {return slaveOverlapLayout;}
 
    pcl::InterfaceCommunicator<IndexLayout>& comm()   {return communicator;}
    pcl::ProcessCommunicator& proc_comm()       {return processCommunicator;}
 
  protected:
    IndexLayout masterLayout;
    IndexLayout masterOverlapLayout;
 
    IndexLayout slaveLayout;
    IndexLayout slaveOverlapLayout;
 
    pcl::ProcessCommunicator processCommunicator;
 
    pcl::InterfaceCommunicator<IndexLayout> communicator;
 
    bool m_overlapEnabled;
};
 
class AlgebraLayouts : public HorizontalAlgebraLayouts
{
  public:
    void clear()
    {
      HorizontalAlgebraLayouts::clear();
      verticalMasterLayout.clear(); verticalSlaveLayout.clear();
    }
 
  public:
    const IndexLayout& vertical_master() const  {return verticalMasterLayout;}
    const IndexLayout& vertical_slave() const   {return verticalSlaveLayout;}
 
  public:
    IndexLayout& vertical_master()    {return verticalMasterLayout;}
    IndexLayout& vertical_slave()     {return verticalSlaveLayout;}
 
  protected:
    IndexLayout verticalMasterLayout;
 
    IndexLayout verticalSlaveLayout;
};
 
std::ostream &operator << (std::ostream &out, const HorizontalAlgebraLayouts &layouts);
std::ostream &operator << (std::ostream &out, const AlgebraLayouts &layouts);
 
#endif
 
 
} // end namespace ug
 
#endif /* __H__UG4__LIB_ALGEBRA__PARALLELIZATION__ALGEBRA_LAYOUTS__ */