base class for advecting particles in a vector field. More...

#include <FilterParticleAdvection.h>

Inheritance diagram for vtkm::filter::flow::FilterParticleAdvection:

Public Member Functions
bool	CanThread () const override
	Returns whether the filter can execute on partitions in concurrent threads. More...

void	SetStepSize (vtkm::FloatDefault s)
	Specifies the step size used for the numerical integrator. More...

void	SetNumberOfSteps (vtkm::Id n)
	Specifies the maximum number of integration steps for each particle. More...

template<typename ParticleType >
void	SetSeeds (vtkm::cont::ArrayHandle< ParticleType > &seeds)
	Specify the seed locations for the particle advection. More...

template<typename ParticleType >
void	SetSeeds (const std::vector< ParticleType > &seeds, vtkm::CopyFlag copyFlag=vtkm::CopyFlag::On)
	Specify the seed locations for the particle advection. More...

void	SetBlockIDs (const std::vector< vtkm::Id > &blockIds)

void	SetSolverRK4 ()

void	SetSolverEuler ()

bool	GetUseThreadedAlgorithm ()

void	SetUseThreadedAlgorithm (bool val)

void	SetUseAsynchronousCommunication ()

bool	GetUseAsynchronousCommunication ()

void	SetUseSynchronousCommunication ()

bool	GetUseSynchronousCommunication ()

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

virtual	~Filter ()

vtkm::cont::DataSet	Execute (const vtkm::cont::DataSet &input)
	Executes the filter on the input and produces a result dataset. More...

vtkm::cont::PartitionedDataSet	Execute (const vtkm::cont::PartitionedDataSet &input)
	Executes the filter on the input PartitionedDataSet and produces a result PartitionedDataSet. More...

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

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

void	SetFieldsToPass (const vtkm::filter::FieldSelection &fieldsToPass, vtkm::filter::FieldSelection::Mode mode)

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...

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...

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...

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

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

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

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

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

void	SetOutputFieldName (const std::string &name)
	Specifies the name of the output field generated. More...

const std::string &	GetOutputFieldName () const
	Specifies the name of the output field generated. More...

void	SetActiveField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)
	Specifies a field to operate on. More...

void	SetActiveField (vtkm::IdComponent index, const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)
	Specifies a field to operate on. More...

const std::string &	GetActiveFieldName (vtkm::IdComponent index=0) const
	Specifies a field to operate on. More...

vtkm::cont::Field::Association	GetActiveFieldAssociation (vtkm::IdComponent index=0) const
	Specifies a field to operate on. More...

void	SetActiveCoordinateSystem (vtkm::Id coord_idx)
	Specifies the coordinate system index to make active to use when processing the input `vtkm::cont::DataSet`. More...

void	SetActiveCoordinateSystem (vtkm::IdComponent index, vtkm::Id coord_idx)
	Specifies the coordinate system index to make active to use when processing the input `vtkm::cont::DataSet`. More...

vtkm::Id	GetActiveCoordinateSystemIndex (vtkm::IdComponent index=0) const
	Specifies the coordinate system index to make active to use when processing the input `vtkm::cont::DataSet`. More...

void	SetUseCoordinateSystemAsField (bool val)
	Specifies whether to use point coordinates as the input field. More...

void	SetUseCoordinateSystemAsField (vtkm::IdComponent index, bool val)
	Specifies whether to use point coordinates as the input field. More...

bool	GetUseCoordinateSystemAsField (vtkm::IdComponent index=0) const
	Specifies whether to use point coordinates as the input field. More...

vtkm::IdComponent	GetNumberOfActiveFields () const
	Return the number of active fields currently set. More...

void	SetThreadsPerCPU (vtkm::Id numThreads)

void	SetThreadsPerGPU (vtkm::Id numThreads)

vtkm::Id	GetThreadsPerCPU () const

vtkm::Id	GetThreadsPerGPU () const

bool	GetRunMultiThreadedFilter () const

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...

Protected Member Functions
virtual void	ValidateOptions () const

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

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::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::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::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...

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::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::DataSet	CreateResult (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::UnknownCellSet &resultCellSet, FieldMapper &&fieldMapper) const
	Create the output data set for `DoExecute`. More...

