vtkMPIMoveData.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 vtkMPIMoveData_h
#define vtkMPIMoveData_h

#include "vtkPVVTKExtensionsFiltersRenderingModule.h" //needed for exports
#include "vtkPassInputTypeAlgorithm.h"

class vtkMultiProcessController;
class vtkSocketController;
class vtkMPIMToNSocketConnection;
class vtkDataSet;
class vtkIndent;

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

  virtual void InitializeForCommunicationForParaView();


  void SetController(vtkMultiProcessController* controller);
  void SetMPIMToNSocketConnection(vtkMPIMToNSocketConnection* sc);
  void SetClientDataServerSocketController(vtkMultiProcessController*);
  vtkGetObjectMacro(ClientDataServerSocketController, vtkMultiProcessController);


  void SetServerToClient() { this->Server = vtkMPIMoveData::CLIENT; }
  void SetServerToDataServer() { this->Server = vtkMPIMoveData::DATA_SERVER; }
  void SetServerToRenderServer() { this->Server = vtkMPIMoveData::RENDER_SERVER; }
  vtkSetClampMacro(Server, int, vtkMPIMoveData::CLIENT, vtkMPIMoveData::RENDER_SERVER);
  vtkGetMacro(Server, int);

  void SetMoveModeToPassThrough() { this->MoveMode = vtkMPIMoveData::PASS_THROUGH; }
  void SetMoveModeToCollect() { this->MoveMode = vtkMPIMoveData::COLLECT; }
  void SetMoveModeToClone() { this->MoveMode = vtkMPIMoveData::CLONE; }
  vtkSetClampMacro(
    MoveMode, int, vtkMPIMoveData::PASS_THROUGH, vtkMPIMoveData::COLLECT_AND_PASS_THROUGH);


  vtkSetMacro(OutputDataType, int);
  vtkGetMacro(OutputDataType, int);


  static void SetUseZLibCompression(bool b);
  static bool GetUseZLibCompression();

  bool GetOutputGeneratedOnProcess();


  vtkSetMacro(SkipDataServerGatherToZero, bool);
  vtkGetMacro(SkipDataServerGatherToZero, bool);

  enum MoveModes
  {
    PASS_THROUGH = 0,
    COLLECT = 1,
    CLONE = 2,
    COLLECT_AND_PASS_THROUGH = 3,
    INVALID
  };

protected:
  vtkMPIMoveData();
  ~vtkMPIMoveData() override;

  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;

  vtkMultiProcessController* Controller;
  vtkMultiProcessController* ClientDataServerSocketController;
  vtkMPIMToNSocketConnection* MPIMToNSocketConnection;

  void DataServerAllToN(vtkDataObject* inData, vtkDataObject* outData, int n);
  void DataServerGatherAll(vtkDataObject* input, vtkDataObject* output);
  void DataServerGatherToZero(vtkDataObject* input, vtkDataObject* output);
  void DataServerSendToRenderServer(vtkDataObject* output);
  void RenderServerReceiveFromDataServer(vtkDataObject* output);
  void DataServerZeroSendToRenderServerZero(vtkDataObject* data);
  void RenderServerZeroReceiveFromDataServerZero(vtkDataObject* data);
  void RenderServerZeroBroadcast(vtkDataObject* data);
  void DataServerSendToClient(vtkDataObject* output);
  void ClientReceiveFromDataServer(vtkDataObject* output);

  int NumberOfBuffers;
  vtkIdType* BufferLengths;
  vtkIdType* BufferOffsets;
  char* Buffers;
  vtkIdType BufferTotalLength;

  void ClearBuffer();
  void MarshalDataToBuffer(vtkDataObject* data);
  void ReconstructDataFromBuffer(vtkDataObject* data);

  int MoveMode;
  int Server;

  bool SkipDataServerGatherToZero;

  enum Servers
  {
    CLIENT = 0,
    DATA_SERVER = 1,
    RENDER_SERVER = 2
  };

  int OutputDataType;

private:
  int UpdateNumberOfPieces;
  int UpdatePiece;

  vtkMPIMoveData(const vtkMPIMoveData&) = delete;
  void operator=(const vtkMPIMoveData&) = delete;

  static bool UseZLibCompression;
};

#endif