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

Spherical region centered on a particle. More...

#include <regions.h>

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

Public Member Functions

 SphereAroundParticle (const Space &spc, ParticleVector::size_type index, double radius)
 
 SphereAroundParticle (const Space &spc, const json &j)
 
bool isInside (const Point &position) const override
 
std::optional< double > volume () const override
 
void to_json (json &j) const override
 

Detailed Description

Spherical region centered on a particle.

Constructor & Destructor Documentation

◆ SphereAroundParticle()

Faunus::Region::SphereAroundParticle::SphereAroundParticle ( const Space spc,
ParticleVector::size_type  index,
double  radius 
)
Parameters
spcSpace to operate on
indexParticle index used to define center of region
radiusRadius of spherical region

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