template<typename FieldMapper >
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::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...

const vtkm::cont::Field &	GetFieldFromDataSet (const vtkm::cont::DataSet &input) const
	Retrieve an input field from a `vtkm::cont::DataSet` object. More...

const vtkm::cont::Field &	GetFieldFromDataSet (vtkm::IdComponent index, const vtkm::cont::DataSet &input) const
	Retrieve an input field from a `vtkm::cont::DataSet` object. More...

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

template<typename Functor , typename... Args>
void	CastAndCallScalarField (const vtkm::cont::UnknownArrayHandle &fieldArray, Functor &&functor, Args &&... args) const
	Convenience method to get the array from a filter's input scalar field. More...

template<typename Functor , typename... Args>
void	CastAndCallScalarField (const vtkm::cont::Field &field, Functor &&functor, Args &&... args) const
	Convenience method to get the array from a filter's input scalar field. More...

template<vtkm::IdComponent VecSize, typename Functor , typename... Args>
void	CastAndCallVecField (const vtkm::cont::UnknownArrayHandle &fieldArray, Functor &&functor, Args &&... args) const
	Convenience method to get the array from a filter's input vector field. More...

template<vtkm::IdComponent VecSize, typename Functor , typename... Args>
void	CastAndCallVecField (const vtkm::cont::Field &field, Functor &&functor, Args &&... args) const
	Convenience method to get the array from a filter's input vector field. More...

template<typename Functor , typename... Args>
void	CastAndCallVariableVecField (const vtkm::cont::UnknownArrayHandle &fieldArray, Functor &&functor, Args &&... args) const
	This method is like `CastAndCallVecField` except that it can be used for a field of unknown vector size (or scalars). More...

template<typename Functor , typename... Args>
void	CastAndCallVariableVecField (const vtkm::cont::Field &field, Functor &&functor, Args &&... args) const
	This method is like `CastAndCallVecField` except that it can be used for a field of unknown vector size (or scalars). More...

Protected Attributes
bool	BlockIdsSet = false

std::vector< vtkm::Id >	BlockIds

vtkm::Id	NumberOfSteps = 0

vtkm::cont::UnknownArrayHandle	Seeds

vtkm::filter::flow::IntegrationSolverType	SolverType

vtkm::FloatDefault	StepSize = 0

bool	UseAsynchronousCommunication = true

bool	UseThreadedAlgorithm = false

vtkm::filter::flow::VectorFieldType	VecFieldType

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

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

Detailed Description

base class for advecting particles in a vector field.

Takes as input a vector field and seed locations and advects the seeds through the flow field.

Member Function Documentation

◆ CanThread()

bool vtkm::filter::flow::FilterParticleAdvection::CanThread ( ) const

inlineoverridevirtual

Returns whether the filter can execute on partitions in concurrent threads.

If a derived class's implementation of DoExecute cannot run on multiple threads, then the derived class should override this method to return false.

Reimplemented from vtkm::filter::Filter.

◆ DoExecute()

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

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ GetUseAsynchronousCommunication()

bool vtkm::filter::flow::FilterParticleAdvection::GetUseAsynchronousCommunication ( )

inline

◆ GetUseSynchronousCommunication()

bool vtkm::filter::flow::FilterParticleAdvection::GetUseSynchronousCommunication ( )

inline

◆ GetUseThreadedAlgorithm()

bool vtkm::filter::flow::FilterParticleAdvection::GetUseThreadedAlgorithm ( )

inline

◆ SetBlockIDs()

void vtkm::filter::flow::FilterParticleAdvection::SetBlockIDs ( const std::vector< vtkm::Id > & blockIds )

inline

◆ SetNumberOfSteps()

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

inline

Specifies the maximum number of integration steps for each particle.

Some particle paths may loop and continue indefinitely. This parameter sets an upper limit on the total length of advection.

◆ SetSeeds() [1/2]

template<typename ParticleType >

void vtkm::filter::flow::FilterParticleAdvection::SetSeeds	(	const std::vector< ParticleType > &	seeds,
		vtkm::CopyFlag	copyFlag = `vtkm::CopyFlag::On`
	)

