regular_3d_mesh_placement.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2015-06-12
 * Last modified: 2015-06-12
 *
 * License: GPL 3
 *
 * Description:
 *
 *  Regular 3D mesh placement in a logical volume
 *
 */

#ifndef GEOMTOOLS_REGULAR_3D_MESH_PLACEMENT_H
#define GEOMTOOLS_REGULAR_3D_MESH_PLACEMENT_H

// Standard library:
#include <iostream>
#include <string>
#include <vector>

// Third party:
// - Boost:
#include <boost/scoped_ptr.hpp>
#include <boost/utility.hpp>
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/logger.h>

// This project:
#include <geomtools/i_placement.h>
#include <geomtools/placement.h>
#include <geomtools/logical_volume.h>

namespace geomtools {

  class regular_3d_mesh_placement
    : public i_placement
    , private boost::noncopyable
  {
  public:

    bool is_valid() const;

    void invalidate();

    void set_logging(datatools::logger::priority);

    datatools::logger::priority get_logging() const;

    bool has_cache_file_path() const;

    const std::string & get_cache_file_path() const;

    void set_cache_file_path(const std::string &);

    void set_log_vol(const logical_volume &);

    bool has_log_vol() const;

    void set_node_log_vol(const logical_volume &);

    bool has_node_log_vol() const;

    void set_steps(double step_x_, double step_y_, double step_z_);

    void set_starts(double x0_, double y0_, double z0_);

    void set_stops(double x1_, double y1_, double z1_);

    void set_step_x(double step_x_);

    void set_step_y(double step_y_);

    void set_step_z(double step_z_);

    void set_start_x(double x0_);

    void set_start_y(double y0_);

    void set_start_z(double z0_);

    void set_stop_x(double x1_);

    void set_stop_y(double y1_);

    void set_stop_z(double z1_);

    void set_overlapping_flags(uint32_t);

    uint32_t get_overlapping_flags() const;

    virtual bool has_only_one_rotation() const;

    virtual size_t get_dimension() const;

    virtual bool is_replica() const;

    virtual size_t get_number_of_items() const;

    virtual void get_placement(int item_, placement & p_) const;

    virtual size_t compute_index_map(std::vector<uint32_t> & map_,
                                     int item_) const;

    const placement & get_basic_placement() const;

    regular_3d_mesh_placement();

    virtual ~regular_3d_mesh_placement();

    bool is_initialized() const;

    void initialize();

    void initialize(const datatools::properties & config_);

    virtual void reset();

    virtual void tree_dump(std::ostream & out_  = std::clog,
                           const std::string & title_ = "geomutils::regular_grid_placement",
                           const std::string & indent_ = "",
                           bool inherit_ = false) const;

  protected:

    void _load_cache(const std::string & cache_file_path_);

    void _store_cache(const std::string & cache_file_path_);

    void _set_defaults();

    void _init(const datatools::properties & config_);

    void _fini();

  private:

    bool _initialized_ = false; 
    datatools::logger::priority _logging_; 
    const logical_volume * _log_vol_ = nullptr; 
    const logical_volume * _node_log_vol_ = nullptr; 
    uint32_t _overlapping_flags_; 
    std::string _cache_file_path_; 
    double _start_x_; 
    double _start_y_; 
    double _start_z_; 
    double _stop_x_;  
    double _stop_y_;  
    double _stop_z_;  
    double _step_x_;  
    double _step_y_;  
    double _step_z_;  
    size_t    _nsamples_x_;
    size_t    _nsamples_y_;
    size_t    _nsamples_z_;
    placement _basic_placement_;

    struct data;
    boost::scoped_ptr<data> _data_; 

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_REGULAR_3D_MESH_PLACEMENT_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --