faunus
Public Member Functions | Public Attributes | List of all members
Faunus::Geometry::ShapeDescriptors Struct Reference

Shape descriptors derived from gyration tensor. More...

#include <geometry.h>

Public Member Functions

 ShapeDescriptors (const Tensor &gyration_tensor)
 Construct using an initial gyration tensor.
 
ShapeDescriptorsoperator+= (const ShapeDescriptors &other)
 Add another gyration tensor; req. for averaging.
 
ShapeDescriptors operator* (const double scale) const
 Scale data; req. for averaging.
 

Public Attributes

double gyration_radius_squared = 0.0
 
double asphericity = 0.0
 
double acylindricity = 0.0
 
double relative_shape_anisotropy
 relative shape anisotropy, kappa^2 (0=rod, 1=spherical) More...
 

Detailed Description

Shape descriptors derived from gyration tensor.

The class is prepared with operator overloads to work with AverageObj for averaging over multiple tensors

Member Data Documentation

◆ relative_shape_anisotropy

double Faunus::Geometry::ShapeDescriptors::relative_shape_anisotropy
Initial value:
=
0.0

relative shape anisotropy, kappa^2 (0=rod, 1=spherical)


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