inline

Specify the seed locations for the particle advection.

Each seed represents one particle that is advected by the vector field. The particles are represented by a vtkm::Particle object or similar type of object (such as vtkm::ChargedParticle).

◆ SetSeeds() [2/2]

template<typename ParticleType >

void vtkm::filter::flow::FilterParticleAdvection::SetSeeds ( vtkm::cont::ArrayHandle< ParticleType > & seeds )

inline

Specify the seed locations for the particle advection.

Each seed represents one particle that is advected by the vector field. The particles are represented by a vtkm::Particle object or similar type of object (such as vtkm::ChargedParticle).

◆ SetSolverEuler()

void vtkm::filter::flow::FilterParticleAdvection::SetSolverEuler ( )

inline

◆ SetSolverRK4()

void vtkm::filter::flow::FilterParticleAdvection::SetSolverRK4 ( )

inline

◆ SetStepSize()

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

inline

Specifies the step size used for the numerical integrator.

The numerical integrators operate by advancing each particle by a finite amount. This parameter defines the distance to advance each time. Smaller values are more accurate but take longer to integrate. An appropriate step size is usually around the size of each cell.

◆ SetUseAsynchronousCommunication()

void vtkm::filter::flow::FilterParticleAdvection::SetUseAsynchronousCommunication ( )

inline

◆ SetUseSynchronousCommunication()

void vtkm::filter::flow::FilterParticleAdvection::SetUseSynchronousCommunication ( )

inline

◆ SetUseThreadedAlgorithm()

void vtkm::filter::flow::FilterParticleAdvection::SetUseThreadedAlgorithm ( bool val )

inline

◆ ValidateOptions()

virtual void vtkm::filter::flow::FilterParticleAdvection::ValidateOptions ( ) const

protectedvirtual

Member Data Documentation

◆ BlockIds

std::vector<vtkm::Id> vtkm::filter::flow::FilterParticleAdvection::BlockIds

protected

◆ BlockIdsSet

bool vtkm::filter::flow::FilterParticleAdvection::BlockIdsSet = false

protected

◆ NumberOfSteps

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

protected

◆ Seeds

vtkm::cont::UnknownArrayHandle vtkm::filter::flow::FilterParticleAdvection::Seeds

protected

◆ SolverType

vtkm::filter::flow::IntegrationSolverType vtkm::filter::flow::FilterParticleAdvection::SolverType

protected

Initial value:

=

vtkm::filter::flow::IntegrationSolverType::RK4_TYPE

◆ StepSize

vtkm::FloatDefault vtkm::filter::flow::FilterParticleAdvection::StepSize = 0

protected

◆ UseAsynchronousCommunication

bool vtkm::filter::flow::FilterParticleAdvection::UseAsynchronousCommunication = true

protected

◆ UseThreadedAlgorithm

bool vtkm::filter::flow::FilterParticleAdvection::UseThreadedAlgorithm = false

protected

◆ VecFieldType

vtkm::filter::flow::VectorFieldType vtkm::filter::flow::FilterParticleAdvection::VecFieldType

protected

Initial value:

=

vtkm::filter::flow::VectorFieldType::VELOCITY_FIELD_TYPE

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

FilterParticleAdvection.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ CanThread()

◆ DoExecute()

◆ GetUseAsynchronousCommunication()

◆ GetUseSynchronousCommunication()

◆ GetUseThreadedAlgorithm()

◆ SetBlockIDs()

◆ SetNumberOfSteps()

◆ SetSeeds() [1/2]

◆ SetSeeds() [2/2]

◆ SetSolverEuler()

◆ SetSolverRK4()

◆ SetStepSize()

◆ SetUseAsynchronousCommunication()

◆ SetUseSynchronousCommunication()

◆ SetUseThreadedAlgorithm()

◆ ValidateOptions()

Member Data Documentation

◆ BlockIds

◆ BlockIdsSet

◆ NumberOfSteps

◆ Seeds

◆ SolverType

◆ StepSize

◆ UseAsynchronousCommunication

◆ UseThreadedAlgorithm

◆ VecFieldType