ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPANLSubhaloFinder Class Reference

This filter takes the output of the HACC halo finder and runs the subhalo finder on a user-specified list of halos. More...

#include <vtkPANLSubhaloFinder.h>

Inherits vtkPassInputTypeAlgorithm.

Public Types

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

Public Member Functions

void PrintSelf (ostream &os, vtkIndent indent)
 
vtkIdType GetHaloToProcess (vtkIdType idx)
 Gets the halo to process at the given index This list is used when the filter is in ONLY_SELECTED_HALOS mode. More...
 
void AddHaloToProcess (vtkIdType haloId)
 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. More...
 
void SetHaloToProcess (vtkIdType idx, vtkIdType haloId)
 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. More...
 
void SetNumberOfHalosToProcess (vtkIdType num)
 Sets the number of halos to process This list is used when the filter is in ONLY_SELECTED_HALOS mode. More...
 
vtkIdType GetNumberOfHalosToProcess ()
 Gets the number of halos to process This list is used when the filter is in ONLY_SELECTED_HALOS mode. More...
 
void ClearHalosToProcess ()
 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. More...
 
virtual void SetMode (int)
 Sets/Gets the mode of the subhalo finding filter. More...
 
virtual int GetMode ()
 Sets/Gets the mode of the subhalo finding filter. More...
 
virtual void SetSizeThreshold (vtkIdType)
 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. More...
 
virtual vtkIdType GetSizeThreshold ()
 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. More...
 
virtual void SetRL (double)
 Gets/Sets RL, the physical coordinate box size Default: 256.0. More...
 
virtual double GetRL ()
 Gets/Sets RL, the physical coordinate box size Default: 256.0. More...
 
virtual void SetDeadSize (double)
 Gets/Sets the size of the ghost particle region around each process's particles to exchange when creating ghost particles. More...
 
virtual double GetDeadSize ()
 Gets/Sets the size of the ghost particle region around each process's particles to exchange when creating ghost particles. More...
 
virtual void SetParticleMass (float)
 Gets/Sets the particle mass. More...
 
virtual float GetParticleMass ()
 Gets/Sets the particle mass. More...
 
virtual void SetBB (double)
 Gets/Sets distance threshold for particles to be considered in the same halo. More...
 
virtual double GetBB ()
 Gets/Sets distance threshold for particles to be considered in the same halo. More...
 
virtual void SetAlphaFactor (double)
 Gets/Sets alpha factor. More...
 
virtual double GetAlphaFactor ()
 Gets/Sets alpha factor. More...
 
virtual void SetBetaFactor (double)
 Gets/Sets beta factor. More...
 
virtual double GetBetaFactor ()
 Gets/Sets beta factor. More...
 
virtual void SetMinCandidateSize (int)
 Gets/Sets the minimum size of a subhalo candidate Default: 200. More...
 
virtual int GetMinCandidateSize ()
 Gets/Sets the minimum size of a subhalo candidate Default: 200. More...
 
virtual void SetNumSPHNeighbors (int)
 Gets/Sets NumSPHNeighbors Default: 64. More...
 
virtual int GetNumSPHNeighbors ()
 Gets/Sets NumSPHNeighbors Default: 64. More...
 
virtual void SetNumNeighbors (int)
 Gets/Sets the number of neighbors that are examined by the subhalo finder to determine local clumps near the each particle Default: 20. More...
 
virtual int GetNumNeighbors ()
 Gets/Sets the number of neighbors that are examined by the subhalo finder to determine local clumps near the each particle Default: 20. More...
 

Static Public Member Functions

static vtkPANLSubhaloFinderNew ()
 

Protected Member Functions

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

Protected Attributes

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
 
vtkInternals * Internal
 

Detailed 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.

Definition at line 45 of file vtkPANLSubhaloFinder.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
ALL_HALOS 
HALOS_LARGER_THAN_THRESHOLD 
ONLY_SELECTED_HALOS 

Definition at line 51 of file vtkPANLSubhaloFinder.h.

Constructor & Destructor Documentation

◆ vtkPANLSubhaloFinder()

