a family of SPH interpolation kernels More...

#include <vtkSPHKernel.h>

Inheritance diagram for vtkSPHKernel:

Collaboration diagram for vtkSPHKernel:

Public Member Functions
void	Initialize (vtkAbstractPointLocator loc, vtkDataSet ds, vtkPointData *pd) override
	Produce the computational parameters for the kernel. More...

vtkIdType	ComputeBasis (double x[3], vtkIdList *pIds, vtkIdType ptId=0) override
	Given a point x (and optional associated ptId), determine the points around x which form an interpolation basis. More...

vtkIdType	ComputeWeights (double x[3], vtkIdList pIds, vtkDoubleArray weights) override
	Given a point x, and a list of basis points pIds, compute interpolation weights associated with these basis points. More...

virtual vtkIdType	ComputeDerivWeights (double x[3], vtkIdList pIds, vtkDoubleArray weights, vtkDoubleArray *gradWeights)
	Given a point x, and a list of basis points pIds, compute interpolation weights, plus derivative weights, associated with these basis points. More...

virtual double	ComputeFunctionWeight (const double d)=0
	Compute weighting factor given a normalized distance from a sample point. More...

virtual double	ComputeDerivWeight (const double d)=0
	Compute weighting factor for derivative quantities given a normalized distance from a sample point. More...


virtual void	SetSpatialStep (double)
	The user defined initial particle spatial step. More...

virtual double	GetSpatialStep ()
	The user defined initial particle spatial step. More...


virtual void	SetDimension (int)
	The domain dimension, default to 3. More...

virtual int	GetDimension ()
	The domain dimension, default to 3. More...


virtual double	GetCutoffFactor ()
	Return the cutoff factor. More...


virtual void	SetCutoffArray (vtkDataArray *)
	Specify the (optional) array defining a cutoff distance. More...

virtual vtkDataArray *	GetCutoffArray ()
	Specify the (optional) array defining a cutoff distance. More...


virtual void	SetDensityArray (vtkDataArray *)
	Specify the (optional) density array. More...

virtual vtkDataArray *	GetDensityArray ()
	Specify the (optional) density array. More...


virtual void	SetMassArray (vtkDataArray *)
	Specify the (optional) mass array. More...

virtual vtkDataArray *	GetMassArray ()
	Specify the (optional) mass array. More...


virtual double	GetNormFactor ()
	Return the SPH normalization factor. More...

Public Member Functions inherited from vtkInterpolationKernel
virtual void	Initialize (vtkAbstractPointLocator loc, vtkDataSet ds, vtkPointData *pd)
	Initialize the kernel. More...

virtual vtkIdType	ComputeBasis (double x[3], vtkIdList *pIds, vtkIdType ptId=0)=0
	Given a point x (and optional associated point id), determine the points around x which form an interpolation basis. More...

virtual vtkIdType	ComputeWeights (double x[3], vtkIdList pIds, vtkDoubleArray weights)=0
	Given a point x, and a list of basis points pIds, compute interpolation weights associated with these basis points. More...

	vtkAbstractTypeMacro (vtkInterpolationKernel, vtkObject)
	Standard method for type and printing. More...

virtual void	SetRequiresInitialization (bool)
	Indicate whether the kernel needs initialization. More...

virtual bool	GetRequiresInitialization ()
	Indicate whether the kernel needs initialization. More...

virtual void	RequiresInitializationOn ()
	Indicate whether the kernel needs initialization. More...

virtual void	RequiresInitializationOff ()
	Indicate whether the kernel needs initialization. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Protected Member Functions
	vtkSPHKernel ()

	~vtkSPHKernel () override

Protected Member Functions inherited from vtkInterpolationKernel
	vtkInterpolationKernel ()

	~vtkInterpolationKernel () override

virtual void	FreeStructures ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	SpatialStep

int	Dimension

vtkDataArray *	CutoffArray

vtkDataArray *	DensityArray

vtkDataArray *	MassArray

