Extract a subset of geometry based on an implicit function. More...

#include <ExtractGeometry.h>

Inheritance diagram for vtkm::filter::entity_extraction::ExtractGeometry:

Public Member Functions
void	SetImplicitFunction (const vtkm::ImplicitFunctionGeneral &func)

const vtkm::ImplicitFunctionGeneral &	GetImplicitFunction () const

VTKM_CONT bool	GetExtractInside () const

VTKM_CONT void	SetExtractInside (bool value)

VTKM_CONT void	ExtractInsideOn ()

VTKM_CONT void	ExtractInsideOff ()

VTKM_CONT bool	GetExtractBoundaryCells () const

VTKM_CONT void	SetExtractBoundaryCells (bool value)

VTKM_CONT void	ExtractBoundaryCellsOn ()

VTKM_CONT void	ExtractBoundaryCellsOff ()

VTKM_CONT bool	GetExtractOnlyBoundaryCells () const

VTKM_CONT void	SetExtractOnlyBoundaryCells (bool value)

VTKM_CONT void	ExtractOnlyBoundaryCellsOn ()

VTKM_CONT void	ExtractOnlyBoundaryCellsOff ()

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

Private Attributes
bool	ExtractInside = true

bool	ExtractBoundaryCells = false

bool	ExtractOnlyBoundaryCells = false

vtkm::ImplicitFunctionGeneral	Function

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 a subset of geometry based on an implicit function.

Extracts from its input geometry all cells that are either completely inside or outside of a specified implicit function. Any type of data can be input to this filter.

To use this filter you must specify an implicit function. You must also specify whether to extract cells laying inside or outside of the implicit function. (The inside of an implicit function is the negative values region.) An option exists to extract cells that are neither inside or outside (i.e., boundary).

This differs from Clip in that Clip will subdivide boundary cells into new cells, while this filter will not, producing a more 'crinkly' output.

Member Function Documentation

◆ DoExecute()

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

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ ExtractBoundaryCellsOff()

VTKM_CONT void vtkm::filter::entity_extraction::ExtractGeometry::ExtractBoundaryCellsOff ( )

inline

◆ ExtractBoundaryCellsOn()

VTKM_CONT void vtkm::filter::entity_extraction::ExtractGeometry::ExtractBoundaryCellsOn ( )

inline

◆ ExtractInsideOff()

VTKM_CONT void vtkm::filter::entity_extraction::ExtractGeometry::ExtractInsideOff ( )

inline

◆ ExtractInsideOn()

VTKM_CONT void vtkm::filter::entity_extraction::ExtractGeometry::ExtractInsideOn ( )

inline

◆ ExtractOnlyBoundaryCellsOff()

VTKM_CONT void vtkm::filter::entity_extraction::ExtractGeometry::ExtractOnlyBoundaryCellsOff ( )

inline

◆ ExtractOnlyBoundaryCellsOn()

VTKM_CONT void vtkm::filter::entity_extraction::ExtractGeometry::ExtractOnlyBoundaryCellsOn ( )

inline

◆ GetExtractBoundaryCells()

VTKM_CONT bool vtkm::filter::entity_extraction::ExtractGeometry::GetExtractBoundaryCells ( ) const

inline

◆ GetExtractInside()

VTKM_CONT bool vtkm::filter::entity_extraction::ExtractGeometry::GetExtractInside ( ) const

inline

◆ GetExtractOnlyBoundaryCells()

VTKM_CONT bool vtkm::filter::entity_extraction::ExtractGeometry::GetExtractOnlyBoundaryCells ( ) const

inline

◆ GetImplicitFunction()

const vtkm::ImplicitFunctionGeneral& vtkm::filter::entity_extraction::ExtractGeometry::GetImplicitFunction ( ) const

inline

◆ SetExtractBoundaryCells()

VTKM_CONT void vtkm::filter::entity_extraction::ExtractGeometry::SetExtractBoundaryCells ( bool value )

inline

◆ SetExtractInside()

VTKM_CONT void vtkm::filter::entity_extraction::ExtractGeometry::SetExtractInside ( bool value )

inline

◆ SetExtractOnlyBoundaryCells()

VTKM_CONT void vtkm::filter::entity_extraction::ExtractGeometry::SetExtractOnlyBoundaryCells ( bool value )

inline

◆ SetImplicitFunction()

void vtkm::filter::entity_extraction::ExtractGeometry::SetImplicitFunction ( const vtkm::ImplicitFunctionGeneral & func )

inline

Member Data Documentation

◆ ExtractBoundaryCells

bool vtkm::filter::entity_extraction::ExtractGeometry::ExtractBoundaryCells = false

private

◆ ExtractInside

bool vtkm::filter::entity_extraction::ExtractGeometry::ExtractInside = true

private

◆ ExtractOnlyBoundaryCells

bool vtkm::filter::entity_extraction::ExtractGeometry::ExtractOnlyBoundaryCells = false

private

◆ Function

vtkm::ImplicitFunctionGeneral vtkm::filter::entity_extraction::ExtractGeometry::Function

private

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

ExtractGeometry.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DoExecute()

◆ ExtractBoundaryCellsOff()

◆ ExtractBoundaryCellsOn()

◆ ExtractInsideOff()

◆ ExtractInsideOn()

◆ ExtractOnlyBoundaryCellsOff()

◆ ExtractOnlyBoundaryCellsOn()

◆ GetExtractBoundaryCells()

◆ GetExtractInside()

◆ GetExtractOnlyBoundaryCells()

◆ GetImplicitFunction()

◆ SetExtractBoundaryCells()

◆ SetExtractInside()

◆ SetExtractOnlyBoundaryCells()

◆ SetImplicitFunction()

Member Data Documentation

◆ ExtractBoundaryCells

◆ ExtractInside

◆ ExtractOnlyBoundaryCells

◆ Function