load_balancing.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter
 * 
 * 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__UG__load_balancing__
#define __H__UG__load_balancing__
 
#include <vector>
#include "lib_grid/algorithms/geom_obj_util/geom_obj_util.h"
#include "lib_grid/tools/subset_handler_grid.h"
#include "lib_grid/multi_grid.h"
#include "lib_grid/parallelization/util/parallel_callbacks.h"
#include "lib_grid/callbacks/basic_callbacks.h"
 
namespace ug
{
 
 
template <class TElem, class TIterator, class TAAPos>
bool PartitionElements_RegularGrid(SubsetHandler& shOut,
                TIterator begin, TIterator end,
                int numCellsX, int numCellsY, int numCellsZ,
                TAAPos& aaPos,
                typename Grid::traits<TElem>::callback cbConsiderElem
                  = ConsiderAll(),
                int bucketSubset = -1);
 
 
template <class TGeomBaseObj>
bool PartitionGrid_MetisKway(SubsetHandler& shPartitionOut,
               Grid& grid, int numParts);
 
 
template <class TGeomBaseObj>
bool PartitionMultiGrid_MetisKway(SubsetHandler& shPartitionOut,
                  MultiGrid& grid, int numParts,
                  size_t baseLevel = 0,
                  int hWeight = 1, int vWeight = 1);
 
 
template <class TGeomBaseObj>
bool PartitionMultiGrid_MetisKway(SubsetHandler& shPartitionOut,
                  MultiGrid& grid, int numParts, size_t baseLevel,
                  boost::function<int (TGeomBaseObj*, TGeomBaseObj*)>& weightFct);
 
 
template <class TGeomBaseObj>
bool PartitionMultiGridLevel_MetisKway(SubsetHandler& shPartitionOut,
                  MultiGrid& mg, int numParts, size_t level);
 
 
template <class TGeomBaseObj>
bool PartitionMultiGridLevel_ParmetisKway(SubsetHandler& shPartitionOut,
                      MultiGrid& mg, int numParts, size_t level);
 
}// end of namespace
 
 
//  include implementation
#include "load_balancing_impl.hpp"
 
#endif