subset_util.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-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__LIB_GRID__SUBSET_UTIL__
#define __H__LIB_GRID__SUBSET_UTIL__
 
#include <vector>
#include "lib_grid/lg_base.h"
#include "common/ug_config.h"
 
namespace ug
{
 
//  FindFirstFreeSubset
 
template <class TElem>
int GetMaxSubsetIndex(SubsetHandler& sh);
 
UG_API
int GetFirstFreeSubset(const ISubsetHandler& sh);
 
//  MakeSubsetsConsecutive
 
template <class TElem>
void MakeSubsetsConsecutive(SubsetHandler& sh);
 
 
UG_API
void AssignGridToSubset(Grid& g, ISubsetHandler& sh, int subsetInd);
 
 
UG_API
void AssignSelectionToSubset(ISelector& sel, ISubsetHandler& sh, int subsetInd);
 
//  AssignFaceInterfaceEdgesToSubsets
 
UG_API
void AssignFaceInterfaceEdgesToSubsets(Grid& grid, SubsetHandler& sh);
 
//  AssignVolumeInterfaceFacesToSubsets
 
UG_API
void AssignVolumeInterfaceFacesToSubsets(Grid& grid, SubsetHandler& sh);
 
//  AssignAssociatedVerticesToSubset
 
template <class TIterator>
void AssignAssociatedVerticesToSubset(ISubsetHandler& sh, TIterator elemsBegin,
                    TIterator elemsEnd, int subsetIndex);
 
 
 
template <class TIterator>
void CopySubsetIndicesToSides(ISubsetHandler& sh, TIterator elemsBegin,
              TIterator elemsEnd, bool toUnassignedOnly);
 
 
UG_API
void CopySubsetIndicesToSides(ISubsetHandler& sh, GridObjectCollection goc,
                bool toUnassignedOnly);
 
 
UG_API
void CopySubsetIndicesToSides(ISubsetHandler& sh, ISelector& sel,
                bool toUnassignedOnly);
 
 
UG_API
void CopySubsetIndicesToSides(ISubsetHandler& sh, bool toUnassignedOnly);
 
//  AdjustSubsetsForLgmNg
 
UG_API
void AdjustSubsetsForLgmNg(Grid& grid, SubsetHandler& sh,
              bool keepExistingInterfaceSubsets = false);
 
//  SplitIrregularManifoldSubset
 
UG_API
bool SplitIrregularManifoldSubset(SubsetHandler& sh, int srcIndex,
                  int targetIndex, bool strictSplitting = false);
 
//  SeparateFaceSubsetsByNormal
 
UG_API
void SeparateFaceSubsetsByNormal(Grid& grid, SubsetHandler& sh,
                APosition aPos = aPosition,
                ANormal* paNorm = NULL,
                int applyToSubset = -2);
 
//  SeparateFaceSubsetsByNormal
 
UG_API
void SeparateFaceSubsetsByNormal(Grid& grid, SubsetHandler& sh,
                std::vector<vector3> vNormals,
                APosition aPos = aPosition,
                ANormal* paNorm = NULL,
                int applyToSubset = -2);
 
 
UG_API
void AssignRegionToSubset(Grid& grid, ISubsetHandler& shVolsOut,
              const ISubsetHandler& shFaces,
              Volume* proxyVol, int newSubsetIndex);
 
 
UG_API
bool SeparateRegions(Grid& grid, ISubsetHandler& shVolsOut,
           const ISubsetHandler& shFaces,
           const MarkerPointManager& mpm,
           int firstSubsetIndex);
 
//  SeparateSubsetsByLowerDimSubsets
 
template <class TElem>
void SeparateSubsetsByLowerDimSubsets(Grid& grid, SubsetHandler& sh,
                    bool appendAtEnd = false);
 
//  SeparateSubsetsByLowerDimSelection
 
template <class TElem>
void SeparateSubsetsByLowerDimSelection(Grid& grid, SubsetHandler& sh,
                    Selector& sel, bool appendAtEnd = false);
 
//  SeparateSubsetsByLowerDimSeparators
 
template <class TElem>
void SeparateSubsetsByLowerDimSeparators(Grid& grid, SubsetHandler& sh,
          bool appendAtEnd,
          boost::function<bool (typename TElem::lower_dim_base_object*)>
            cbIsSeparator);
 
//  AssignInnerAndBoundarySubsets
UG_API
void AssignInnerAndBoundarySubsets(Grid& grid, ISubsetHandler& shOut,
                  int inSubset, int bndSubset);
 
 
//todo: Move this method to common/util or something like that.
UG_API
vector3 GetColorFromStandardPalette(int index);
 
//  AssignSubsetColors
UG_API
void AssignSubsetColors(ISubsetHandler& sh);
 
 
 
 
template <class TElem>
void AssignSidesToSubsets(ISubsetHandler& sh, ISelector* psel = NULL);
 
template <class TElem, class TSubsetHandler>
void AssignUnassignedElemsToSubset(TSubsetHandler& sh, int si);
 
 
 
template <class TSubsetHandler>
void AdjustSubsetsForSimulation(TSubsetHandler& sh,
                bool preserveExistingSubsets);
 
 
UG_API
void AssignSubsetsByElementType(ISubsetHandler& sh);
 
UG_API
void AssignSubsetsByElementType(ISubsetHandler& sh, GridObjectCollection g);
//  FaceArea
 
template <class TAAPosVRT>
UG_API
number FaceArea(ISubsetHandler& sh, int si, size_t lvl, TAAPosVRT& aaPos);
 
 
//  AssignAssociatedVerticesToSubsets
 
template <class TElem, class TSubsetHandler>
void AssignAssociatedVerticesToSubsets(TSubsetHandler& sh,
                  const ISubsetHandler& srcIndHandler);
 
//  AssignAssociatedEdgesToSubsets
 
template <class TElem, class TSubsetHandler>
void AssignAssociatedEdgesToSubsets(TSubsetHandler& sh,
                  const ISubsetHandler& srcIndHandler);
 
//  AssignAssociatedFacesToSubsets
 
template <class TElem, class TSubsetHandler>
void AssignAssociatedFacesToSubsets(TSubsetHandler& sh,
                  const ISubsetHandler& srcIndHandler);
 
//  AssignAssociatedFacesToSubsets
 
template <class TElem, class TSubsetHandlerDest, class TSubsetHandlerSrc>
void AssignAssociatedSidesToSubsets(TSubsetHandlerDest& sh,
                  const TSubsetHandlerSrc& srcIndHandler);
 
//  AssignAssociatedLowerDimElems
 
template <class TElem, class TSubsetHandlerDest, class TSubsetHandlerSrc>
void AssignAssociatedLowerDimElemsToSubsets(TSubsetHandlerDest& sh,
                  const TSubsetHandlerSrc& srcIndHandler);
 
 
template <typename TBaseObj>
void FindSubsetGroups(
    std::vector<int> & minCondInd,
    const std::vector<bool> & isMarked,
    const ISubsetHandler & sh,
    const NeighborhoodType nbhType = NHT_VERTEX_NEIGHBORS);
 
 
 
UG_API
void ComputeLocalSubsetDimensions(
    ISubsetHandler& sh, 
    AChar aDimension,
    bool includeUnassigned);
 // end of doxygen defgroup command
}// end of namespace
 
// include implementations of template methods.
#include "subset_util_impl.hpp"
 
#endif