model_with_internal_mesh_tools.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 *                Arnaud Chapon <chapon@lpccaen.in2p3.fr>
 * Creation date: 2015-07-06
 * Last modified: 2015-07-06
 *
 * License:
 *
 * Description:
 *
 *   Some tools to make a model owning internal items
 *   positioned on a regular 3D mesh within its mother shape
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_MODEL_WITH_INTERNAL_MESH_TOOLS_H
#define GEOMTOOLS_MODEL_WITH_INTERNAL_MESH_TOOLS_H

// Standard library:
#include <string>
#include <map>

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

// This project:
#include <geomtools/regular_3d_mesh_placement.h>
#include <geomtools/detail/model_tools.h> // for models_col_type
#include <geomtools/physical_volume.h>

namespace geomtools {

  class i_model;

  class model_with_internal_mesh_data : public datatools::i_tree_dumpable
  {
  public:

    static const std::string INTERNAL_MESH_PREFIX;           // "internal_mesh."
    static const std::string INTERNAL_MESH_LABELS_KEY;       // "internal_mesh.labels"
    static const std::string INTERNAL_MESH_MODEL_PREFIX;     // "internal_mesh.model."
    static const std::string INTERNAL_MESH_RANK_PREFIX;      // "internal_mesh.rank."
    static const std::string INTERNAL_MESH_PLACEMENT_PREFIX; // "internal_mesh.placement."

  public:

    struct mesh_type
    {
    public:

      static const int INVALID_RANK = -1;

      mesh_type();

      ~mesh_type();

      void set_mother_logical(logical_volume &);

      bool has_mother_logical() const;

      const logical_volume & get_mother_logical() const;

      logical_volume & grab_mother_logical();

      void set_label(const std::string &);

      const std::string & get_label() const;

       void set_rank(int rank_);

      int get_rank() const;

      void set_model(const i_model &);

      const i_model & get_model() const;

      void set_mesh_placement_config(const datatools::properties &);

      const datatools::properties & get_mesh_placement_config() const;

      void reset_mesh_placement();

      const regular_3d_mesh_placement & get_mesh_placement() const;

      const physical_volume & get_physical_volume() const;

      physical_volume & grab_physical_volume();

      bool is_initialized() const;

      void initialize();

      void reset();

    private:
      // Configuration parameters:
      std::string               _label_;
      logical_volume *          _mother_log_;
      const i_model *           _model_;
      int                       _rank_;
      datatools::properties     _mesh_placement_config_;

      // Internal data:
      regular_3d_mesh_placement * _mesh_placement_;
      physical_volume             _phys_;

    };

    typedef std::map<std::string, mesh_type> mesh_dict_type;

    model_with_internal_mesh_data();

    ~model_with_internal_mesh_data();

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

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

    const mesh_dict_type & get_meshes() const;

    mesh_dict_type & grab_meshes();

    size_t get_number_of_meshes() const;

    bool has_mesh(const std::string &) const;

    const mesh_type & get_mesh(const std::string &) const;

    mesh_type & grab_mesh(const std::string &);

    void add_mesh(const std::string & label_,
                  logical_volume & mother_log_,
                  const i_model & model_,
                  int rank_,
                  const datatools::properties & mesh_placement_config_
                  );

    void initialize();

    void reset();

    void plug_internal_meshes(const datatools::properties & setup_,
                              logical_volume & log_,
                              models_col_type * models_);

    /*
    static void init_ocd(datatools::object_configuration_description & ocd_,
                         const std::string & prefix_ = "");
    */

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

  private:

    datatools::logger::priority _logging_; 
    mesh_dict_type _meshes_; 

  };

  // Type alias:
  // typedef model_with_internal_mesh_data MWIH;

} // end of namespace geomtools

#endif // GEOMTOOLS_MODEL_WITH_INTERNAL_MESH_TOOLS_H

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