double	CutoffFactor

double	Cutoff

double	Sigma

double	DistNorm

double	NormFactor

double	DefaultVolume

bool	UseCutoffArray

bool	UseArraysForVolume

Protected Attributes inherited from vtkInterpolationKernel
bool	RequiresInitialization

vtkAbstractPointLocator *	Locator

vtkDataSet *	DataSet

vtkPointData *	PointData

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkInterpolationKernel	Superclass
	Standard methods for instantiation, obtaining type information, and printing. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiation, obtaining type information, and printing. More...

static vtkSPHKernel *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiation, obtaining type information, and printing. More...

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiation, obtaining type information, and printing. More...

vtkSPHKernel *	NewInstance () const
	Standard methods for instantiation, obtaining type information, and printing. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiation, obtaining type information, and printing. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiation, obtaining type information, and printing. More...

Additional Inherited Members
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

a family of SPH interpolation kernels

vtkSPHKernel is an abstract superclass for smoothed-particle hydrodynamics interpolation kernels as described by D.J. Price (see full reference below).

Note that the kernel operates over a volume in space defined by a radius at a sampling point. The kernel implicitly assumes that the particles making up the input data satisfies physical properties such as conservation of mass. Therefore subclasses of this kernel are not generally applicable for interpolation processes, and therefore operate in conjunction with the vthSPHInterpolator class.

By default the kernel computes local particle volume from the spatial step^3. However, if both an optional mass and density arrays are provided then they are used to compute local volume.

Also be default, the local neighborhood around a point to be interpolated is computed as the CutoffFactor * SpatialStep. (Note the CutoffFactor varies for each type of SPH kernel.) However, the user may specify a CutoffArray which enables variable cutoff distances per each point.

Warning: For more information see D.J. Price, Smoothed particle hydrodynamics and magnetohydrodynamics, J. Comput. Phys. 231:759-794, 2012. Especially equation 49.

Acknowledgments:: The following work has been generously supported by Altair Engineering and FluiDyna GmbH. Please contact Steve Cosgrove or Milos Stanic for more information.

See also: vtkSPHKernel vtkSPHQuinticKernel vtkInterpolationKernel vtkGaussianKernel vtkShepardKernel vtkLinearKernel

Definition at line 67 of file vtkSPHKernel.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInterpolationKernel vtkSPHKernel::Superclass

Standard methods for instantiation, obtaining type information, and printing.

Definition at line 74 of file vtkSPHKernel.h.

Constructor & Destructor Documentation

◆ vtkSPHKernel()

vtkSPHKernel::vtkSPHKernel ( )

protected

◆ ~vtkSPHKernel()

vtkSPHKernel::~vtkSPHKernel ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkSPHKernel::IsTypeOf ( const char * type )

static

Standard methods for instantiation, obtaining type information, and printing.

◆ IsA()

virtual vtkTypeBool vtkSPHKernel::IsA ( const char * type )

virtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkObjectBase.

Reimplemented in vtkSPHCubicKernel, vtkSPHQuarticKernel, vtkSPHQuinticKernel, and vtkWendlandQuinticKernel.

◆ SafeDownCast()

static vtkSPHKernel * vtkSPHKernel::SafeDownCast ( vtkObjectBase * o )

static

Standard methods for instantiation, obtaining type information, and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSPHKernel::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented in vtkSPHCubicKernel, vtkSPHQuarticKernel, vtkSPHQuinticKernel, and vtkWendlandQuinticKernel.

◆ NewInstance()

vtkSPHKernel * vtkSPHKernel::NewInstance ( ) const

Standard methods for instantiation, obtaining type information, and printing.

◆ PrintSelf()

void vtkSPHKernel::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkInterpolationKernel.

Reimplemented in vtkSPHQuarticKernel, vtkSPHQuinticKernel, and vtkWendlandQuinticKernel.

◆ SetSpatialStep()

virtual void vtkSPHKernel::SetSpatialStep ( double )