vtkPANLSubhaloFinder::vtkPANLSubhaloFinder ( )
protected

◆ ~vtkPANLSubhaloFinder()

virtual vtkPANLSubhaloFinder::~vtkPANLSubhaloFinder ( )
protectedvirtual

Member Function Documentation

◆ New()

static vtkPANLSubhaloFinder* vtkPANLSubhaloFinder::New ( )
static

◆ PrintSelf()

void vtkPANLSubhaloFinder::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ SetMode()

virtual void vtkPANLSubhaloFinder::SetMode ( int  )
virtual

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

◆ GetMode()

virtual int vtkPANLSubhaloFinder::GetMode ( )
virtual

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

◆ SetSizeThreshold()

virtual void vtkPANLSubhaloFinder::SetSizeThreshold ( vtkIdType  )
virtual

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.

◆ GetSizeThreshold()

virtual vtkIdType vtkPANLSubhaloFinder::GetSizeThreshold ( )
virtual

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.

◆ GetHaloToProcess()

vtkIdType vtkPANLSubhaloFinder::GetHaloToProcess ( vtkIdType  idx)

Gets the halo to process at the given index This list is used when the filter is in ONLY_SELECTED_HALOS mode.

◆ AddHaloToProcess()

void vtkPANLSubhaloFinder::AddHaloToProcess ( vtkIdType  haloId)

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.

◆ SetHaloToProcess()

void vtkPANLSubhaloFinder::SetHaloToProcess ( vtkIdType  idx,
vtkIdType  haloId 
)

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.

◆ SetNumberOfHalosToProcess()

void vtkPANLSubhaloFinder::SetNumberOfHalosToProcess ( vtkIdType  num)

Sets the number of halos to process This list is used when the filter is in ONLY_SELECTED_HALOS mode.

◆ GetNumberOfHalosToProcess()

vtkIdType vtkPANLSubhaloFinder::GetNumberOfHalosToProcess ( )

Gets the number of halos to process This list is used when the filter is in ONLY_SELECTED_HALOS mode.

◆ ClearHalosToProcess()

void vtkPANLSubhaloFinder::ClearHalosToProcess ( )

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.

◆ SetRL()

virtual void vtkPANLSubhaloFinder::SetRL ( double  )
virtual

Gets/Sets RL, the physical coordinate box size Default: 256.0.

◆ GetRL()

virtual double vtkPANLSubhaloFinder::GetRL ( )
virtual

Gets/Sets RL, the physical coordinate box size Default: 256.0.

◆ SetDeadSize()

virtual void vtkPANLSubhaloFinder::SetDeadSize ( double  )
virtual

Gets/Sets the size of the ghost particle region around each process's particles to exchange when creating ghost particles.

Default: 8.0

◆ GetDeadSize()

virtual double vtkPANLSubhaloFinder::GetDeadSize ( )
virtual

Gets/Sets the size of the ghost particle region around each process's particles to exchange when creating ghost particles.

Default: 8.0

◆ SetParticleMass()

virtual void vtkPANLSubhaloFinder::SetParticleMass ( float  )
virtual

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

◆ GetParticleMass()

virtual float vtkPANLSubhaloFinder::GetParticleMass ( )
virtual

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

◆ SetBB()

virtual void vtkPANLSubhaloFinder::SetBB ( double  )
virtual

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

◆ GetBB()

virtual double vtkPANLSubhaloFinder::GetBB ( )
virtual

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

◆ SetAlphaFactor()

virtual void vtkPANLSubhaloFinder::SetAlphaFactor ( double  )
virtual

Gets/Sets alpha factor.

This controls how aggressively small subhalos are grown. Alpha factor of 1.0 is the least aggressive Default: 1.0

◆ GetAlphaFactor()

virtual double vtkPANLSubhaloFinder::GetAlphaFactor ( )
virtual

Gets/Sets alpha factor.

This controls how aggressively small subhalos are grown. Alpha factor of 1.0 is the least aggressive Default: 1.0

◆ SetBetaFactor()

