siscone is hosted by Hepforge, IPPP Durham

The SISCone Jet Algorithm

Version 3.0.6



SISCone 3.0.6

list of element in the vicinity of a parent. More...

#include <vicinity.h>

Inheritance diagram for siscone_spherical::CSphvicinity:
Collaboration diagram for siscone_spherical::CSphvicinity:

Public Member Functions

 CSphvicinity ()
 default constructor More...
 
 CSphvicinity (std::vector< CSphmomentum > &_particle_list)
 constructor with initialisation (see set_particle_list)
 
 ~CSphvicinity ()
 default destructor More...
 
void set_particle_list (std::vector< CSphmomentum > &_particle_list)
 set the particle_list More...
 
void build (CSphmomentum *_parent, double _VR)
 build the vicinity list from the list of points. More...
 

Public Attributes

CSphmomentumparent
 parent vector More...
 
double VR
 radius of the vicinity More...
 
double VR2
 squared radius of the vicinity More...
 
double cosVR
 cosine of the radius of the vicinity More...
 
double R
 normal radius More...
 
double R2
 squared normal radius More...
 
double tan2R
 squared tangent of the normal radius More...
 
double D2_R
 euclidian distance (squared) corresp. to the arc R More...
 
double inv_R_EPS_COCIRC
 R / EPSILON_COCIRCULAR. More...
 
double inv_R_2EPS_COCIRC
 R / (2*EPSILON_COCIRCULAR) More...
 
int n_part
 number of particles More...
 
std::vector< CSphmomentumplist
 the list of particles More...
 
std::vector< siscone::Cvicinity_inclusionpincluded
 the inclusion state of particles More...
 
CSphvicinity_elmve_list
 list of vicinity elements built from particle list (size=2*n) More...
 
std::vector< CSphvicinity_elm * > vicinity
 list of points in parent's vicinity More...
 
unsigned int vicinity_size
 number of elements in vicinity More...
 

Protected Member Functions

void append_to_vicinity (CSphmomentum *v)
 append a particle to the 'vicinity' list after having tested it and computed the angular-ordering quantities More...
 

Protected Attributes

CSph3vector parent_centre
 parent centre More...
 
CSph3vector angular_dir1
 main direction to measure angles More...
 
CSph3vector angular_dir2
 second direction to measure angles (sign) More...
 

Detailed Description

list of element in the vicinity of a parent.

class used to manage the points which are in the vicinity of a parent point.

Definition at line 83 of file vicinity.h.

Constructor & Destructor Documentation

◆ CSphvicinity()

siscone_spherical::CSphvicinity::CSphvicinity ( )

default constructor

Definition at line 62 of file vicinity.cpp.

References n_part, parent, ve_list, VR, and VR2.

◆ ~CSphvicinity()

siscone_spherical::CSphvicinity::~CSphvicinity ( )

default destructor

Definition at line 90 of file vicinity.cpp.

References ve_list.

Member Function Documentation

◆ append_to_vicinity()

◆ build()

void siscone_spherical::CSphvicinity::build ( CSphmomentum _parent,
double  _VR 
)

◆ set_particle_list()

void siscone_spherical::CSphvicinity::set_particle_list ( std::vector< CSphmomentum > &  _particle_list)

set the particle_list

Parameters
_particle_listlist of particles (type CSphmomentum)

Definition at line 105 of file vicinity.cpp.

References siscone_spherical::CSphvicinity_elm::is_inside, n_part, pincluded, plist, siscone_spherical::CSphvicinity_elm::v, ve_list, and vicinity.

Referenced by siscone_spherical::CSphstable_cones::init().

Member Data Documentation

◆ angular_dir1

CSph3vector siscone_spherical::CSphvicinity::angular_dir1
protected

main direction to measure angles

Definition at line 143 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ angular_dir2

CSph3vector siscone_spherical::CSphvicinity::angular_dir2
protected

second direction to measure angles (sign)

Definition at line 144 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ cosVR

double siscone_spherical::CSphvicinity::cosVR

cosine of the radius of the vicinity

Definition at line 111 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ D2_R

double siscone_spherical::CSphvicinity::D2_R

euclidian distance (squared) corresp. to the arc R

Definition at line 115 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ inv_R_2EPS_COCIRC

double siscone_spherical::CSphvicinity::inv_R_2EPS_COCIRC

R / (2*EPSILON_COCIRCULAR)

Definition at line 117 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ inv_R_EPS_COCIRC

double siscone_spherical::CSphvicinity::inv_R_EPS_COCIRC

R / EPSILON_COCIRCULAR.

Definition at line 116 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ n_part

int siscone_spherical::CSphvicinity::n_part

number of particles

Definition at line 120 of file vicinity.h.

Referenced by build(), CSphvicinity(), siscone_spherical::CSphstable_cones::get_stable_cones(), and set_particle_list().

◆ parent

CSphmomentum* siscone_spherical::CSphvicinity::parent

◆ parent_centre

CSph3vector siscone_spherical::CSphvicinity::parent_centre
protected

parent centre

Definition at line 142 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ pincluded

std::vector<siscone::Cvicinity_inclusion> siscone_spherical::CSphvicinity::pincluded

the inclusion state of particles

Definition at line 123 of file vicinity.h.

Referenced by set_particle_list().

◆ plist

std::vector<CSphmomentum> siscone_spherical::CSphvicinity::plist

the list of particles

Definition at line 121 of file vicinity.h.

Referenced by build(), siscone_spherical::CSphstable_cones::get_stable_cones(), and set_particle_list().

◆ R

double siscone_spherical::CSphvicinity::R

normal radius

Definition at line 112 of file vicinity.h.

Referenced by build().

◆ R2

double siscone_spherical::CSphvicinity::R2

squared normal radius

Definition at line 113 of file vicinity.h.

Referenced by build().

◆ tan2R

double siscone_spherical::CSphvicinity::tan2R

squared tangent of the normal radius

Definition at line 114 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ ve_list

CSphvicinity_elm* siscone_spherical::CSphvicinity::ve_list

list of vicinity elements built from particle list (size=2*n)

Definition at line 124 of file vicinity.h.

Referenced by append_to_vicinity(), CSphvicinity(), set_particle_list(), and ~CSphvicinity().

◆ vicinity

std::vector<CSphvicinity_elm*> siscone_spherical::CSphvicinity::vicinity

list of points in parent's vicinity

Definition at line 130 of file vicinity.h.

Referenced by append_to_vicinity(), build(), and set_particle_list().

◆ vicinity_size

unsigned int siscone_spherical::CSphvicinity::vicinity_size

number of elements in vicinity

Definition at line 131 of file vicinity.h.

Referenced by build(), and siscone_spherical::CSphstable_cones::get_stable_cones().

◆ VR

double siscone_spherical::CSphvicinity::VR

radius of the vicinity

Definition at line 109 of file vicinity.h.

Referenced by build(), and CSphvicinity().

◆ VR2

double siscone_spherical::CSphvicinity::VR2

squared radius of the vicinity

Definition at line 110 of file vicinity.h.

Referenced by build(), and CSphvicinity().


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

The SISCone project has been developed by Gavin Salam and Gregory Soyez
Documentation generated on Tue Jun 20 2023 18:08:37 for SISCone by  Doxygen 1.9.4