virtual

The user defined initial particle spatial step.

This is also referred to as the smoothing length.

◆ GetSpatialStep()

virtual double vtkSPHKernel::GetSpatialStep ( )

virtual

The user defined initial particle spatial step.

This is also referred to as the smoothing length.

◆ SetDimension()

virtual void vtkSPHKernel::SetDimension ( int )

virtual

The domain dimension, default to 3.

◆ GetDimension()

virtual int vtkSPHKernel::GetDimension ( )

virtual

The domain dimension, default to 3.

◆ GetCutoffFactor()

virtual double vtkSPHKernel::GetCutoffFactor ( )

virtual

Return the cutoff factor.

This is hard wired into the kernel (e.g., the vtkSPHQuinticKernel has a cutoff factor = 3.0).

◆ SetCutoffArray()

virtual void vtkSPHKernel::SetCutoffArray ( vtkDataArray * )

virtual

Specify the (optional) array defining a cutoff distance.

If provided this distance is used to find the interpolating points within the local neighborbood. Otherwise the cutoff distance is defined as the cutoff factor times the spatial step size.

◆ GetCutoffArray()

virtual vtkDataArray * vtkSPHKernel::GetCutoffArray ( )

virtual

Specify the (optional) array defining a cutoff distance.

If provided this distance is used to find the interpolating points within the local neighborbood. Otherwise the cutoff distance is defined as the cutoff factor times the spatial step size.

◆ SetDensityArray()

virtual void vtkSPHKernel::SetDensityArray ( vtkDataArray * )

virtual

Specify the (optional) density array.

Used with the mass array to compute local particle volumes.

◆ GetDensityArray()

virtual vtkDataArray * vtkSPHKernel::GetDensityArray ( )

virtual

Specify the (optional) density array.

Used with the mass array to compute local particle volumes.

◆ SetMassArray()

virtual void vtkSPHKernel::SetMassArray ( vtkDataArray * )

virtual

Specify the (optional) mass array.

Used with the density array to compute local particle volumes.

◆ GetMassArray()

virtual vtkDataArray * vtkSPHKernel::GetMassArray ( )

virtual

Specify the (optional) mass array.

Used with the density array to compute local particle volumes.

◆ Initialize()

void vtkSPHKernel::Initialize	(	vtkAbstractPointLocator *	loc,
		vtkDataSet *	ds,
		vtkPointData *	pd
	)

overridevirtual

Produce the computational parameters for the kernel.

Invoke this method after setting initial values like SpatialStep.

Reimplemented from vtkInterpolationKernel.

Reimplemented in vtkSPHQuarticKernel, vtkSPHQuinticKernel, and vtkWendlandQuinticKernel.

◆ ComputeBasis()

vtkIdType vtkSPHKernel::ComputeBasis	(	double	x[3],
		vtkIdList *	pIds,
		vtkIdType	ptId = `0`
	)

overridevirtual

Given a point x (and optional associated ptId), determine the points around x which form an interpolation basis.

The user must provide the vtkIdList pIds, which will be dynamically resized as necessary. The method returns the number of points in the basis. Typically this method is called before ComputeWeights(). Note that while ptId is optional in most cases, if a cutoff array is provided, then ptId must be provided.

Implements vtkInterpolationKernel.

◆ ComputeWeights()

vtkIdType vtkSPHKernel::ComputeWeights	(	double	x[3],
		vtkIdList *	pIds,
		vtkDoubleArray *	weights
	)

overridevirtual

Given a point x, and a list of basis points pIds, compute interpolation weights associated with these basis points.

Implements vtkInterpolationKernel.

◆ ComputeDerivWeights()

virtual vtkIdType vtkSPHKernel::ComputeDerivWeights	(	double	x[3],
		vtkIdList *	pIds,
		vtkDoubleArray *	weights,
		vtkDoubleArray *	gradWeights
	)

virtual

