Compute the cross product of 3D vector fields. More...

#include <CrossProduct.h>

Inheritance diagram for vtkm::filter::vector_analysis::CrossProduct:

Public Member Functions
	CrossProduct ()

void	SetPrimaryField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)
	Specify the primary field to operate on. More...

const std::string &	GetPrimaryFieldName () const
	Specify the primary field to operate on. More...

vtkm::cont::Field::Association	GetPrimaryFieldAssociation () const
	Specify the primary field to operate on. More...

void	SetUseCoordinateSystemAsPrimaryField (bool flag)
	Specify the primary field to operate on. More...

bool	GetUseCoordinateSystemAsPrimaryField () const
	Specify the primary field to operate on. More...

void	SetPrimaryCoordinateSystem (vtkm::Id index)
	Specify the primary field to operate on. More...

vtkm::Id	GetPrimaryCoordinateSystemIndex () const

void	SetSecondaryField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)
	Specify the secondary field to operate on. More...

const std::string &	GetSecondaryFieldName () const
	Specify the secondary field to operate on. More...

vtkm::cont::Field::Association	GetSecondaryFieldAssociation () const
	Specify the secondary field to operate on. More...

void	SetUseCoordinateSystemAsSecondaryField (bool flag)
	Specify the secondary field to operate on. More...

bool	GetUseCoordinateSystemAsSecondaryField () const
	Specify the secondary field to operate on. More...

void	SetSecondaryCoordinateSystem (vtkm::Id index)
	Specify the secondary field to operate on. More...

vtkm::Id	GetSecondaryCoordinateSystemIndex () const
	Specify the secondary field to operate on. More...

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

virtual bool	CanThread () const
	Returns whether the filter can execute on partitions in concurrent threads. 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...

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

Additional Inherited Members
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 inherited from vtkm::filter::Filter
vtkm::cont::Invoker	Invoke

Detailed Description

Compute the cross product of 3D vector fields.

The left part of the operand is the "primary" field and the right part of the operand is the "secondary" field.

Constructor & Destructor Documentation

◆ CrossProduct()

vtkm::filter::vector_analysis::CrossProduct::CrossProduct ( )

Member Function Documentation

◆ DoExecute()

vtkm::cont::DataSet vtkm::filter::vector_analysis::CrossProduct::DoExecute ( const vtkm::cont::DataSet & input )

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ GetPrimaryCoordinateSystemIndex()

vtkm::Id vtkm::filter::vector_analysis::CrossProduct::GetPrimaryCoordinateSystemIndex ( ) const

inline

◆ GetPrimaryFieldAssociation()

vtkm::cont::Field::Association vtkm::filter::vector_analysis::CrossProduct::GetPrimaryFieldAssociation ( ) const

inline

Specify the primary field to operate on.

In the cross product operation A x B, A is the primary field.

The primary field is an alias for active field index 0. As with any active field, it can be set as a named field or as a coordinate system.

◆ GetPrimaryFieldName()

const std::string& vtkm::filter::vector_analysis::CrossProduct::GetPrimaryFieldName ( ) const

inline

Specify the primary field to operate on.

In the cross product operation A x B, A is the primary field.

The primary field is an alias for active field index 0. As with any active field, it can be set as a named field or as a coordinate system.

◆ GetSecondaryCoordinateSystemIndex()

vtkm::Id vtkm::filter::vector_analysis::CrossProduct::GetSecondaryCoordinateSystemIndex ( ) const

inline

Specify the secondary field to operate on.

In the cross product operation A x B, B is the secondary field.

The secondary field is an alias for the active field index 1. As with any active field, it can be set as a named field or as a coordinate system.

◆ GetSecondaryFieldAssociation()

vtkm::cont::Field::Association vtkm::filter::vector_analysis::CrossProduct::GetSecondaryFieldAssociation ( ) const

inline

Specify the secondary field to operate on.

In the cross product operation A x B, B is the secondary field.

The secondary field is an alias for the active field index 1. As with any active field, it can be set as a named field or as a coordinate system.

◆ GetSecondaryFieldName()

const std::string& vtkm::filter::vector_analysis::CrossProduct::GetSecondaryFieldName ( ) const

