vtkTemporalAlgorithm.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkTemporalAlgorithm_h
#define vtkTemporalAlgorithm_h
 
#include "vtkAlgorithm.h"
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkNew.h"                        // For TimeSteps
 
VTK_ABI_NAMESPACE_BEGIN
 
class vtkDoubleArray;
class vtkInformation;
class vtkInformationVector;
 
template <class AlgorithmT>
class vtkTemporalAlgorithm : public AlgorithmT
{
public:

  vtkTemplateTypeMacro(vtkTemporalAlgorithm, AlgorithmT);

  static const char* TimeStepsArrayName() { return "time_steps"; }
 
  static_assert(std::is_base_of<vtkAlgorithm, AlgorithmT>::value,
    "Template argument must inherit vtkAlgorithm");
 
protected:
  vtkTemporalAlgorithm();
 
  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int RequestUpdateTime(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int RequestUpdateExtent(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  virtual int Initialize(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) = 0;

  virtual int Execute(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) = 0;

  virtual int Finalize(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) = 0;

  int GetCurrentTimeIndex() const;

  double GetCurrentTimeStep() const;

  bool IntegrateFullTimeSeries = false;

  bool RunBackward = false;


  std::vector<double> InputTimeSteps;
  int TerminationTimeIndex = 0;
  int CurrentTimeIndex = 0;

  bool MustReset() const;

  bool MustContinue() const;

  bool NoPriorTimeStepAccess = false;

  vtkNew<vtkDoubleArray> ProcessedTimeSteps;
 
private:
  vtkTemporalAlgorithm(const vtkTemporalAlgorithm&) = delete;
  void operator=(const vtkTemporalAlgorithm&) = delete;
};
 
VTK_ABI_NAMESPACE_END
 
#define vtkCreateWrappedTemporalAlgorithmInterface()                                               \
  static const char* TimeStepsArrayName();                                                         \
                                                                                                   \
protected:                                                                                         \
  int GetCurrentTimeIndex() const;                                                                 \
  double GetCurrentTimeStep() const;                                                               \
  bool IntegrateFullTimeSeries;                                                                    \
                                                                                                   \
public:
 
#include "vtkTemporalAlgorithm.txx"
#endif