You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

127 lines
3.6 KiB
C++

/*=========================================================================
Program: Visualization Toolkit
Module: vtkMultiTimeStepAlgorithm.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.
=========================================================================*/
/**
* @class vtkMultiTimeStepAlgorithm
* @brief Superclass for algorithms that would like to
* make multiple time requests
*
* This class can be inherited by any algorithm that wishes to make multiple
* time requests upstream.
* The child class uses UPDATE_TIME_STEPS to make the time requests and
* use set of time-stamped data objects are stored in time order
* in a vtkMultiBlockDataSet object.
*/
#ifndef vtkMultiTimeStepAlgorithm_h
#define vtkMultiTimeStepAlgorithm_h
#include "vtkAlgorithm.h"
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkSmartPointer.h" //needed for a private variable
#include "vtkDataObject.h" // needed for the smart pointer
#include <vector> //needed for a private variable
class vtkInformationDoubleVectorKey;
class vtkMultiBlockDataSet;
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkMultiTimeStepAlgorithm : public vtkAlgorithm
{
public:
static vtkMultiTimeStepAlgorithm* New();
vtkTypeMacro(vtkMultiTimeStepAlgorithm, vtkAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
protected:
vtkMultiTimeStepAlgorithm();
~vtkMultiTimeStepAlgorithm() override {}
/**
* This is filled by the child class to request multiple time steps
*/
static vtkInformationDoubleVectorKey* UPDATE_TIME_STEPS();
//@{
/**
* This is called by the superclass.
* This is the method you should override.
*/
virtual int RequestDataObject(vtkInformation*, vtkInformationVector**, vtkInformationVector*)
{
return 1;
}
//@}
//@{
/**
* This is called by the superclass.
* This is the method you should override.
*/
virtual int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*)
{
return 1;
}
//@}
/**
* This is called by the superclass.
* This is the method you should override.
*/
virtual int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*)
{
return 1;
}
/**
* This is called by the superclass.
* This is the method you should override.
*/
virtual int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*)
{
return 1;
}
vtkTypeBool ProcessRequest(
vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
bool CacheData;
unsigned int NumberOfCacheEntries;
private:
vtkMultiTimeStepAlgorithm(const vtkMultiTimeStepAlgorithm&) = delete;
void operator=(const vtkMultiTimeStepAlgorithm&) = delete;
vtkSmartPointer<vtkMultiBlockDataSet> MDataSet; // stores all the temporal data sets
int RequestUpdateIndex; // keep track of the time looping index
std::vector<double> UpdateTimeSteps; // store the requested time steps
bool IsInCache(double time, size_t& idx);
struct TimeCache
{
TimeCache(double time, vtkDataObject* data)
: TimeValue(time)
, Data(data)
{
}
double TimeValue;
vtkSmartPointer<vtkDataObject> Data;
};
std::vector<TimeCache> Cache;
};
#endif