VTK-m  2.0
Classes | Public Types | Public Member Functions | Public Attributes | Private Attributes | List of all members
vtkm::worklet::GradientOutputFields< T > Struct Template Reference

#include <Gradient.h>

Classes

struct  ExecutionTypes
 

Public Types

using ValueType = T
 
using BaseTType = typename vtkm::VecTraits< T >::BaseComponentType
 

Public Member Functions

 GradientOutputFields ()
 
 GradientOutputFields (bool store, bool divergence, bool vorticity, bool qc)
 
void SetComputeDivergence (bool enable)
 Add divergence field to the output data. More...
 
bool GetComputeDivergence () const
 
void SetComputeVorticity (bool enable)
 Add voriticity/curl field to the output data. More...
 
bool GetComputeVorticity () const
 
void SetComputeQCriterion (bool enable)
 Add Q-criterion field to the output data. More...
 
bool GetComputeQCriterion () const
 
void SetComputeGradient (bool enable)
 Add gradient field to the output data. More...
 
bool GetComputeGradient () const
 
vtkm::exec::GradientOutput< T > PrepareForOutput (vtkm::Id size)
 

Public Attributes

vtkm::cont::ArrayHandle< vtkm::Vec< T, 3 > > Gradient
 
vtkm::cont::ArrayHandle< BaseTTypeDivergence
 
vtkm::cont::ArrayHandle< vtkm::Vec< BaseTType, 3 > > Vorticity
 
vtkm::cont::ArrayHandle< BaseTTypeQCriterion
 

Private Attributes

bool StoreGradient
 
bool ComputeDivergence
 
bool ComputeVorticity
 
bool ComputeQCriterion
 

Member Typedef Documentation

◆ BaseTType

template<typename T >
using vtkm::worklet::GradientOutputFields< T >::BaseTType = typename vtkm::VecTraits<T>::BaseComponentType

◆ ValueType

template<typename T >
using vtkm::worklet::GradientOutputFields< T >::ValueType = T

Constructor & Destructor Documentation

◆ GradientOutputFields() [1/2]

template<typename T >
vtkm::worklet::GradientOutputFields< T >::GradientOutputFields ( )
inline

◆ GradientOutputFields() [2/2]

template<typename T >
vtkm::worklet::GradientOutputFields< T >::GradientOutputFields ( bool  store,
bool  divergence,
bool  vorticity,
bool  qc 
)
inline

Member Function Documentation

◆ GetComputeDivergence()

template<typename T >
bool vtkm::worklet::GradientOutputFields< T >::GetComputeDivergence ( ) const
inline

◆ GetComputeGradient()

template<typename T >
bool vtkm::worklet::GradientOutputFields< T >::GetComputeGradient ( ) const
inline

◆ GetComputeQCriterion()

template<typename T >
bool vtkm::worklet::GradientOutputFields< T >::GetComputeQCriterion ( ) const
inline

◆ GetComputeVorticity()

template<typename T >
bool vtkm::worklet::GradientOutputFields< T >::GetComputeVorticity ( ) const
inline

◆ PrepareForOutput()

template<typename T >
vtkm::exec::GradientOutput<T> vtkm::worklet::GradientOutputFields< T >::PrepareForOutput ( vtkm::Id  size)
inline

◆ SetComputeDivergence()

template<typename T >
void vtkm::worklet::GradientOutputFields< T >::SetComputeDivergence ( bool  enable)
inline

Add divergence field to the output data.

The input array must have 3 components in order to compute this. The default is off.

◆ SetComputeGradient()

template<typename T >
void vtkm::worklet::GradientOutputFields< T >::SetComputeGradient ( bool  enable)
inline

Add gradient field to the output data.

The input array must have 3 components in order to disable this. The default is on.

◆ SetComputeQCriterion()

template<typename T >
void vtkm::worklet::GradientOutputFields< T >::SetComputeQCriterion ( bool  enable)
inline

Add Q-criterion field to the output data.

The input array must have 3 components in order to compute this. The default is off.

◆ SetComputeVorticity()

template<typename T >
void vtkm::worklet::GradientOutputFields< T >::SetComputeVorticity ( bool  enable)
inline

Add voriticity/curl field to the output data.

The input array must have 3 components in order to compute this. The default is off.

Member Data Documentation

◆ ComputeDivergence

template<typename T >
bool vtkm::worklet::GradientOutputFields< T >::ComputeDivergence
private

◆ ComputeQCriterion

template<typename T >
bool vtkm::worklet::GradientOutputFields< T >::ComputeQCriterion
private

◆ ComputeVorticity

template<typename T >
bool vtkm::worklet::GradientOutputFields< T >::ComputeVorticity
private

◆ Divergence

◆ Gradient

template<typename T >
vtkm::cont::ArrayHandle<vtkm::Vec<T, 3> > vtkm::worklet::GradientOutputFields< T >::Gradient

◆ QCriterion

◆ StoreGradient

template<typename T >
bool vtkm::worklet::GradientOutputFields< T >::StoreGradient
private

◆ Vorticity


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