VTK-m  2.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
vtkm::filter::flow::Lagrangian Class Reference

#include <Lagrangian.h>

Inheritance diagram for vtkm::filter::flow::Lagrangian:
vtkm::filter::FilterField vtkm::filter::Filter

Public Member Functions

VTKM_CONT bool CanThread () const override
 
VTKM_CONT void SetInitFlag (bool val)
 
VTKM_CONT void SetExtractFlows (bool val)
 
VTKM_CONT void SetResetParticles (bool val)
 
VTKM_CONT void SetStepSize (vtkm::Float32 val)
 
VTKM_CONT void SetWriteFrequency (vtkm::Id val)
 
VTKM_CONT void SetSeedResolutionInX (vtkm::Id val)
 
VTKM_CONT void SetSeedResolutionInY (vtkm::Id val)
 
VTKM_CONT void SetSeedResolutionInZ (vtkm::Id val)
 
VTKM_CONT void SetCustomSeedResolution (vtkm::Id val)
 
VTKM_CONT void SetSeedingResolution (vtkm::Id3 val)
 
VTKM_CONT void UpdateSeedResolution (vtkm::cont::DataSet input)
 
VTKM_CONT void InitializeSeedPositions (const vtkm::cont::DataSet &input)
 
VTKM_CONT void SetCycle (vtkm::Id cycle)
 
VTKM_CONT vtkm::Id GetCycle () const
 
VTKM_CONT void SetBasisParticles (const vtkm::cont::ArrayHandle< vtkm::Particle > &basisParticles)
 
VTKM_CONT vtkm::cont::ArrayHandle< vtkm::ParticleGetBasisParticles () const
 
VTKM_CONT void SetBasisParticlesOriginal (const vtkm::cont::ArrayHandle< vtkm::Particle > &basisParticles)
 
VTKM_CONT vtkm::cont::ArrayHandle< vtkm::ParticleGetBasisParticlesOriginal () const
 
VTKM_CONT void SetBasisParticleValidity (const vtkm::cont::ArrayHandle< vtkm::Id > &valid)
 
VTKM_CONT vtkm::cont::ArrayHandle< vtkm::IdGetBasisParticleValidity () 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 ()
 
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::FieldSelectionGetFieldsToPass () const
 Specify which fields get passed from input to output. More...
 
VTKM_CONT vtkm::filter::FieldSelectionGetFieldsToPass ()
 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 &inData) override
 

Private Attributes

vtkm::cont::ArrayHandle< vtkm::ParticleBasisParticles
 
vtkm::cont::ArrayHandle< vtkm::ParticleBasisParticlesOriginal
 
vtkm::cont::ArrayHandle< vtkm::IdBasisParticlesValidity
 
vtkm::Id CustRes = 0
 
vtkm::Id Cycle = 0
 
bool ExtractFlows = false
 
bool InitFlag = true
 
bool ResetParticles = true
 
vtkm::Id ResX = 1
 
vtkm::Id ResY = 1
 
vtkm::Id ResZ = 1
 
vtkm::FloatDefault StepSize
 
vtkm::Id3 SeedRes = { 1, 1, 1 }
 
vtkm::Id WriteFrequency = 0
 

Additional Inherited Members

- Protected Member Functions inherited from vtkm::filter::FilterField
const VTKM_CONT vtkm::cont::FieldGetFieldFromDataSet (const vtkm::cont::DataSet &input) const
 
