#include <LagrangianStructures.h>

Inheritance diagram for vtkm::filter::flow::LagrangianStructures:

Public Member Functions
VTKM_CONT bool	CanThread () const override

void	SetStepSize (vtkm::FloatDefault s)

vtkm::FloatDefault	GetStepSize ()

void	SetNumberOfSteps (vtkm::Id n)

vtkm::Id	GetNumberOfSteps ()

void	SetAdvectionTime (vtkm::FloatDefault advectionTime)

vtkm::FloatDefault	GetAdvectionTime ()

void	SetUseAuxiliaryGrid (bool useAuxiliaryGrid)

bool	GetUseAuxiliaryGrid ()

void	SetAuxiliaryGridDimensions (vtkm::Id3 auxiliaryDims)

vtkm::Id3	GetAuxiliaryGridDimensions ()

void	SetUseFlowMapOutput (bool useFlowMapOutput)

bool	GetUseFlowMapOutput ()

void	SetOutputFieldName (std::string outputFieldName)

std::string	GetOutputFieldName ()

void	SetFlowMapOutput (vtkm::cont::ArrayHandle< vtkm::Vec3f > &flowMap)

vtkm::cont::ArrayHandle< vtkm::Vec3f >	GetFlowMapOutput ()

Public Member Functions inherited from vtkm::filter::FilterField
	FilterField ()

VTKM_CONT void	SetOutputFieldName (const std::string &name)

const VTKM_CONT std::string &	GetOutputFieldName () const

VTKM_CONT void	SetActiveField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)

void	SetActiveField (vtkm::IdComponent index, const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)

const VTKM_CONT std::string &	GetActiveFieldName (vtkm::IdComponent index=0) const

VTKM_CONT vtkm::cont::Field::Association	GetActiveFieldAssociation (vtkm::IdComponent index=0) const

VTKM_CONT void	SetActiveCoordinateSystem (vtkm::Id coord_idx)

VTKM_CONT void	SetActiveCoordinateSystem (vtkm::IdComponent index, vtkm::Id coord_idx)

VTKM_CONT vtkm::Id	GetActiveCoordinateSystemIndex () const

VTKM_CONT vtkm::Id	GetActiveCoordinateSystemIndex (vtkm::IdComponent index) const

VTKM_CONT void	SetUseCoordinateSystemAsField (bool val)

VTKM_CONT void	SetUseCoordinateSystemAsField (vtkm::IdComponent index, bool val)

VTKM_CONT bool	GetUseCoordinateSystemAsField (vtkm::IdComponent index=0) const

Public Member Functions inherited from vtkm::filter::Filter
virtual VTKM_CONT	~Filter ()

VTKM_CONT void	SetThreadsPerCPU (vtkm::Id numThreads)

VTKM_CONT void	SetThreadsPerGPU (vtkm::Id numThreads)

VTKM_CONT vtkm::Id	GetThreadsPerCPU () const

VTKM_CONT vtkm::Id	GetThreadsPerGPU () const

VTKM_CONT bool	GetRunMultiThreadedFilter () const

VTKM_CONT void	SetRunMultiThreadedFilter (bool val)

void	SetInvoker (vtkm::cont::Invoker inv)
	Specify the vtkm::cont::Invoker to be used to execute worklets by this filter instance. More...

VTKM_CONT void	SetFieldsToPass (const vtkm::filter::FieldSelection &fieldsToPass)
	Specify which fields get passed from input to output. More...

VTKM_CONT void	SetFieldsToPass (vtkm::filter::FieldSelection &&fieldsToPass)
	Specify which fields get passed from input to output. More...

VTKM_CONT void	SetFieldsToPass (const vtkm::filter::FieldSelection &fieldsToPass, vtkm::filter::FieldSelection::Mode mode)
	Specify which fields get passed from input to output. More...

