#include <DotProduct.h>

Inheritance diagram for vtkm::filter::vector_analysis::DotProduct:

Public Member Functions
VTKM_CONT	DotProduct ()


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

const VTKM_CONT std::string &	GetPrimaryFieldName () const

VTKM_CONT vtkm::cont::Field::Association	GetPrimaryFieldAssociation () const


VTKM_CONT void	SetUseCoordinateSystemAsPrimaryField (bool flag)

VTKM_CONT bool	GetUseCoordinateSystemAsPrimaryField () const


VTKM_CONT void	SetPrimaryCoordinateSystem (vtkm::Id coord_idx)

VTKM_CONT vtkm::Id	GetPrimaryCoordinateSystemIndex () const


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

const VTKM_CONT std::string &	GetSecondaryFieldName () const

VTKM_CONT vtkm::cont::Field::Association	GetSecondaryFieldAssociation () const


VTKM_CONT void	SetUseCoordinateSystemAsSecondaryField (bool flag)

VTKM_CONT bool	GetUseCoordinateSystemAsSecondaryField () const


VTKM_CONT void	SetSecondaryCoordinateSystem (vtkm::Id index)

VTKM_CONT vtkm::Id	GetSecondaryCoordinateSystemIndex () const

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 ()

virtual VTKM_CONT bool	CanThread () const

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::DataSet	DoExecute (const vtkm::cont::DataSet &input) override

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

Constructor & Destructor Documentation

◆ DotProduct()

VTKM_CONT vtkm::filter::vector_analysis::DotProduct::DotProduct ( )

Member Function Documentation

◆ DoExecute()

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

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ GetPrimaryCoordinateSystemIndex()

VTKM_CONT vtkm::Id vtkm::filter::vector_analysis::DotProduct::GetPrimaryCoordinateSystemIndex ( ) const

inline

Select the coordinate system coord_idx to use as the primary field. This only has an effect when UseCoordinateSystemAsPrimaryField is true.

◆ GetPrimaryFieldAssociation()

VTKM_CONT vtkm::cont::Field::Association vtkm::filter::vector_analysis::DotProduct::GetPrimaryFieldAssociation ( ) const

inline

Choose the primary field to operate on. In the dot product operation A . B, A is the primary field.

◆ GetPrimaryFieldName()

const VTKM_CONT std::string& vtkm::filter::vector_analysis::DotProduct::GetPrimaryFieldName ( ) const

inline

Choose the primary field to operate on. In the dot product operation A . B, A is the primary field.

◆ GetSecondaryCoordinateSystemIndex()

VTKM_CONT vtkm::Id vtkm::filter::vector_analysis::DotProduct::GetSecondaryCoordinateSystemIndex ( ) const

inline

Select the coordinate system index to use as the secondary field. This only has an effect when UseCoordinateSystemAsSecondaryField is true.

◆ GetSecondaryFieldAssociation()

VTKM_CONT vtkm::cont::Field::Association vtkm::filter::vector_analysis::DotProduct::GetSecondaryFieldAssociation ( ) const

inline

Choose the secondary field to operate on. In the dot product operation A . B, B is the secondary field.

◆ GetSecondaryFieldName()

const VTKM_CONT std::string& vtkm::filter::vector_analysis::DotProduct::GetSecondaryFieldName ( ) const

inline

Choose the secondary field to operate on. In the dot product operation A . B, B is the secondary field.

◆ GetUseCoordinateSystemAsPrimaryField()

VTKM_CONT bool vtkm::filter::vector_analysis::DotProduct::GetUseCoordinateSystemAsPrimaryField ( ) const

inline

When set to true, uses a coordinate system as the primary field instead of the one selected by name. Use SetPrimaryCoordinateSystem to select which coordinate system.

◆ GetUseCoordinateSystemAsSecondaryField()

VTKM_CONT bool vtkm::filter::vector_analysis::DotProduct::GetUseCoordinateSystemAsSecondaryField ( ) const

inline

When set to true, uses a coordinate system as the secondary field instead of the one selected by name. Use SetSecondaryCoordinateSystem to select which coordinate system.

◆ SetPrimaryCoordinateSystem()

VTKM_CONT void vtkm::filter::vector_analysis::DotProduct::SetPrimaryCoordinateSystem ( vtkm::Id coord_idx )

inline

Select the coordinate system coord_idx to use as the primary field. This only has an effect when UseCoordinateSystemAsPrimaryField is true.

◆ SetPrimaryField()

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

inline

Choose the primary field to operate on. In the dot product operation A . B, A is the primary field.

◆ SetSecondaryCoordinateSystem()

VTKM_CONT void vtkm::filter::vector_analysis::DotProduct::SetSecondaryCoordinateSystem ( vtkm::Id index )

inline

Select the coordinate system index to use as the secondary field. This only has an effect when UseCoordinateSystemAsSecondaryField is true.

◆ SetSecondaryField()

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

inline

Choose the secondary field to operate on. In the dot product operation A . B, B is the secondary field.

◆ SetUseCoordinateSystemAsPrimaryField()

VTKM_CONT void vtkm::filter::vector_analysis::DotProduct::SetUseCoordinateSystemAsPrimaryField ( bool flag )

inline

When set to true, uses a coordinate system as the primary field instead of the one selected by name. Use SetPrimaryCoordinateSystem to select which coordinate system.

◆ SetUseCoordinateSystemAsSecondaryField()

VTKM_CONT void vtkm::filter::vector_analysis::DotProduct::SetUseCoordinateSystemAsSecondaryField ( bool flag )

inline

When set to true, uses a coordinate system as the secondary field instead of the one selected by name. Use SetSecondaryCoordinateSystem to select which coordinate system.

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

DotProduct.h

Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ DotProduct()

Member Function Documentation

◆ DoExecute()

◆ GetPrimaryCoordinateSystemIndex()

◆ GetPrimaryFieldAssociation()

◆ GetPrimaryFieldName()

◆ GetSecondaryCoordinateSystemIndex()

◆ GetSecondaryFieldAssociation()

◆ GetSecondaryFieldName()

◆ GetUseCoordinateSystemAsPrimaryField()

◆ GetUseCoordinateSystemAsSecondaryField()

◆ SetPrimaryCoordinateSystem()

◆ SetPrimaryField()

◆ SetSecondaryCoordinateSystem()

◆ SetSecondaryField()

◆ SetUseCoordinateSystemAsPrimaryField()

◆ SetUseCoordinateSystemAsSecondaryField()