a cubic SPH interpolation kernel More...

#include <vtkSPHCubicKernel.h>

Inheritance diagram for vtkSPHCubicKernel:

Collaboration diagram for vtkSPHCubicKernel:

Public Types
typedef vtkSPHKernel	Superclass

Public Types inherited from vtkSPHKernel
typedef vtkInterpolationKernel	Superclass
	Standard methods for instantiation, obtaining type information, and printing. More...

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkSPHCubicKernel *	NewInstance () const

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

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

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

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

Public Member Functions inherited from vtkSPHKernel
vtkSPHKernel *	NewInstance () const

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

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

virtual double	GetSpatialStep ()

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

virtual int	GetDimension ()

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

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

virtual vtkDataArray *	GetCutoffArray ()

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

virtual vtkDataArray *	GetDensityArray ()

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

virtual vtkDataArray *	GetMassArray ()

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

virtual vtkIdType	ComputeWeights (double x[3], vtkIdList pIds, vtkDoubleArray weights)
	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	GetNormFactor ()
	Return the SPH normalization factor. More...

Public Member Functions inherited from vtkInterpolationKernel
	vtkAbstractTypeMacro (vtkInterpolationKernel, vtkObject)
	Standard method for type and printing. More...

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

virtual bool	GetRequiresInitialization ()

virtual void	RequiresInitializationOn ()

virtual void	RequiresInitializationOff ()

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...

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)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

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)

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. 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	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

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...

void	PrintRevisions (ostream &)
	Legacy. More...

Static Public Member Functions
static vtkSPHCubicKernel *	New ()
	Standard methods for instantiation, obtaining type information, and printing. More...

static int	IsTypeOf (const char *type)

static vtkSPHCubicKernel *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkSPHKernel
static int	IsTypeOf (const char *type)

static vtkSPHKernel *	SafeDownCast (vtkObjectBase *o)

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 ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSPHCubicKernel ()

	~vtkSPHCubicKernel ()

Protected Member Functions inherited from vtkSPHKernel
	vtkSPHKernel ()

	~vtkSPHKernel ()

Protected Member Functions inherited from vtkInterpolationKernel
	vtkInterpolationKernel ()

	~vtkInterpolationKernel ()

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkSPHKernel
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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

a cubic SPH interpolation kernel

vtkSPHCubicKernel is an smooth particle hydrodynamics interpolation kernel as described by D.J. Price. This is a cubic formulation.

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 vtkSPHInterpolator

Tests:: vtkSPHCubicKernel (Tests)

Definition at line 51 of file vtkSPHCubicKernel.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSPHKernel vtkSPHCubicKernel::Superclass

Definition at line 59 of file vtkSPHCubicKernel.h.

Constructor & Destructor Documentation

◆ vtkSPHCubicKernel()

vtkSPHCubicKernel::vtkSPHCubicKernel ( )

protected

◆ ~vtkSPHCubicKernel()

vtkSPHCubicKernel::~vtkSPHCubicKernel ( )

protected

Member Function Documentation

◆ New()

static vtkSPHCubicKernel* vtkSPHCubicKernel::New ( )

static

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

◆ IsTypeOf()

static int vtkSPHCubicKernel::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkSPHCubicKernel::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkSPHKernel.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSPHCubicKernel::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkSPHKernel.

◆ NewInstance()

vtkSPHCubicKernel* vtkSPHCubicKernel::NewInstance ( ) const

◆ PrintSelf()

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

virtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkInterpolationKernel.

◆ Initialize()

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

virtual

Produce the computational parameters for the kernel.

Invoke this method after setting initial values like SpatialStep.

Reimplemented from vtkSPHKernel.

◆ ComputeFunctionWeight()

virtual double vtkSPHCubicKernel::ComputeFunctionWeight ( const double d )

inlinevirtual

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

Implements vtkSPHKernel.

Definition at line 74 of file vtkSPHCubicKernel.h.

◆ ComputeDerivWeight()

virtual double vtkSPHCubicKernel::ComputeDerivWeight ( const double d )

inlinevirtual

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

Implements vtkSPHKernel.

Definition at line 87 of file vtkSPHCubicKernel.h.

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

dox/Filters/Points/vtkSPHCubicKernel.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSPHCubicKernel()

◆ ~vtkSPHCubicKernel()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Initialize()

◆ ComputeFunctionWeight()

◆ ComputeDerivWeight()