ppap4lmp  0.7.2
AddMolecularOrientation Class Reference

AddMolecularOrientation adds molecular orientation (order parameter) to an Element object. More...

#include <add_molecular_orientation.h>

Inheritance diagram for AddMolecularOrientation:
Collaboration diagram for AddMolecularOrientation:

Protected Member Functions

virtual void compute_impl (Json &data, JsonToVoidFunc check_required_keys, JsonToBoolFunc check_optional_keys) override
 This method overrides Updater::compute_impl. More...
 
- Protected Member Functions inherited from Adder
virtual void compute_body (const ElPtr &elem, Json &data) override
 Compute properties and add them to Element::data given as a mutable reference. More...
 
- Protected Member Functions inherited from Updater
virtual void compute_common (const ElPtr &elem, Json &data)
 Common part of compute_body. More...
 

Additional Inherited Members

- Public Member Functions inherited from Adder
 Updater ()=default
 Constructor of Updater class. More...
 
- Public Member Functions inherited from Updater
 Updater ()=default
 Constructor of Updater class. More...
 
void compute (const ElPtr &elem, const int elementid, Json &data)
 Managing computation to update Element::data. More...
 
void remove_from_skippable_elementids (const int elementid)
 Remove Element::elementid from skippable_elementids. More...
 
const ShPtr< Generator > & get_ext_generator ()
 Get ext_generator of this object. More...
 
- Protected Attributes inherited from Updater
ShPtr< Generatorext_generator
 

Detailed Description

AddMolecularOrientation adds molecular orientation (order parameter) to an Element object.

This class computes orientation (a.k.a. order parameter) of an Element object (such as one containing data for molecules) from its inertia moment. To compute the orientation, a direction of eigenvector corresponding the minimum eigenvalue of the inertia moment (that is, long axis of the molecule) is used for each molecule.

About usage in Python, please see pybind::py_add_molecular_orientation.

Definition at line 28 of file add_molecular_orientation.h.

Member Function Documentation

◆ compute_impl()

void AddMolecularOrientation::compute_impl ( Json data,
JsonToVoidFunc  check_required_keys,
JsonToBoolFunc  check_optional_keys 
)
overrideprotectedvirtual

This method overrides Updater::compute_impl.

Property to be added
  • I_values : array of floats (eigenvalues of inertia moment)
  • I_vectors : array of arrays of floats (eigenvectors of inertia moment)
  • S_x : float
  • S_y : float
  • S_z : float
Required property
  • I_xx : float
  • I_yy : float
  • I_zz : float
  • I_xy : float
  • I_xz : float
  • I_yz : float

Implements Updater.

Definition at line 15 of file add_molecular_orientation.cpp.


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