Module computing the rigid motion between domains and comparing the rotations of the rigid motions.
More...
#include <Correlated_motions_by_domain_module.hpp>
|
void | run (unsigned verbose, std::ostream &out) |
| Runs the module following the input options. More...
|
|
bool | is_runnable (void) const |
| Checks that all the input options were set. More...
|
|
void | statistics (std::ostream &out) |
| Reports high-level statistics on the module. More...
|
|
Self * | clone (void) const |
| Clones the object using the copy constructor. More...
|
|
std::string | get_name (void) const |
| Returns the name of the package. More...
|
|
|
boost::program_options::options_description | add_options (void) const |
| Virtual method for adding options to the module. More...
|
|
bool | check_options (std::string &message) const |
| Checks that the input options' values are coherent. More...
|
|
std::string | get_output_prefix (void) const |
| Returns a prefix that concatains the input line options used when running the module. More...
|
|
void | report (const std::string &prefix) |
| Reports the output and statistics in output files. More...
|
|
|
void | set_module_instance_name (const std::string &module_instance_name) |
| Sets a name for this instance of this module. In particular, it will be used in the prefix of output files generated by a collection of modules. More...
|
|
const std::string & | get_module_instance_name (void) const |
| Get the name of this instance of this module. More...
|
|
void | set_report_mode (std::ios_base::openmode report_mode) |
| Set a report mode, that is open or append modes. More...
|
|
void | set_report_mode (std::ios_base::openmode &report_mode) |
| Set a report mode, that is open or append modes. More...
|
|
const std::ios_base::openmode | get_report_mode (void) const |
| Get the report mode to be used when reporting. More...
|
|
|
template<class Self_ > |
Self_ * | clone (const Self_ *s) const |
| Clones the object using the copy constructor. More...
|
|
virtual bool | is_logical_module (void) const |
| Checks that this module defines a logical operator. More...
|
|
virtual bool | is_condition_module (void) const |
| Checks that this module defines a condition operator. More...
|
|
virtual bool | operator() (void) |
| Only for condition modules, for returning the predicate value. More...
|
|
virtual bool | is_modules_collection (void) const |
| Checks that this module defines a collection of modules. More...
|
|
template<class ModuleTraits>
class T_Correlated_motions_by_domain_module< ModuleTraits >
Module computing the rigid motion between domains and comparing the rotations of the rigid motions.
Module computing the rigid motion between domains and comparing the rotations of the rigid motions.
- Template Parameters
-
◆ Base
◆ Get_label_identifier
Functor returning the identifier of the primitive label of a particle.
It takes as argument a particle, and return the identifier of its primitive label. The type of the identifier is named result_type and has to be a concatenable type (e.g a string).
◆ Label_traits
Traits class defining system's labels attached to particles.
◆ Particle_traits
Traits class for particles.
◆ Particles_container
Container for the input particles (atoms or pseudo-atoms).
See ParticleTraits for more details.
◆ Self
◆ add_options()
boost::program_options::options_description add_options |
( |
void |
| ) |
const |
|
inlinevirtual |
◆ check_options()
bool check_options |
( |
std::string & |
message | ) |
const |
|
inlinevirtual |
◆ clone() [1/2]
Self_* clone |
( |
const Self_ * |
s | ) |
const |
|
inlineinherited |
Clones the object using the copy constructor.
◆ clone() [2/2]
Clones the object using the copy constructor.
◆ delete_options()
static void delete_options |
( |
void |
| ) |
|
|
inlinestaticinherited |
◆ get_first_particles()
Reference to the first container of particles.
◆ get_label_identifier()
Reference to the functor labeling the particles in the first container.
◆ get_module_instance_name()
const std::string& get_module_instance_name |
( |
void |
| ) |
const |
|
inlineinherited |
Get the name of this instance of this module.
◆ get_name()
std::string get_name |
( |
void |
| ) |
const |
|
inlinevirtual |
Returns the name of the package.
Reimplemented from Module_base.
◆ get_options()
static boost::program_options::options_description*& get_options |
( |
void |
| ) |
|
|
inlinestaticinherited |
Access to the options' description of the module.
◆ get_output_prefix()
std::string get_output_prefix |
( |
void |
| ) |
const |
|
inlinevirtual |
◆ get_report_mode()
const std::ios_base::openmode get_report_mode |
( |
void |
| ) |
const |
|
inlineinherited |
Get the report mode to be used when reporting.
◆ get_second_particles()
Reference to the second container of particles.
◆ has_options()
static bool has_options |
( |
void |
| ) |
|
|
inlinestaticinherited |
◆ initialize_options()
static void initialize_options |
( |
const std::string & |
caption | ) |
|
|
inlinestaticinherited |
◆ is_condition_module()
virtual bool is_condition_module |
( |
void |
| ) |
const |
|
inlineprotectedvirtualinherited |
Checks that this module defines a condition operator.
◆ is_logical_module()
virtual bool is_logical_module |
( |
void |
| ) |
const |
|
inlineprotectedvirtualinherited |
Checks that this module defines a logical operator.
◆ is_modules_collection()
virtual bool is_modules_collection |
( |
void |
| ) |
const |
|
inlineprotectedvirtualinherited |
Checks that this module defines a collection of modules.
◆ is_runnable()
bool is_runnable |
( |
void |
| ) |
const |
|
inlinevirtual |
Checks that all the input options were set.
Reimplemented from Module_base.
◆ operator()()
virtual bool operator() |
( |
void |
| ) |
|
|
inlineprotectedvirtualinherited |
Only for condition modules, for returning the predicate value.
◆ report()
void report |
( |
const std::string & |
prefix | ) |
|
|
inlinevirtual |
Reports the output and statistics in output files.
Reimplemented from Module_base.
◆ run()
void run |
( |
unsigned |
verbose, |
|
|
std::ostream & |
out |
|
) |
| |
|
inlinevirtual |
Runs the module following the input options.
Implements Module_base.
◆ set_module_instance_name()
void set_module_instance_name |
( |
const std::string & |
module_instance_name | ) |
|
|
inlineinherited |
Sets a name for this instance of this module. In particular, it will be used in the prefix of output files generated by a collection of modules.
◆ set_report_mode() [1/2]
void set_report_mode |
( |
std::ios_base::openmode & |
report_mode | ) |
|
|
inlineinherited |
Set a report mode, that is open or append modes.
◆ set_report_mode() [2/2]
void set_report_mode |
( |
std::ios_base::openmode |
report_mode | ) |
|
|
inlineinherited |
Set a report mode, that is open or append modes.
◆ statistics()
void statistics |
( |
std::ostream & |
out | ) |
|
|
inlinevirtual |
Reports high-level statistics on the module.
Reimplemented from Module_base.