1 /*=========================================================================
2 
3   Program:   Visualization Toolkit
4   Module:    vtkSPHQuinticKernel.h
5 
6   Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7   All rights reserved.
8   See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10      This software is distributed WITHOUT ANY WARRANTY; without even
11      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12      PURPOSE.  See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /**
16  * @class   vtkSPHQuinticKernel
17  * @brief   a quintic SPH interpolation kernel
18  *
19  *
20  * vtkSPHQuinticKernel is an smooth particle hydrodynamics interpolation kernel as
21  * described by D.J. Price. This is a quintic formulation.
22  *
23  * @warning
24  * FOr more information see D.J. Price, Smoothed particle hydrodynamics and
25  * magnetohydrodynamics, J. Comput. Phys. 231:759-794, 2012. Especially
26  * equation 49.
27  *
28  * @par Acknowledgments:
29  * The following work has been generously supported by Altair Engineering
30  * and FluiDyna GmbH. Please contact Steve Cosgrove or Milos Stanic for
31  * more information.
32  *
33  * @sa
34  * vtkSPHKernel vtkSPHInterpolator
35 */
36 
37 #ifndef vtkSPHQuinticKernel_h
38 #define vtkSPHQuinticKernel_h
39 
40 #include "vtkFiltersPointsModule.h" // For export macro
41 #include "vtkSPHKernel.h"
42 #include <algorithm> // For std::min()
43 
44 class vtkIdList;
45 class vtkDoubleArray;
46 
47 
48 class VTKFILTERSPOINTS_EXPORT vtkSPHQuinticKernel : public vtkSPHKernel
49 {
50 public:
51   //@{
52   /**
53    * Standard methods for instantiation, obtaining type information, and printing.
54    */
55   static vtkSPHQuinticKernel *New();
56   vtkTypeMacro(vtkSPHQuinticKernel,vtkSPHKernel);
57   void PrintSelf(ostream& os, vtkIndent indent) override;
58   //@}
59 
60   /**
61    * Produce the computational parameters for the kernel. Invoke this method
62    * after setting initial values like SpatialStep.
63    */
64   void Initialize(vtkAbstractPointLocator *loc, vtkDataSet *ds,
65                           vtkPointData *pd) override;
66 
67   //@{
68   /**
69    * Compute weighting factor given a normalized distance from a sample point.
70    */
ComputeFunctionWeight(const double d)71   double ComputeFunctionWeight(const double d) override
72   {
73     double tmp1 = 3.0 - std::min(d,3.0);
74     double tmp2 = 2.0 - std::min(d,2.0);
75     double tmp3 = 1.0 - std::min(d,1.0);
76     return (tmp1*tmp1*tmp1*tmp1*tmp1 - 6.0*tmp2*tmp2*tmp2*tmp2*tmp2 +
77             15.0*tmp3*tmp3*tmp3*tmp3*tmp3);
78   }
79   //@}
80 
81   //@{
82   /**
83    * Compute weighting factor for derivative quantities given a normalized
84    * distance from a sample point.
85    */
ComputeDerivWeight(const double d)86   double ComputeDerivWeight(const double d) override
87   {
88     double tmp1 = 3.0 - std::min(d,3.0);
89     double tmp2 = 2.0 - std::min(d,2.0);
90     double tmp3 = 1.0 - std::min(d,1.0);
91     return (-5.0*tmp1*tmp1*tmp1*tmp1 + 30.0*tmp2*tmp2*tmp2*tmp2 +
92             -75.0*tmp3*tmp3*tmp3*tmp3);
93   }
94   //@}
95 
96 protected:
97   vtkSPHQuinticKernel();
98   ~vtkSPHQuinticKernel() override;
99 
100 private:
101   vtkSPHQuinticKernel(const vtkSPHQuinticKernel&) = delete;
102   void operator=(const vtkSPHQuinticKernel&) = delete;
103 };
104 
105 #endif
106