VTKM_CONT void	SetFieldsToPass (std::initializer_list< std::string > fields, vtkm::filter::FieldSelection::Mode mode=vtkm::filter::FieldSelection::Mode::Select)
	Specify which fields get passed from input to output. More...

VTKM_CONT void	SetFieldsToPass (std::initializer_list< std::pair< std::string, vtkm::cont::Field::Association >> fields, vtkm::filter::FieldSelection::Mode mode=vtkm::filter::FieldSelection::Mode::Select)
	Specify which fields get passed from input to output. More...

VTKM_CONT void	SetFieldsToPass (const std::string &fieldname, vtkm::cont::Field::Association association, vtkm::filter::FieldSelection::Mode mode=vtkm::filter::FieldSelection::Mode::Select)
	Specify which fields get passed from input to output. More...

VTKM_CONT void	SetFieldsToPass (const std::string &fieldname, vtkm::filter::FieldSelection::Mode mode)
	Specify which fields get passed from input to output. More...

const VTKM_CONT vtkm::filter::FieldSelection &	GetFieldsToPass () const
	Specify which fields get passed from input to output. More...

VTKM_CONT vtkm::filter::FieldSelection &	GetFieldsToPass ()
	Specify which fields get passed from input to output. More...

VTKM_CONT void	SetPassCoordinateSystems (bool flag)
	Specify whether to always pass coordinate systems. More...

VTKM_CONT bool	GetPassCoordinateSystems () const
	Specify whether to always pass coordinate systems. More...

VTKM_CONT vtkm::cont::DataSet	Execute (const vtkm::cont::DataSet &input)

VTKM_CONT vtkm::cont::PartitionedDataSet	Execute (const vtkm::cont::PartitionedDataSet &input)

Private Member Functions
VTKM_CONT vtkm::cont::DataSet	DoExecute (const vtkm::cont::DataSet &inData) override

Private Attributes
vtkm::FloatDefault	AdvectionTime

vtkm::Id3	AuxiliaryDims

vtkm::cont::ArrayHandle< vtkm::Vec3f >	FlowMapOutput

std::string	OutputFieldName = "FTLE"

vtkm::FloatDefault	StepSize = 1.0f

vtkm::Id	NumberOfSteps = 0

bool	UseAuxiliaryGrid = false

bool	UseFlowMapOutput = false

Additional Inherited Members
Protected Member Functions inherited from vtkm::filter::FilterField
const VTKM_CONT vtkm::cont::Field &	GetFieldFromDataSet (const vtkm::cont::DataSet &input) const

const VTKM_CONT vtkm::cont::Field &	GetFieldFromDataSet (vtkm::IdComponent index, const vtkm::cont::DataSet &input) const

template<typename Functor , typename... Args>
VTKM_CONT void	CastAndCallScalarField (const vtkm::cont::UnknownArrayHandle &fieldArray, Functor &&functor, Args &&... args) const

template<typename Functor , typename... Args>
VTKM_CONT void	CastAndCallScalarField (const vtkm::cont::Field &field, Functor &&functor, Args &&... args) const

template<vtkm::IdComponent VecSize, typename Functor , typename... Args>
VTKM_CONT void	CastAndCallVecField (const vtkm::cont::UnknownArrayHandle &fieldArray, Functor &&functor, Args &&... args) const

template<vtkm::IdComponent VecSize, typename Functor , typename... Args>
VTKM_CONT void	CastAndCallVecField (const vtkm::cont::Field &field, Functor &&functor, Args &&... args) const

VTKM_CONT vtkm::cont::DataSet	CreateResultField (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::Field &resultField) const
	Create the output data set for `DoExecute` More...

VTKM_CONT vtkm::cont::DataSet	CreateResultField (const vtkm::cont::DataSet &inDataSet, const std::string &resultFieldName, vtkm::cont::Field::Association resultFieldAssociation, const vtkm::cont::UnknownArrayHandle &resultFieldArray) const
	Create the output data set for `DoExecute` More...

