Extract external faces of a geometry. More...

#include <ExternalFaces.h>

Inheritance diagram for vtkm::filter::entity_extraction::ExternalFaces:

Public Member Functions
	ExternalFaces ()

	~ExternalFaces () override

bool	CanThread () const override

VTKM_CONT bool	GetCompactPoints () const

VTKM_CONT void	SetCompactPoints (bool value)

VTKM_CONT bool	GetPassPolyData () const

VTKM_CONT void	SetPassPolyData (bool value)

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 &input) override

vtkm::cont::DataSet	GenerateOutput (const vtkm::cont::DataSet &input, vtkm::cont::CellSetExplicit<> &outCellSet)

VTKM_CONT bool	MapFieldOntoOutput (vtkm::cont::DataSet &result, const vtkm::cont::Field &field)

Private Attributes
bool	CompactPoints = false

bool	PassPolyData = true

std::unique_ptr< vtkm::worklet::ExternalFaces >	Worklet

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

Detailed Description

Extract external faces of a geometry.

ExternalFaces is a filter that extracts all external faces from a data set. An external face is defined is defined as a face/side of a cell that belongs only to one cell in the entire mesh.

Warning: This filter is currently only supports propagation of point properties

Constructor & Destructor Documentation

◆ ExternalFaces()

vtkm::filter::entity_extraction::ExternalFaces::ExternalFaces ( )

◆ ~ExternalFaces()

vtkm::filter::entity_extraction::ExternalFaces::~ExternalFaces ( )

override

Member Function Documentation

◆ CanThread()

bool vtkm::filter::entity_extraction::ExternalFaces::CanThread ( ) const

inlineoverridevirtual

Reimplemented from vtkm::filter::Filter.

◆ DoExecute()

VTKM_CONT vtkm::cont::DataSet vtkm::filter::entity_extraction::ExternalFaces::DoExecute ( const vtkm::cont::DataSet & input )

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ GenerateOutput()

vtkm::cont::DataSet vtkm::filter::entity_extraction::ExternalFaces::GenerateOutput	(	const vtkm::cont::DataSet &	input,
		vtkm::cont::CellSetExplicit<> &	outCellSet
	)

private

◆ GetCompactPoints()

VTKM_CONT bool vtkm::filter::entity_extraction::ExternalFaces::GetCompactPoints ( ) const

inline

◆ GetPassPolyData()

VTKM_CONT bool vtkm::filter::entity_extraction::ExternalFaces::GetPassPolyData ( ) const

inline

◆ MapFieldOntoOutput()

VTKM_CONT bool vtkm::filter::entity_extraction::ExternalFaces::MapFieldOntoOutput	(	vtkm::cont::DataSet &	result,
		const vtkm::cont::Field &	field
	)

private

◆ SetCompactPoints()

VTKM_CONT void vtkm::filter::entity_extraction::ExternalFaces::SetCompactPoints ( bool value )

inline

◆ SetPassPolyData()

VTKM_CONT void vtkm::filter::entity_extraction::ExternalFaces::SetPassPolyData ( bool value )

Member Data Documentation

◆ CompactPoints

bool vtkm::filter::entity_extraction::ExternalFaces::CompactPoints = false

private

◆ PassPolyData

bool vtkm::filter::entity_extraction::ExternalFaces::PassPolyData = true

private

◆ Worklet

std::unique_ptr<vtkm::worklet::ExternalFaces> vtkm::filter::entity_extraction::ExternalFaces::Worklet

private

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

ExternalFaces.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExternalFaces()

◆ ~ExternalFaces()

Member Function Documentation

◆ CanThread()

◆ DoExecute()

◆ GenerateOutput()

◆ GetCompactPoints()

◆ GetPassPolyData()

◆ MapFieldOntoOutput()

◆ SetCompactPoints()

◆ SetPassPolyData()

Member Data Documentation

◆ CompactPoints

◆ PassPolyData

◆ Worklet