vtkPANLSubhaloFinder.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-License-Identifier: BSD-3-Clause
#ifndef vtkPANLSubhaloFinder_h
#define vtkPANLSubhaloFinder_h

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

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
  };


  vtkSetClampMacro(Mode, int, ALL_HALOS, ONLY_SELECTED_HALOS);
  vtkGetMacro(Mode, int);


  vtkSetMacro(SizeThreshold, vtkIdType);
  vtkGetMacro(SizeThreshold, vtkIdType);

  vtkIdType GetHaloToProcess(vtkIdType idx);
  void AddHaloToProcess(vtkIdType haloId);
  void SetHaloToProcess(vtkIdType idx, vtkIdType haloId);
  void SetNumberOfHalosToProcess(vtkIdType num);
  vtkIdType GetNumberOfHalosToProcess();
  void ClearHalosToProcess();


  vtkSetMacro(RL, double);
  vtkGetMacro(RL, 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(MinCandidateSize, int);
  vtkGetMacro(MinCandidateSize, int);


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


  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&) = delete;
  void operator=(const vtkPANLSubhaloFinder&) = delete;

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

#endif