VTKM_CONT vtkm::cont::DataSet	CreateResultFieldPoint (const vtkm::cont::DataSet &inDataSet, const std::string &resultFieldName, const vtkm::cont::UnknownArrayHandle &resultFieldArray) const
	Create the output data set for `DoExecute` More...

VTKM_CONT vtkm::cont::DataSet	CreateResultFieldCell (const vtkm::cont::DataSet &inDataSet, const std::string &resultFieldName, const vtkm::cont::UnknownArrayHandle &resultFieldArray) const
	Create the output data set for `DoExecute` More...

Protected Member Functions inherited from vtkm::filter::Filter
VTKM_CONT vtkm::cont::DataSet	CreateResult (const vtkm::cont::DataSet &inDataSet) const
	Create the output data set for `DoExecute`. More...

VTKM_CONT vtkm::cont::PartitionedDataSet	CreateResult (const vtkm::cont::PartitionedDataSet &input, const vtkm::cont::PartitionedDataSet &resultPartitions) const
	Create the output data set for `DoExecute`. More...

template<typename FieldMapper >
VTKM_CONT vtkm::cont::PartitionedDataSet	CreateResult (const vtkm::cont::PartitionedDataSet &input, const vtkm::cont::PartitionedDataSet &resultPartitions, FieldMapper &&fieldMapper) const
	Create the output data set for `DoExecute`. More...

template<typename FieldMapper >
VTKM_CONT vtkm::cont::DataSet	CreateResult (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::UnknownCellSet &resultCellSet, FieldMapper &&fieldMapper) const
	Create the output data set for `DoExecute`. More...

virtual VTKM_CONT vtkm::cont::PartitionedDataSet	DoExecutePartitions (const vtkm::cont::PartitionedDataSet &inData)

template<typename FieldMapper >
VTKM_CONT vtkm::cont::DataSet	CreateResultCoordinateSystem (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::UnknownCellSet &resultCellSet, const vtkm::cont::CoordinateSystem &resultCoordSystem, FieldMapper &&fieldMapper) const
	Create the output data set for `DoExecute`. More...

template<typename FieldMapper >
VTKM_CONT vtkm::cont::DataSet	CreateResultCoordinateSystem (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::UnknownCellSet &resultCellSet, const std::string &coordsName, const vtkm::cont::UnknownArrayHandle &coordsData, FieldMapper &&fieldMapper) const
	Create the output data set for `DoExecute`. More...

Protected Attributes inherited from vtkm::filter::Filter
vtkm::cont::Invoker	Invoke

Member Function Documentation

◆ CanThread()

VTKM_CONT bool vtkm::filter::flow::LagrangianStructures::CanThread ( ) const

inlineoverridevirtual

Reimplemented from vtkm::filter::Filter.

◆ DoExecute()

VTKM_CONT vtkm::cont::DataSet vtkm::filter::flow::LagrangianStructures::DoExecute ( const vtkm::cont::DataSet & inData )

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ GetAdvectionTime()

vtkm::FloatDefault vtkm::filter::flow::LagrangianStructures::GetAdvectionTime ( )

inline

◆ GetAuxiliaryGridDimensions()

vtkm::Id3 vtkm::filter::flow::LagrangianStructures::GetAuxiliaryGridDimensions ( )

inline

◆ GetFlowMapOutput()

vtkm::cont::ArrayHandle<vtkm::Vec3f> vtkm::filter::flow::LagrangianStructures::GetFlowMapOutput ( )

inline

◆ GetNumberOfSteps()

vtkm::Id vtkm::filter::flow::LagrangianStructures::GetNumberOfSteps ( )

inline

◆ GetOutputFieldName()

std::string vtkm::filter::flow::LagrangianStructures::GetOutputFieldName ( )

inline

◆ GetStepSize()

vtkm::FloatDefault vtkm::filter::flow::LagrangianStructures::GetStepSize ( )

