LagrangianStructures.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt 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.
//============================================================================
 
#ifndef viskores_filter_flow_LagrangianStructures_h
#define viskores_filter_flow_LagrangianStructures_h
 
#include <viskores/filter/Filter.h>
#include <viskores/filter/flow/FlowTypes.h>
#include <viskores/filter/flow/viskores_filter_flow_export.h>
 
namespace viskores
{
namespace filter
{
namespace flow
{
 
class VISKORES_FILTER_FLOW_EXPORT LagrangianStructures : public viskores::filter::Filter
{
public:
  VISKORES_CONT
  bool CanThread() const override { return false; }
 
  void SetStepSize(viskores::FloatDefault s) { this->StepSize = s; }
  viskores::FloatDefault GetStepSize() { return this->StepSize; }
 
  void SetNumberOfSteps(viskores::Id n) { this->NumberOfSteps = n; }
  viskores::Id GetNumberOfSteps() { return this->NumberOfSteps; }
 
  void SetAdvectionTime(viskores::FloatDefault advectionTime)
  {
    this->AdvectionTime = advectionTime;
  }
  viskores::FloatDefault GetAdvectionTime() { return this->AdvectionTime; }
 
  void SetUseAuxiliaryGrid(bool useAuxiliaryGrid) { this->UseAuxiliaryGrid = useAuxiliaryGrid; }
  bool GetUseAuxiliaryGrid() { return this->UseAuxiliaryGrid; }
 
  void SetAuxiliaryGridDimensions(viskores::Id3 auxiliaryDims)
  {
    this->AuxiliaryDims = auxiliaryDims;
  }
  viskores::Id3 GetAuxiliaryGridDimensions() { return this->AuxiliaryDims; }
 
  void SetUseFlowMapOutput(bool useFlowMapOutput) { this->UseFlowMapOutput = useFlowMapOutput; }
  bool GetUseFlowMapOutput() { return this->UseFlowMapOutput; }
 
  void SetOutputFieldName(std::string outputFieldName) { this->OutputFieldName = outputFieldName; }
  std::string GetOutputFieldName() { return this->OutputFieldName; }
 
  inline void SetFlowMapOutput(viskores::cont::ArrayHandle<viskores::Vec3f>& flowMap)
  {
    this->FlowMapOutput = flowMap;
  }
  inline viskores::cont::ArrayHandle<viskores::Vec3f> GetFlowMapOutput()
  {
    return this->FlowMapOutput;
  }
 
private:
  VISKORES_CONT viskores::cont::DataSet DoExecute(const viskores::cont::DataSet& inData) override;
 
  viskores::FloatDefault AdvectionTime;
  viskores::Id3 AuxiliaryDims;
  viskores::cont::ArrayHandle<viskores::Vec3f> FlowMapOutput;
  std::string OutputFieldName = "FTLE";
  viskores::FloatDefault StepSize = 1.0f;
  viskores::Id NumberOfSteps = 0;
  bool UseAuxiliaryGrid = false;
  bool UseFlowMapOutput = false;
};
 
}
}
} // namespace viskores
 
#endif // viskores_filter_flow_LagrangianStructures_h