const VTKM_CONT vtkm::cont::FieldGetFieldFromDataSet (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
 

Member Function Documentation

◆ CanThread()

VTKM_CONT bool vtkm::filter::flow::Lagrangian::CanThread ( ) const
inlineoverridevirtual

Reimplemented from vtkm::filter::Filter.

◆ DoExecute()

VTKM_CONT vtkm::cont::DataSet vtkm::filter::flow::Lagrangian::DoExecute ( const vtkm::cont::DataSet inData)
overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ GetBasisParticles()

VTKM_CONT vtkm::cont::ArrayHandle<vtkm::Particle> vtkm::filter::flow::Lagrangian::GetBasisParticles ( ) const
inline

◆ GetBasisParticlesOriginal()

VTKM_CONT vtkm::cont::ArrayHandle<vtkm::Particle> vtkm::filter::flow::Lagrangian::GetBasisParticlesOriginal ( ) const
inline

◆ GetBasisParticleValidity()

VTKM_CONT vtkm::cont::ArrayHandle<vtkm::Id> vtkm::filter::flow::Lagrangian::GetBasisParticleValidity ( ) const
inline

◆ GetCycle()

VTKM_CONT vtkm::Id vtkm::filter::flow::Lagrangian::GetCycle ( ) const
inline

◆ InitializeSeedPositions()

VTKM_CONT void vtkm::filter::flow::Lagrangian::InitializeSeedPositions ( const vtkm::cont::DataSet input)

◆ SetBasisParticles()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetBasisParticles ( const vtkm::cont::ArrayHandle< vtkm::Particle > &  basisParticles)
inline

◆ SetBasisParticlesOriginal()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetBasisParticlesOriginal ( const vtkm::cont::ArrayHandle< vtkm::Particle > &  basisParticles)
inline

◆ SetBasisParticleValidity()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetBasisParticleValidity ( const vtkm::cont::ArrayHandle< vtkm::Id > &  valid)
inline

◆ SetCustomSeedResolution()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetCustomSeedResolution ( vtkm::Id  val)
inline

◆ SetCycle()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetCycle ( vtkm::Id  cycle)
inline

◆ SetExtractFlows()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetExtractFlows ( bool  val)
inline

◆ SetInitFlag()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetInitFlag ( bool  val)
inline

◆ SetResetParticles()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetResetParticles ( bool  val)
inline

◆ SetSeedingResolution()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetSeedingResolution ( vtkm::Id3  val)
inline

◆ SetSeedResolutionInX()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetSeedResolutionInX ( vtkm::Id  val)
inline

◆ SetSeedResolutionInY()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetSeedResolutionInY ( vtkm::Id  val)
inline

◆ SetSeedResolutionInZ()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetSeedResolutionInZ ( vtkm::Id  val)
inline

◆ SetStepSize()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetStepSize ( vtkm::Float32  val)
inline

◆ SetWriteFrequency()

VTKM_CONT void vtkm::filter::flow::Lagrangian::SetWriteFrequency ( vtkm::Id  val)
inline

◆ UpdateSeedResolution()

VTKM_CONT void vtkm::filter::flow::Lagrangian::UpdateSeedResolution ( vtkm::cont::DataSet  input)

Member Data Documentation

◆ BasisParticles

vtkm::cont::ArrayHandle<vtkm::Particle> vtkm::filter::flow::Lagrangian::BasisParticles
private

◆ BasisParticlesOriginal

vtkm::cont::ArrayHandle<vtkm::Particle> vtkm::filter::flow::Lagrangian::BasisParticlesOriginal
private

◆ BasisParticlesValidity

vtkm::cont::ArrayHandle<vtkm::Id> vtkm::filter::flow::Lagrangian::BasisParticlesValidity
private

◆ CustRes

vtkm::Id vtkm::filter::flow::Lagrangian::CustRes = 0
private

◆ Cycle

vtkm::Id vtkm::filter::flow::Lagrangian::Cycle = 0
private

◆ ExtractFlows

bool vtkm::filter::flow::Lagrangian::ExtractFlows = false
private

◆ InitFlag

bool vtkm::filter::flow::Lagrangian::InitFlag = true
private

◆ ResetParticles

bool vtkm::filter::flow::Lagrangian::ResetParticles = true
private

◆ ResX

vtkm::Id vtkm::filter::flow::Lagrangian::ResX = 1
private

◆ ResY

vtkm::Id vtkm::filter::flow::Lagrangian::ResY = 1
private

◆ ResZ

vtkm::Id vtkm::filter::flow::Lagrangian::ResZ = 1
private

◆ SeedRes

vtkm::Id3 vtkm::filter::flow::Lagrangian::SeedRes = { 1, 1, 1 }
private

◆ StepSize

vtkm::FloatDefault vtkm::filter::flow::Lagrangian::StepSize
private

◆ WriteFrequency

vtkm::Id vtkm::filter::flow::Lagrangian::WriteFrequency = 0
private

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