inline

◆ GetUseAuxiliaryGrid()

bool vtkm::filter::flow::LagrangianStructures::GetUseAuxiliaryGrid ( )

inline

◆ GetUseFlowMapOutput()

bool vtkm::filter::flow::LagrangianStructures::GetUseFlowMapOutput ( )

inline

◆ SetAdvectionTime()

void vtkm::filter::flow::LagrangianStructures::SetAdvectionTime ( vtkm::FloatDefault advectionTime )

inline

◆ SetAuxiliaryGridDimensions()

void vtkm::filter::flow::LagrangianStructures::SetAuxiliaryGridDimensions ( vtkm::Id3 auxiliaryDims )

inline

◆ SetFlowMapOutput()

void vtkm::filter::flow::LagrangianStructures::SetFlowMapOutput ( vtkm::cont::ArrayHandle< vtkm::Vec3f > & flowMap )

inline

◆ SetNumberOfSteps()

void vtkm::filter::flow::LagrangianStructures::SetNumberOfSteps ( vtkm::Id n )

inline

◆ SetOutputFieldName()

void vtkm::filter::flow::LagrangianStructures::SetOutputFieldName ( std::string outputFieldName )

inline

◆ SetStepSize()

void vtkm::filter::flow::LagrangianStructures::SetStepSize ( vtkm::FloatDefault s )

inline

◆ SetUseAuxiliaryGrid()

void vtkm::filter::flow::LagrangianStructures::SetUseAuxiliaryGrid ( bool useAuxiliaryGrid )

inline

◆ SetUseFlowMapOutput()

void vtkm::filter::flow::LagrangianStructures::SetUseFlowMapOutput ( bool useFlowMapOutput )

inline

Member Data Documentation

◆ AdvectionTime

vtkm::FloatDefault vtkm::filter::flow::LagrangianStructures::AdvectionTime

private

◆ AuxiliaryDims

vtkm::Id3 vtkm::filter::flow::LagrangianStructures::AuxiliaryDims

private

◆ FlowMapOutput

vtkm::cont::ArrayHandle<vtkm::Vec3f> vtkm::filter::flow::LagrangianStructures::FlowMapOutput

private

◆ NumberOfSteps

vtkm::Id vtkm::filter::flow::LagrangianStructures::NumberOfSteps = 0

private

◆ OutputFieldName

std::string vtkm::filter::flow::LagrangianStructures::OutputFieldName = "FTLE"

private

◆ StepSize

vtkm::FloatDefault vtkm::filter::flow::LagrangianStructures::StepSize = 1.0f

private

◆ UseAuxiliaryGrid

bool vtkm::filter::flow::LagrangianStructures::UseAuxiliaryGrid = false

private

◆ UseFlowMapOutput

bool vtkm::filter::flow::LagrangianStructures::UseFlowMapOutput = false

private

The documentation for this class was generated from the following file:

LagrangianStructures.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ CanThread()

◆ DoExecute()

◆ GetAdvectionTime()

◆ GetAuxiliaryGridDimensions()

◆ GetFlowMapOutput()

◆ GetNumberOfSteps()

◆ GetOutputFieldName()

◆ GetStepSize()

◆ GetUseAuxiliaryGrid()

◆ GetUseFlowMapOutput()

◆ SetAdvectionTime()

◆ SetAuxiliaryGridDimensions()

◆ SetFlowMapOutput()

◆ SetNumberOfSteps()

◆ SetOutputFieldName()

◆ SetStepSize()

◆ SetUseAuxiliaryGrid()

◆ SetUseFlowMapOutput()

Member Data Documentation

◆ AdvectionTime

◆ AuxiliaryDims

◆ FlowMapOutput

◆ NumberOfSteps

◆ OutputFieldName

◆ StepSize

◆ UseAuxiliaryGrid

◆ UseFlowMapOutput