VTK-m  2.2
Public Types | Public Member Functions | Private Attributes | List of all members
vtkm::ImplicitFunctionGradientFunctor< FunctionType > Class Template Reference

A helpful functor that calls the gradient method of a given ImplicitFunction. More...

#include <ImplicitFunction.h>

Public Types

using Scalar = typename FunctionType::Scalar
 
using Vector = typename FunctionType::Vector
 

Public Member Functions

 ImplicitFunctionGradientFunctor ()=default
 
 ImplicitFunctionGradientFunctor (const vtkm::internal::ImplicitFunctionBase< FunctionType > &function)
 
 ImplicitFunctionGradientFunctor (const FunctionType &function)
 
Vector operator() (const Vector &point) const
 

Private Attributes

FunctionType Function
 

Detailed Description

template<typename FunctionType>
class vtkm::ImplicitFunctionGradientFunctor< FunctionType >

A helpful functor that calls the gradient method of a given ImplicitFunction.

Can be passed to things that expect a functor instead of an ImplictFunction class (like an array transform).

Member Typedef Documentation

◆ Scalar

template<typename FunctionType >
using vtkm::ImplicitFunctionGradientFunctor< FunctionType >::Scalar = typename FunctionType::Scalar

◆ Vector

template<typename FunctionType >
using vtkm::ImplicitFunctionGradientFunctor< FunctionType >::Vector = typename FunctionType::Vector

Constructor & Destructor Documentation

◆ ImplicitFunctionGradientFunctor() [1/3]

template<typename FunctionType >
vtkm::ImplicitFunctionGradientFunctor< FunctionType >::ImplicitFunctionGradientFunctor ( )
default

◆ ImplicitFunctionGradientFunctor() [2/3]

template<typename FunctionType >
vtkm::ImplicitFunctionGradientFunctor< FunctionType >::ImplicitFunctionGradientFunctor ( const vtkm::internal::ImplicitFunctionBase< FunctionType > &  function)
inline

◆ ImplicitFunctionGradientFunctor() [3/3]

template<typename FunctionType >
vtkm::ImplicitFunctionGradientFunctor< FunctionType >::ImplicitFunctionGradientFunctor ( const FunctionType &  function)
inline

Member Function Documentation

◆ operator()()

template<typename FunctionType >
Vector vtkm::ImplicitFunctionGradientFunctor< FunctionType >::operator() ( const Vector point) const
inline

Member Data Documentation

◆ Function

template<typename FunctionType >
FunctionType vtkm::ImplicitFunctionGradientFunctor< FunctionType >::Function
private

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