virtual void vtkPANLSubhaloFinder::SetBetaFactor ( double  )
virtual

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

◆ GetBetaFactor()

virtual double vtkPANLSubhaloFinder::GetBetaFactor ( )
virtual

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

◆ SetMinCandidateSize()

virtual void vtkPANLSubhaloFinder::SetMinCandidateSize ( int  )
virtual

Gets/Sets the minimum size of a subhalo candidate Default: 200.

◆ GetMinCandidateSize()

virtual int vtkPANLSubhaloFinder::GetMinCandidateSize ( )
virtual

Gets/Sets the minimum size of a subhalo candidate Default: 200.

◆ SetNumSPHNeighbors()

virtual void vtkPANLSubhaloFinder::SetNumSPHNeighbors ( int  )
virtual

Gets/Sets NumSPHNeighbors Default: 64.

◆ GetNumSPHNeighbors()

virtual int vtkPANLSubhaloFinder::GetNumSPHNeighbors ( )
virtual

Gets/Sets NumSPHNeighbors Default: 64.

◆ SetNumNeighbors()

virtual void vtkPANLSubhaloFinder::SetNumNeighbors ( int  )
virtual

Gets/Sets the number of neighbors that are examined by the subhalo finder to determine local clumps near the each particle Default: 20.

◆ GetNumNeighbors()

virtual int vtkPANLSubhaloFinder::GetNumNeighbors ( )
virtual

Gets/Sets the number of neighbors that are examined by the subhalo finder to determine local clumps near the each particle Default: 20.

◆ FillInputPortInformation()

int vtkPANLSubhaloFinder::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protected

◆ RequestInformation()

virtual int vtkPANLSubhaloFinder::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

◆ RequestData()

virtual int vtkPANLSubhaloFinder::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Member Data Documentation

◆ RL

double vtkPANLSubhaloFinder::RL
protected

Definition at line 196 of file vtkPANLSubhaloFinder.h.

◆ DeadSize

double vtkPANLSubhaloFinder::DeadSize
protected

Definition at line 197 of file vtkPANLSubhaloFinder.h.

◆ BB

double vtkPANLSubhaloFinder::BB
protected

Definition at line 198 of file vtkPANLSubhaloFinder.h.

◆ ParticleMass

double vtkPANLSubhaloFinder::ParticleMass
protected

Definition at line 199 of file vtkPANLSubhaloFinder.h.

◆ AlphaFactor

double vtkPANLSubhaloFinder::AlphaFactor
protected

Definition at line 200 of file vtkPANLSubhaloFinder.h.

◆ BetaFactor

double vtkPANLSubhaloFinder::BetaFactor
protected

Definition at line 201 of file vtkPANLSubhaloFinder.h.

◆ MinCandidateSize

int vtkPANLSubhaloFinder::MinCandidateSize
protected

Definition at line 202 of file vtkPANLSubhaloFinder.h.

◆ NumSPHNeighbors

int vtkPANLSubhaloFinder::NumSPHNeighbors
protected

Definition at line 203 of file vtkPANLSubhaloFinder.h.

◆ NumNeighbors

int vtkPANLSubhaloFinder::NumNeighbors
protected

Definition at line 204 of file vtkPANLSubhaloFinder.h.

◆ Mode

int vtkPANLSubhaloFinder::Mode
protected

Definition at line 206 of file vtkPANLSubhaloFinder.h.

◆ SizeThreshold

vtkIdType vtkPANLSubhaloFinder::SizeThreshold
protected

Definition at line 207 of file vtkPANLSubhaloFinder.h.

◆ HalosToProcess

vtkNew<vtkIdList> vtkPANLSubhaloFinder::HalosToProcess
protected

Definition at line 209 of file vtkPANLSubhaloFinder.h.

◆ Controller

vtkMultiProcessController* vtkPANLSubhaloFinder::Controller
protected

Definition at line 210 of file vtkPANLSubhaloFinder.h.

◆ Internal

vtkInternals* vtkPANLSubhaloFinder::Internal
protected

Definition at line 212 of file vtkPANLSubhaloFinder.h.


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