vtkPANLHaloFinder.h

Go to the documentation of this file.

/*=========================================================================

 Program:   Visualization Toolkit
 Module:    vtkPANLHaloFinder.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 vtkPANLHaloFinder_h
#define vtkPANLHaloFinder_h

#include "vtkPVVTKExtensionsCosmoToolsModule.h" // For export macro
#include "vtkUnstructuredGridAlgorithm.h"

class vtkMultiProcessController;

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


  vtkSetMacro(RunSubHaloFinder, bool) vtkGetMacro(RunSubHaloFinder, bool)
    vtkBooleanMacro(RunSubHaloFinder, bool)


    vtkSetMacro(RL, double) vtkGetMacro(RL, double)


    vtkSetMacro(DistanceConvertFactor, double) vtkGetMacro(DistanceConvertFactor, double)


    vtkSetMacro(MassConvertFactor, double) vtkGetMacro(MassConvertFactor, double)


    vtkSetMacro(DeadSize, double) vtkGetMacro(DeadSize, double)


    vtkSetMacro(ParticleMass, float) vtkGetMacro(ParticleMass, float)


    vtkSetMacro(BB, double) vtkGetMacro(BB, double)


    vtkSetClampMacro(AlphaFactor, double, 0.0, 1.0) vtkGetMacro(AlphaFactor, double)


    vtkSetClampMacro(BetaFactor, double, 0.0, 1.0) vtkGetMacro(BetaFactor, double)


    vtkSetMacro(NP, int) vtkGetMacro(NP, int)


    vtkSetMacro(NMin, int) vtkGetMacro(NMin, int)


    vtkSetMacro(PMin, int) vtkGetMacro(PMin, int)


    vtkSetMacro(MinFOFSubhaloSize, long) vtkGetMacro(MinFOFSubhaloSize, long)


    vtkSetMacro(MinCandidateSize, int) vtkGetMacro(MinCandidateSize, int)


    vtkSetMacro(NumSPHNeighbors, int) vtkGetMacro(NumSPHNeighbors, int)


    vtkSetMacro(NumNeighbors, int) vtkGetMacro(NumNeighbors, int)

    enum CenterFindingType {
      NONE = 0,
      MOST_BOUND_PARTICLE = 1,
      MOST_CONNECTED_PARTICLE = 2,
      HIST_CENTER_FINDING = 3
    };


  vtkSetMacro(CenterFindingMode, int) vtkGetMacro(CenterFindingMode, int)


    vtkSetMacro(SmoothingLength, double) vtkGetMacro(SmoothingLength, double)


    vtkSetMacro(OmegaDM, double) vtkGetMacro(OmegaDM, double)


    vtkSetMacro(OmegaNU, double) vtkGetMacro(OmegaNU, double)


    vtkSetMacro(Deut, double) vtkGetMacro(Deut, double)


    vtkSetMacro(Hubble, double) vtkGetMacro(Hubble, double)


    vtkSetMacro(RedShift, double) vtkGetMacro(RedShift, double)

    protected : vtkPANLHaloFinder();
  virtual ~vtkPANLHaloFinder();

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

  double RL;
  double DistanceConvertFactor;
  double MassConvertFactor;
  double DeadSize;
  float ParticleMass;
  double BB;
  double AlphaFactor;
  double BetaFactor;
  int NP;
  int NMin;
  int PMin;
  long MinFOFSubhaloSize;
  int MinCandidateSize;
  int NumSPHNeighbors;
  int NumNeighbors;

  bool RunSubHaloFinder;

  // Center finding parameters
  int CenterFindingMode;
  double SmoothingLength;
  double OmegaNU;
  double OmegaDM;
  double Deut;
  double Hubble;
  double RedShift;

  vtkMultiProcessController* Controller;

  class vtkInternals;
  vtkInternals* Internal;

private:
  vtkPANLHaloFinder(const vtkPANLHaloFinder&) = delete;
  void operator=(const vtkPANLHaloFinder&) = delete;

  void ExtractDataArrays(vtkUnstructuredGrid* input, vtkIdType offset);
  void DistributeInput();
  void CreateGhostParticles();
  void ExecuteHaloFinder(vtkUnstructuredGrid* allParticles, vtkUnstructuredGrid* fofProperties);
  void ExecuteSubHaloFinder(
    vtkUnstructuredGrid* allParticles, vtkUnstructuredGrid* subFofProperties);
  void FindCenters(vtkUnstructuredGrid* allParticles, vtkUnstructuredGrid* fofProperties);
};

#endif // vtkPANLHaloFinder_h