raster_layer_util.h

Go to the documentation of this file.

/*
 * Copyright (c) 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_raster_layer_util
#define __H__UG_raster_layer_util
 
#include <utility>
#include <string>
#include <vector>
#include "lib_grid/algorithms/heightfield_util.h"
#include "common/boost_serialization.h"
 
namespace ug{
 
struct RasterLayerDesc{
  RasterLayerDesc(const std::string& filename, number minHeight) : 
    m_filename(filename), m_minHeight(minHeight)  {}
 
  const std::string& filename() const   {return m_filename;}
  number min_height() const       {return m_minHeight;}
 
  private:
    std::string m_filename;
    number    m_minHeight;
};
 
typedef SmartPtr<RasterLayerDesc> SPRasterLayerDesc;
 
 
class RasterLayers{
  public:
    struct layer_t{
      layer_t() : heightfield(), minHeight(SMALL) {}
 
      Heightfield heightfield;
      number    minHeight;
 
      private:
      friend class boost::serialization::access;
      template <class Archive>
      void serialize( Archive& ar, const unsigned int version)
      {
        ar & minHeight;
        ar & heightfield;
      }
    };
 
 
    typedef RasterLayerDesc   LayerDesc;
    typedef SPRasterLayerDesc SPLayerDesc;
 
 
 
    void load_from_files(const std::vector<LayerDesc>& layerDescs);
 
    void load_from_files(const std::vector<SPLayerDesc>& layerDescs);
 
    void load_from_files(const std::vector<std::string>& filenames,
               number minLayerHeight);
 
    // void save_to_files(const char* filenamePrefix);
    // void save_rel_to_glob_table_to_files(const char* filenamePrefix);
 
 
    void resize(size_t newSize);
    
    size_t size() const     {return m_layers.size();}
    size_t num_layers() const {return m_layers.size();}
    bool empty() const      {return m_layers.empty();}
 
    layer_t& operator[] (size_t i)        {return *m_layers[i];}
    const layer_t& operator[] (size_t i) const  {return *m_layers[i];}
 
    layer_t&    layer (size_t i)      {return *m_layers[i];}
    const layer_t&  layer (size_t i) const    {return *m_layers[i];}
 
    const layer_t&  top () const        {return *m_layers.back();}
 
    Heightfield&    heightfield (size_t i)      {return layer(i).heightfield;}
    const Heightfield&  heightfield (size_t i) const  {return layer(i).heightfield;}
 
    void  set_min_height (size_t i, number h)   {layer(i).minHeight = h;}
    number  min_height (size_t i) const       {return layer(i).minHeight;}
 
 
    void invalidate_flat_cells();
 
    void invalidate_small_lenses(number minArea);
 
    void remove_small_holes(number maxArea);
 
 
    void snap_cells_to_higher_layers();
 
    void eliminate_invalid_cells();
 
    void blur_layers (number alpha, size_t numIterations);
 
 
    std::pair<int, number> trace_line_down (const vector2& c, size_t firstLayer) const;
 
 
    std::pair<int, number> trace_line_up (const vector2& c, size_t firstLayer) const;
 
 
    std::pair<int, int> get_layer_indices (const vector3& c) const;
 
 
    number relative_to_global_height (const vector2& c, number relHeight) const;
 
 
    number relative_to_global_height_simple (const vector2& c, number relHeight) const;
 
 
    void construct_relative_to_global_height_table (size_t iterations, number alpha);
 
 
    void invalidate_relative_to_global_height_table ();
 
  private:
 
    number upper_lower_dist_relation (  Field<number>&lower,
                      Field<number>& middle,
                      Field<number>& upper,
                      size_t ix,
                      size_t iy);
 
  //  BEGIN SERIALIZATION
    friend class boost::serialization::access;
 
    template <class Archive>
    void save( Archive& ar, const unsigned int version) const
    {
      size_t numLayers = m_layers.size();
      ar & numLayers;
      for(size_t i = 0; i < m_layers.size(); ++i){
        ar & *m_layers[i];
      }
 
      size_t numRelToGlob = m_relativeToGlobalHeights.size();
      ar & numRelToGlob;
      for(size_t i = 0; i < m_relativeToGlobalHeights.size(); ++i){
        ar & *m_relativeToGlobalHeights[i];
      }
    }
 
    template <class Archive>
    void load( Archive& ar, const unsigned int version)
    {
      size_t numLayers = 0;
      ar & numLayers;
      m_layers.resize(numLayers);
      for(size_t i = 0; i < numLayers; ++i){
        m_layers[i] = make_sp(new layer_t);
        ar & *m_layers[i];
      }
 
      size_t numRelToGlob = 0;
      ar & numRelToGlob;
      m_relativeToGlobalHeights.resize(numRelToGlob);
      for(size_t i = 0; i < numRelToGlob; ++i){
        m_relativeToGlobalHeights[i] = make_sp(new Heightfield);
        ar & *m_relativeToGlobalHeights[i];
      }
    }
    
    BOOST_SERIALIZATION_SPLIT_MEMBER()
  //  END SERIALIZATION
 
    std::vector<SmartPtr<layer_t> > m_layers;
 
    std::vector<SmartPtr<Heightfield> > m_relativeToGlobalHeights;
};
 
typedef SmartPtr<RasterLayers>  SPRasterLayers;
 
}// end of namespace
 
#endif  //__H__UG_raster_layer_util