Given a point x, and a list of basis points pIds, compute interpolation weights, plus derivative weights, associated with these basis points.

◆ ComputeFunctionWeight()

virtual double vtkSPHKernel::ComputeFunctionWeight ( const double d )

pure virtual

Compute weighting factor given a normalized distance from a sample point.

Implemented in vtkSPHCubicKernel, vtkSPHQuarticKernel, vtkSPHQuinticKernel, and vtkWendlandQuinticKernel.

◆ ComputeDerivWeight()

virtual double vtkSPHKernel::ComputeDerivWeight ( const double d )

pure virtual

Compute weighting factor for derivative quantities given a normalized distance from a sample point.

Implemented in vtkSPHCubicKernel, vtkSPHQuarticKernel, vtkSPHQuinticKernel, and vtkWendlandQuinticKernel.

◆ GetNormFactor()

virtual double vtkSPHKernel::GetNormFactor ( )

virtual

Return the SPH normalization factor.

This also includes the contribution of 1/h^d, where h is the smoothing length (i.e., spatial step) and d is the dimension of the kernel. The returned value is only valid after the kernel is initialized.

Member Data Documentation

◆ SpatialStep

double vtkSPHKernel::SpatialStep

protected

Definition at line 187 of file vtkSPHKernel.h.

◆ Dimension

int vtkSPHKernel::Dimension

protected

Definition at line 188 of file vtkSPHKernel.h.

◆ CutoffArray

vtkDataArray* vtkSPHKernel::CutoffArray

protected

Definition at line 191 of file vtkSPHKernel.h.

◆ DensityArray

vtkDataArray* vtkSPHKernel::DensityArray

protected

Definition at line 192 of file vtkSPHKernel.h.

◆ MassArray

vtkDataArray* vtkSPHKernel::MassArray

protected

Definition at line 193 of file vtkSPHKernel.h.

◆ CutoffFactor

double vtkSPHKernel::CutoffFactor

protected

Definition at line 197 of file vtkSPHKernel.h.

◆ Cutoff

double vtkSPHKernel::Cutoff

protected

Definition at line 198 of file vtkSPHKernel.h.

◆ Sigma

double vtkSPHKernel::Sigma

protected

Definition at line 199 of file vtkSPHKernel.h.

◆ DistNorm

double vtkSPHKernel::DistNorm

protected

Definition at line 200 of file vtkSPHKernel.h.

◆ NormFactor

double vtkSPHKernel::NormFactor

protected

Definition at line 201 of file vtkSPHKernel.h.

◆ DefaultVolume

double vtkSPHKernel::DefaultVolume

protected

Definition at line 202 of file vtkSPHKernel.h.

◆ UseCutoffArray

bool vtkSPHKernel::UseCutoffArray

protected

Definition at line 203 of file vtkSPHKernel.h.

◆ UseArraysForVolume

bool vtkSPHKernel::UseArraysForVolume

protected

Definition at line 204 of file vtkSPHKernel.h.

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

Filters/Points/vtkSPHKernel.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSPHKernel()

◆ ~vtkSPHKernel()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetSpatialStep()

◆ GetSpatialStep()

◆ SetDimension()

◆ GetDimension()

◆ GetCutoffFactor()

◆ SetCutoffArray()

◆ GetCutoffArray()

◆ SetDensityArray()

◆ GetDensityArray()

◆ SetMassArray()

◆ GetMassArray()

◆ Initialize()

◆ ComputeBasis()

◆ ComputeWeights()

◆ ComputeDerivWeights()

◆ ComputeFunctionWeight()

◆ ComputeDerivWeight()

◆ GetNormFactor()

Member Data Documentation

◆ SpatialStep

◆ Dimension

◆ CutoffArray

◆ DensityArray

◆ MassArray

◆ CutoffFactor

◆ Cutoff

◆ Sigma

◆ DistNorm

◆ NormFactor

◆ DefaultVolume

◆ UseCutoffArray

◆ UseArraysForVolume