Bayeux  3.4.1
Core Foundation library for SuperNEMO
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
geomtools::model_with_internal_mesh_data Class Reference

Handler to add daughter volumes on a regular 3D mesh in a mother logical volume. More...

#include <bayeux/geomtools/model_with_internal_mesh_tools.h>

Inheritance diagram for geomtools::model_with_internal_mesh_data:
datatools::i_tree_dumpable

Classes

struct  mesh_type
 Mesh record. More...
 

Public Types

typedef std::map< std::string, mesh_typemesh_dict_type
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
 Enumeration for standard output streams. More...
 

Public Member Functions

 model_with_internal_mesh_data ()
 Default constructor. More...
 
 ~model_with_internal_mesh_data ()
 Destructor. More...
 
void set_logging (datatools::logger::priority)
 Set the logging priprity threshold. More...
 
datatools::logger::priority get_logging () const
 Return the logging priprity threshold. More...
 
const mesh_dict_typeget_meshes () const
 Return a const reference to the dictionary of internal meshes. More...
 
mesh_dict_typegrab_meshes ()
 Return a mutable reference to the dictionary of internal meshes. More...
 
size_t get_number_of_meshes () const
 Return the number of meshes. More...
 
bool has_mesh (const std::string &) const
 Check if a mesh exists. More...
 
const mesh_typeget_mesh (const std::string &) const
 Return the mesh by name. More...
 
mesh_typegrab_mesh (const std::string &)
 Return the mesh by name. More...
 
void add_mesh (const std::string &label_, logical_volume &mother_log_, const i_model &model_, int rank_, const datatools::properties &mesh_placement_config_)
 Add a mesh. More...
 
void initialize ()
 Initialization. More...
 
void reset ()
 Reset. More...
 
void plug_internal_meshes (const datatools::properties &setup_, logical_volume &log_, models_col_type *models_)
 Plug internal meshes in a mother logical volume. More...
 
virtual void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 Main old interface method for printing. More...
 
- Public Member Functions inherited from datatools::i_tree_dumpable
 i_tree_dumpable ()
 Constructor. More...
 
virtual ~i_tree_dumpable ()
 Destructor. More...
 
virtual void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
 Main new interface method for printing. More...
 
void print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
 Printing with jsonized options. More...
 
void print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
 Printing with jsonized options. More...
 
void tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const
 
void tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const
 
void smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const
 

Static Public Attributes

static const std::string INTERNAL_MESH_PREFIX
 
static const std::string INTERNAL_MESH_LABELS_KEY
 
static const std::string INTERNAL_MESH_MODEL_PREFIX
 
static const std::string INTERNAL_MESH_RANK_PREFIX
 
static const std::string INTERNAL_MESH_PLACEMENT_PREFIX
 

Additional Inherited Members

- Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree & empty_options ()
 
static boost::property_tree::ptree make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)
 
static std::ostream & last_skip_tag (std::ostream &out_)
 
static std::ostream & skip_tag (std::ostream &out_)
 
static std::ostream & last_tag (std::ostream &out_)
 
static std::ostream & tag (std::ostream &out_)
 

Detailed Description

Handler to add daughter volumes on a regular 3D mesh in a mother logical volume.

Member Typedef Documentation

◆ mesh_dict_type

Constructor & Destructor Documentation

◆ model_with_internal_mesh_data()

geomtools::model_with_internal_mesh_data::model_with_internal_mesh_data ( )

Default constructor.

◆ ~model_with_internal_mesh_data()

geomtools::model_with_internal_mesh_data::~model_with_internal_mesh_data ( )

Destructor.

Member Function Documentation

◆ add_mesh()

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

Add a mesh.

◆ get_logging()

datatools::logger::priority geomtools::model_with_internal_mesh_data::get_logging ( ) const

Return the logging priprity threshold.

◆ get_mesh()

const mesh_type& geomtools::model_with_internal_mesh_data::get_mesh ( const std::string &  ) const

Return the mesh by name.

◆ get_meshes()

const mesh_dict_type& geomtools::model_with_internal_mesh_data::get_meshes ( ) const

Return a const reference to the dictionary of internal meshes.

◆ get_number_of_meshes()

size_t geomtools::model_with_internal_mesh_data::get_number_of_meshes ( ) const

Return the number of meshes.

◆ grab_mesh()

mesh_type& geomtools::model_with_internal_mesh_data::grab_mesh ( const std::string &  )

Return the mesh by name.

◆ grab_meshes()

mesh_dict_type& geomtools::model_with_internal_mesh_data::grab_meshes ( )

Return a mutable reference to the dictionary of internal meshes.

◆ has_mesh()

bool geomtools::model_with_internal_mesh_data::has_mesh ( const std::string &  ) const

Check if a mesh exists.

◆ initialize()

void geomtools::model_with_internal_mesh_data::initialize ( )

Initialization.

◆ plug_internal_meshes()

void geomtools::model_with_internal_mesh_data::plug_internal_meshes ( const datatools::properties setup_,
logical_volume log_,
models_col_type models_ 
)

Plug internal meshes in a mother logical volume.

◆ reset()

void geomtools::model_with_internal_mesh_data::reset ( )

Reset.

◆ set_logging()

void geomtools::model_with_internal_mesh_data::set_logging ( datatools::logger::priority  )

Set the logging priprity threshold.

◆ tree_dump()

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

Main old interface method for printing.

Reimplemented from datatools::i_tree_dumpable.

Member Data Documentation

◆ INTERNAL_MESH_LABELS_KEY

const std::string geomtools::model_with_internal_mesh_data::INTERNAL_MESH_LABELS_KEY
static

◆ INTERNAL_MESH_MODEL_PREFIX

const std::string geomtools::model_with_internal_mesh_data::INTERNAL_MESH_MODEL_PREFIX
static

◆ INTERNAL_MESH_PLACEMENT_PREFIX

const std::string geomtools::model_with_internal_mesh_data::INTERNAL_MESH_PLACEMENT_PREFIX
static

◆ INTERNAL_MESH_PREFIX

const std::string geomtools::model_with_internal_mesh_data::INTERNAL_MESH_PREFIX
static

◆ INTERNAL_MESH_RANK_PREFIX

const std::string geomtools::model_with_internal_mesh_data::INTERNAL_MESH_RANK_PREFIX
static

The documentation for this class was generated from the following file: