File: vtkPANLSubhaloFinder.h

package info (click to toggle)
paraview 5.1.2%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 221,108 kB
  • ctags: 236,092
  • sloc: cpp: 2,416,026; ansic: 190,891; python: 99,856; xml: 81,001; tcl: 46,915; yacc: 5,039; java: 4,413; perl: 3,108; sh: 1,974; lex: 1,926; f90: 748; asm: 471; pascal: 228; makefile: 198; objc: 83; fortran: 31
file content (195 lines) | stat: -rw-r--r-- 6,943 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/*=========================================================================

 Program:   Visualization Toolkit
 Module:    vtkPANLSubhaloFinder.h

 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 All rights reserved.
 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

 This software is distributed WITHOUT ANY WARRANTY; without even
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notice for more information.

 =========================================================================*/
#ifndef vtkPANLSubhaloFinder_h
#define vtkPANLSubhaloFinder_h

// .NAME vtkPANLSubhaloFinder -- finds subhalos of requested halos
//
// .SECTION Description
// This filter takes the output of the HACC halo finder and runs the subhalo
// finder on a user-specified list of halos.
//
// The input should be a vtkUnstructuredGrid with the data arrays vx, vy, vz,
// id and fof_halo_tag.  AddHaloToProcess should be used to select which halos
// to find subhalos of.
//
// The first output is a vtkUnstructuredGrid similar to the input but with the
// data array subhalo_tag appended to indicate which subhalo a point lies in.
// The value will be -1 for points in no halo.
//
// The second output is a vtkUnstructuredGrid with one point per subhalo and
// data arrays for summary information such as average velocity, mass, and
// center of mass.

#include "vtkPVVTKExtensionsCosmoToolsModule.h" // for export macro
#include "vtkPassInputTypeAlgorithm.h"
#include "vtkNew.h" // for vtkNew

class vtkMultiProcessController;
class vtkIdList;

class VTKPVVTKEXTENSIONSCOSMOTOOLS_EXPORT vtkPANLSubhaloFinder : public vtkPassInputTypeAlgorithm
{
  vtkTypeMacro(vtkPANLSubhaloFinder, vtkPassInputTypeAlgorithm)
public:
  static vtkPANLSubhaloFinder* New();
  void PrintSelf(ostream &os, vtkIndent indent);

  enum {
    ALL_HALOS = 0,
    HALOS_LARGER_THAN_THRESHOLD = 1,
    ONLY_SELECTED_HALOS = 2
  };


  // Description:
  // Sets/Gets the mode of the subhalo finding filter.  It should be one of the values
  // ALL_HALOS - find subhalos of all halos (default)
  // HALOS_LARGER_THAN_THRESHOLD - finds subhalos of all halos with more than
  //                               SizeThreshold values (sizeThreshold is a settable
  //                               parameter)
  // ONLY_SELECTED_HALOS - finds subhalos of only the halos in the HalosToProcess list
  vtkSetClampMacro(Mode,int,ALL_HALOS,ONLY_SELECTED_HALOS)
  vtkGetMacro(Mode,int)

  // Description:
  // Sets/Gets the size threshold which is the minimum number of particles in the halos
  // that will have the subhalo finder run on them in HALOS_LARGER_THAN_THRESHOLD mode.
  // Defaults to 1000.
  vtkSetMacro(SizeThreshold,vtkIdType)
  vtkGetMacro(SizeThreshold,vtkIdType)

  // Description:
  // Gets the halo to process at the given index
  // This list is used when the filter is in ONLY_SELECTED_HALOS mode
  vtkIdType GetHaloToProcess(vtkIdType idx);
  // Description:
  // Adds a halo to the list of halos that will have the subhalo finder run on them
  // This list is used when the filter is in ONLY_SELECTED_HALOS mode
  void AddHaloToProcess(vtkIdType haloId);
  // Description:
  // Sets the halo id to process at the given index in the list
  // This list is used when the filter is in ONLY_SELECTED_HALOS mode
  void SetHaloToProcess(vtkIdType idx, vtkIdType haloId);
  // Description:
  // Sets the number of halos to process
  // This list is used when the filter is in ONLY_SELECTED_HALOS mode
  void SetNumberOfHalosToProcess(vtkIdType num);
  // Description:
  // Gets the number of halos to process
  // This list is used when the filter is in ONLY_SELECTED_HALOS mode
  vtkIdType GetNumberOfHalosToProcess();
  // Description:
  // Clears the list of halos that will have the subhalo finder run on them
  // This list is used when the filter is in ONLY_SELECTED_HALOS mode
  void ClearHalosToProcess();

  // Description:
  // Gets/Sets RL, the physical coordinate box size
  // Default: 256.0
  vtkSetMacro(RL,double)
  vtkGetMacro(RL,double)

  // Description:
  // Gets/Sets the size of the ghost particle region around each process's particles
  // to exchange when creating ghost particles.
  // Default: 8.0
  vtkSetMacro(DeadSize,double)
  vtkGetMacro(DeadSize,double)

  // Description:
  // Gets/Sets the particle mass.  For input datasets that do not have mass information
  // the mass of each particle defaults to this value.
  // Default: 1.307087181e+09
  vtkSetMacro(ParticleMass,float)
  vtkGetMacro(ParticleMass,float)

  // Description:
  // Gets/Sets distance threshold for particles to be considered in the same
  // halo.  This is measured in grid units on a NP x NP x NP grid.
  // Default: 0.1679999998
  vtkSetMacro(BB,double)
  vtkGetMacro(BB,double)

  // Description:
  // Gets/Sets alpha factor.  This controls how aggressively small subhalos
  // are grown.  Alpha factor of 1.0 is the least aggressive
  // Default: 1.0
  vtkSetClampMacro(AlphaFactor,double,0.0,1.0)
  vtkGetMacro(AlphaFactor,double)

  // Description:
  // Gets/Sets beta factor.  This controlls how saddle points between
  // subhalos are treated.  Larger values allow identification of smaller
  // scale structures such as tails.
  // Default: 0.0
  vtkSetClampMacro(BetaFactor,double,0.0,1.0)
  vtkGetMacro(BetaFactor,double)

  // Description:
  // Gets/Sets the minimum size of a subhalo candidate
  // Default: 200
  vtkSetMacro(MinCandidateSize,int)
  vtkGetMacro(MinCandidateSize,int)

  // Description:
  // Gets/Sets NumSPHNeighbors
  // Default: 64
  vtkSetMacro(NumSPHNeighbors,int)
  vtkGetMacro(NumSPHNeighbors,int)

  // Description:
  // Gets/Sets the number of neighbors that are examined by the subhalo finder
  // to determine local clumps near the each particle
  // Default: 20
  vtkSetMacro(NumNeighbors,int)
  vtkGetMacro(NumNeighbors,int)

protected:
  vtkPANLSubhaloFinder();
  virtual ~vtkPANLSubhaloFinder();

  int FillInputPortInformation(int port, vtkInformation *info);
  virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
  virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);

  double RL;
  double DeadSize;
  double BB;
  double ParticleMass;
  double AlphaFactor;
  double BetaFactor;
  int MinCandidateSize;
  int NumSPHNeighbors;
  int NumNeighbors;

  int Mode;
  vtkIdType SizeThreshold;

  vtkNew< vtkIdList > HalosToProcess;
  vtkMultiProcessController* Controller;

  class vtkInternals;
  vtkInternals* Internal;
private:
  vtkPANLSubhaloFinder(const vtkPANLSubhaloFinder&); // Not implemented
  void operator=(const vtkPANLSubhaloFinder&); // Not implemented

  void ExecuteSubHaloFinder(vtkUnstructuredGrid* input,
                            vtkUnstructuredGrid* allParticles,
                            vtkUnstructuredGrid* subFofProperties);
};

#endif