faunus
Public Member Functions | List of all members
Faunus::Region::MovingEllipsoid Class Reference

An ellipsoid defined by two (moving) particles. More...

#include <regions.h>

Inheritance diagram for Faunus::Region::MovingEllipsoid:
Inheritance graph
[legend]
Collaboration diagram for Faunus::Region::MovingEllipsoid:
Collaboration graph
[legend]

Public Member Functions

 MovingEllipsoid (const Space &spc, ParticleVector::size_type particle_index1, ParticleVector::size_type particle_index2, double parallel_radius, double perpendicular_radius, bool use_group_mass_center)
 
 MovingEllipsoid (const Space &spc, const json &j)
 
bool isInside (const Point &position) const override
 
void to_json (json &j) const override
 

Detailed Description

An ellipsoid defined by two (moving) particles.

Constructor & Destructor Documentation

◆ MovingEllipsoid()

Faunus::Region::MovingEllipsoid::MovingEllipsoid ( const Space spc,
ParticleVector::size_type  particle_index1,
ParticleVector::size_type  particle_index2,
double  parallel_radius,
double  perpendicular_radius,
bool  use_group_mass_center 
)
Parameters
spcSpace to operate on
particle_index1Index of first particle defining ellipsoid direction
particle_index2Index of second particle defining ellipsoid direction
parallel_radiusEllipsoidal radius along axis connecting reference atoms
perpendicular_radiusEllipsoidal radius perpendicular to axis connecting reference atoms

The reference atoms are used only to define the direction of the ellipsoid and they absolute separation is imimportant. The size of the ellipsoid is defined solely by the two radii, originating from the midpoint between the two reference particles.


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