vtkPLANLHaloFinder.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) 2007, 2009 Los Alamos National Security, LLC
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-LANL-USGov
#ifndef vtkPLANLHaloFinder_h
#define vtkPLANLHaloFinder_h

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

// Forward declarations
class vtkMultiProcessController;
class vtkIndent;
class vtkInformation;
class vtkInformationVector;
class vtkUnstructuredGrid;

// CosmoTools Forward declarations
namespace cosmotk
{
class CosmoHaloFinderP;
}

// HaloFinderInternals Forward declarations
namespace HaloFinderInternals
{
class ParticleData;
class HaloData;
}

class VTKPVVTKEXTENSIONSCOSMOTOOLS_EXPORT vtkPLANLHaloFinder : public vtkUnstructuredGridAlgorithm
{
public:
  enum
  {
    AVERAGE = 0,
    CENTER_OF_MASS = 1,
    MBP = 2,
    MCP = 3,
    NUMBER_OF_CENTER_FINDING_METHODS
  } CenterDetectionAlgorithm;

  static vtkPLANLHaloFinder* New();

  vtkTypeMacro(vtkPLANLHaloFinder, vtkUnstructuredGridAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent);


  virtual vtkMultiProcessController* GetController();
  virtual void SetController(vtkMultiProcessController*);


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


  vtkSetMacro(RL, float);
  vtkGetMacro(RL, float);


  vtkSetMacro(Overlap, float);
  vtkGetMacro(Overlap, float);


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


  vtkSetMacro(BB, float);
  vtkGetMacro(BB, float);


  vtkSetMacro(ComputeSOD, int);
  vtkGetMacro(ComputeSOD, int);


  vtkSetMacro(CenterFindingMethod, int);
  vtkGetMacro(CenterFindingMethod, int);


  vtkSetMacro(RhoC, float);
  vtkGetMacro(RhoC, float);


  vtkSetMacro(SODMass, float);
  vtkGetMacro(SODMass, float);


  vtkSetMacro(MinRadiusFactor, float);
  vtkGetMacro(MinRadiusFactor, float);


  vtkSetMacro(MaxRadiusFactor, float);
  vtkGetMacro(MaxRadiusFactor, float);


  vtkSetMacro(SODBins, int);
  vtkGetMacro(SODBins, int);


  vtkSetMacro(MinFOFSize, int);
  vtkGetMacro(MinFOFSize, int);


  vtkSetMacro(MinFOFMass, float);
  vtkGetMacro(MinFOFMass, float);

protected:
  vtkPLANLHaloFinder();
  ~vtkPLANLHaloFinder();

  virtual int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*);

  bool CheckOutputIntegrity(vtkUnstructuredGrid* outputParticles);

  void ComputeFOFHalos(vtkUnstructuredGrid* particles, vtkUnstructuredGrid* haloCenters);

  void ComputeSODHalos(vtkUnstructuredGrid* particles, vtkUnstructuredGrid* haloCenters);

  void VectorizeData(vtkUnstructuredGrid* particles);

  void ComputeFOFHaloProperties();

  void InitializeHaloCenters(vtkUnstructuredGrid* haloCenters, unsigned int N);

  void MarkHaloParticlesAndGetCenter(const unsigned int halo, const int internalHaloIdx,
    double center[3], vtkUnstructuredGrid* particles);

  void ResetHaloFinderInternals();

  void InitializeSODHaloArrays(vtkUnstructuredGrid* haloCenters);

  vtkMultiProcessController* Controller;

  int NP;        // num particles in the original simulation
  float RL;      // The physical box dimensions (rL)
  float Overlap; // The ghost cell boundary space
  int PMin;      // The minimum particles for a halo
  float BB;      // The linking length

  int CenterFindingMethod; // Halo center detection method
  int ComputeSOD;          // Turn on Spherical OverDensity (SOD) halos

  float RhoC;            // SOD rho_C (2.77536627e11)
  float SODMass;         // Initial SOD mass (1.0e14)
  float MinRadiusFactor; // Minimum factor of SOD radius (0.5)
  float MaxRadiusFactor; // Maximum factor of SOD radius (2.0)
  int SODBins;           // Number of log scale bins for SOD (20)
  int MinFOFSize;        // Minimum FOF size for SOD (1000)
  float MinFOFMass;      // Minimum FOF mass for SOD (5.0e12)

  HaloFinderInternals::ParticleData* Particles;
  HaloFinderInternals::HaloData* Halos;
  cosmotk::CosmoHaloFinderP* HaloFinder;

private:
  vtkPLANLHaloFinder(const vtkPLANLHaloFinder&) = delete;
  void operator=(const vtkPLANLHaloFinder&) = delete;
};

#endif //  vtkPLANLHaloFinder_h