ParticleProperties::VirtualSitesRelativeParameters Struct Reference

The following properties define, with respect to which real particle a virtual site is placed and at what distance. More...

#include <Particle.hpp>

Collaboration diagram for ParticleProperties::VirtualSitesRelativeParameters:

Public Member Functions
template<class Archive >
void	serialize (Archive &ar, long int)

Public Attributes
int	to_particle_id = -1
double	distance = 0.
Utils::Quaternion< double >	rel_orientation
	Relative position of the virtual site.
Utils::Quaternion< double >	quat = Utils::Quaternion<double>::identity()
	Orientation of the virtual particle in the body fixed frame.

Detailed Description

The following properties define, with respect to which real particle a virtual site is placed and at what distance.

The relative orientation of the vector pointing from real particle to virtual site with respect to the orientation of the real particle is stored in the virtual site's quaternion attribute.

Definition at line 152 of file Particle.hpp.

Member Function Documentation

serialize()

template<class Archive >

void ParticleProperties::VirtualSitesRelativeParameters::serialize ( Archive &  ar, long int    )

inline

Definition at line 161 of file Particle.hpp.

References distance, quat, rel_orientation, and to_particle_id.

Member Data Documentation

distance

double ParticleProperties::VirtualSitesRelativeParameters::distance = 0.

Definition at line 154 of file Particle.hpp.

Referenced by ScriptInterface::Particles::ParticleHandle::ParticleHandle(), and serialize().

quat

Utils::Quaternion<double> ParticleProperties::VirtualSitesRelativeParameters::quat = Utils::Quaternion<double>::identity()

Orientation of the virtual particle in the body fixed frame.

Definition at line 159 of file Particle.hpp.

Referenced by serialize().

rel_orientation

Utils::Quaternion<double> ParticleProperties::VirtualSitesRelativeParameters::rel_orientation

Initial value:

=
        Utils::Quaternion<double>::identity()

Relative position of the virtual site.

Definition at line 156 of file Particle.hpp.

Referenced by serialize().

to_particle_id

int ParticleProperties::VirtualSitesRelativeParameters::to_particle_id = -1

Definition at line 153 of file Particle.hpp.

Referenced by serialize().

---

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

• Particle.hpp