inline

Specify the secondary field to operate on.

In the cross product operation A x B, B is the secondary field.

The secondary field is an alias for the active field index 1. As with any active field, it can be set as a named field or as a coordinate system.

◆ GetUseCoordinateSystemAsPrimaryField()

bool vtkm::filter::vector_analysis::CrossProduct::GetUseCoordinateSystemAsPrimaryField ( ) const

inline

Specify the primary field to operate on.

In the cross product operation A x B, A is the primary field.

The primary field is an alias for active field index 0. As with any active field, it can be set as a named field or as a coordinate system.

◆ GetUseCoordinateSystemAsSecondaryField()

bool vtkm::filter::vector_analysis::CrossProduct::GetUseCoordinateSystemAsSecondaryField ( ) const

inline

Specify the secondary field to operate on.

In the cross product operation A x B, B is the secondary field.

The secondary field is an alias for the active field index 1. As with any active field, it can be set as a named field or as a coordinate system.

◆ SetPrimaryCoordinateSystem()

void vtkm::filter::vector_analysis::CrossProduct::SetPrimaryCoordinateSystem ( vtkm::Id index )

inline

Specify the primary field to operate on.

In the cross product operation A x B, A is the primary field.

The primary field is an alias for active field index 0. As with any active field, it can be set as a named field or as a coordinate system.

◆ SetPrimaryField()

void vtkm::filter::vector_analysis::CrossProduct::SetPrimaryField	(	const std::string &	name,
		vtkm::cont::Field::Association	association = `vtkm::cont::Field::Association::Any`
	)

inline

Specify the primary field to operate on.

In the cross product operation A x B, A is the primary field.

The primary field is an alias for active field index 0. As with any active field, it can be set as a named field or as a coordinate system.

◆ SetSecondaryCoordinateSystem()

void vtkm::filter::vector_analysis::CrossProduct::SetSecondaryCoordinateSystem ( vtkm::Id index )

inline

Specify the secondary field to operate on.

In the cross product operation A x B, B is the secondary field.

The secondary field is an alias for the active field index 1. As with any active field, it can be set as a named field or as a coordinate system.

◆ SetSecondaryField()

void vtkm::filter::vector_analysis::CrossProduct::SetSecondaryField	(	const std::string &	name,
		vtkm::cont::Field::Association	association = `vtkm::cont::Field::Association::Any`
	)

inline

Specify the secondary field to operate on.

In the cross product operation A x B, B is the secondary field.

The secondary field is an alias for the active field index 1. As with any active field, it can be set as a named field or as a coordinate system.

◆ SetUseCoordinateSystemAsPrimaryField()

void vtkm::filter::vector_analysis::CrossProduct::SetUseCoordinateSystemAsPrimaryField ( bool flag )

inline

Specify the primary field to operate on.

In the cross product operation A x B, A is the primary field.

The primary field is an alias for active field index 0. As with any active field, it can be set as a named field or as a coordinate system.

◆ SetUseCoordinateSystemAsSecondaryField()

void vtkm::filter::vector_analysis::CrossProduct::SetUseCoordinateSystemAsSecondaryField ( bool flag )

inline

Specify the secondary field to operate on.

In the cross product operation A x B, B is the secondary field.

The secondary field is an alias for the active field index 1. As with any active field, it can be set as a named field or as a coordinate system.

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

CrossProduct.h

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CrossProduct()

Member Function Documentation

◆ DoExecute()

◆ GetPrimaryCoordinateSystemIndex()

◆ GetPrimaryFieldAssociation()

◆ GetPrimaryFieldName()

◆ GetSecondaryCoordinateSystemIndex()

◆ GetSecondaryFieldAssociation()

◆ GetSecondaryFieldName()

◆ GetUseCoordinateSystemAsPrimaryField()

◆ GetUseCoordinateSystemAsSecondaryField()

◆ SetPrimaryCoordinateSystem()

◆ SetPrimaryField()

◆ SetSecondaryCoordinateSystem()

◆ SetSecondaryField()

◆ SetUseCoordinateSystemAsPrimaryField()

◆ SetUseCoordinateSystemAsSecondaryField()