Minor fixes on Particle/SphSystemData (#108)

This revision includes:
* Minor comment fixes on Particle/SphSystemData2 and 3
* Adding setKernelRadius function to SphSystemData2 and 3
* Adding more Python bindings to ParticleSystemData2 and 3

Author: doyubkim

.travis.yml

@@ -30,5 +30,6 @@ script:
   - cmake ..
   - make
   - bin/unit_tests
+  - pip install --user -r ../requirements.txt
   - pip install --user ..
   - python ../src/tests/python_tests/main.py

INSTALL.md

@@ -124,7 +124,15 @@ Then, build `INSTALL` project under `jet.sln`. This will install the header file
 To install the Python SDK, `pyjet`, run the following command from the project root directory (where `setup.py` lives):
 
 ```
-pip install .
+pip install -U .
+```
+
+> You can also use `virtualenv` to isolate the SDK installation. Check out [the virtualenv documentation](https://virtualenv.pypa.io/en/stable/) for more details.
+
+To run the test/example scripts, install other Python dependencies as follows:
+
+```
+pip install -r requirements.txt
 ```
 
 Once installed, try running the unit test to see if the module is installed correctly:

appveyor.yml

@@ -39,5 +39,6 @@ build:
 
 after_build:
   - c:\jet\build\bin\Release\unit_tests.exe
+  - pip install --user -r c:\jet\requirements.txt
   - pip install --user c:\jet
   - python c:\jet\src\tests\python_tests\main.py

include/jet/particle_system_data2.h

@@ -168,9 +168,9 @@ class ParticleSystemData2 : public Serializable {
     //! responsibility to call ParticleSystemData2::buildNeighborSearcher and
     //! ParticleSystemData2::buildNeighborLists to refresh those data.
     //!
-    //! \param[in]  newPosition The new position.
-    //! \param[in]  newVelocity The new velocity.
-    //! \param[in]  newForce    The new force.
+    //! \param[in]  newPositions  The new positions.
+    //! \param[in]  newVelocities The new velocities.
+    //! \param[in]  newForces     The new forces.
     //!
     void addParticles(
         const ConstArrayAccessor1<Vector2D>& newPositions,

include/jet/particle_system_data3.h

@@ -168,9 +168,9 @@ class ParticleSystemData3 : public Serializable {
     //! responsibility to call ParticleSystemData3::buildNeighborSearcher and
     //! ParticleSystemData3::buildNeighborLists to refresh those data.
     //!
-    //! \param[in]  newPosition The new position.
-    //! \param[in]  newVelocity The new velocity.
-    //! \param[in]  newForce    The new force.
+    //! \param[in]  newPositions  The new positions.
+    //! \param[in]  newVelocities The new velocities.
+    //! \param[in]  newForces     The new forces.
     //!
     void addParticles(
         const ConstArrayAccessor1<Vector3D>& newPositions,

include/jet/sph_system_data2.h

@@ -95,7 +95,7 @@ class SphSystemData2 : public ParticleSystemData2 {
     //! \brief Sets the relative kernel radius.
     //!
     //! Sets the relative kernel radius compared to the target particle
-    //! spacing (i.e. kernal radius / target spacing).
+    //! spacing (i.e. kernel radius / target spacing).
     //! Once this function is called, hash grid and density should
     //! be updated using updateHashGrid() and updateDensities).
     //!
@@ -105,10 +105,20 @@ class SphSystemData2 : public ParticleSystemData2 {
     //! \brief Returns the relative kernel radius.
     //!
     //! Returns the relative kernel radius compared to the target particle
-    //! spacing (i.e. kernal radius / target spacing).
+    //! spacing (i.e. kernel radius / target spacing).
     //!
     double relativeKernelRadius() const;
 
+    //!
+    //! \brief Sets the absolute kernel radius.
+    //!
+    //! Sets the absolute kernel radius compared to the target particle
+    //! spacing (i.e. relative kernel radius * target spacing).
+    //! Once this function is called, hash grid and density should
+    //! be updated using updateHashGrid() and updateDensities).
+    //!
+    void setKernelRadius(double kernelRadius);
+
     //! Returns the kernel radius in meters unit.
     double kernelRadius() const;
 
@@ -126,9 +136,8 @@ class SphSystemData2 : public ParticleSystemData2 {
     //! \warning You must update the neighbor searcher
     //! (SphSystemData2::buildNeighborSearcher) before calling this function.
     //!
-    double interpolate(
-        const Vector2D& origin,
-        const ConstArrayAccessor1<double>& values) const;
+    double interpolate(const Vector2D& origin,
+                       const ConstArrayAccessor1<double>& values) const;
 
     //!
     //! \brief Returns interpolated vector value at given origin point.
@@ -141,39 +150,35 @@ class SphSystemData2 : public ParticleSystemData2 {
     //! \warning You must update the neighbor searcher
     //! (SphSystemData2::buildNeighborSearcher) before calling this function.
     //!
-    Vector2D interpolate(
-        const Vector2D& origin,
-        const ConstArrayAccessor1<Vector2D>& values) const;
+    Vector2D interpolate(const Vector2D& origin,
+                         const ConstArrayAccessor1<Vector2D>& values) const;
 
     //!
     //! Returns the gradient of the given values at i-th particle.
     //!
     //! \warning You must update the neighbor lists
     //! (SphSystemData2::buildNeighborLists) before calling this function.
     //!
-    Vector2D gradientAt(
-        size_t i,
-        const ConstArrayAccessor1<double>& values) const;
+    Vector2D gradientAt(size_t i,
+                        const ConstArrayAccessor1<double>& values) const;
 
     //!
     //! Returns the laplacian of the given values at i-th particle.
     //!
     //! \warning You must update the neighbor lists
     //! (SphSystemData2::buildNeighborLists) before calling this function.
     //!
-    double laplacianAt(
-        size_t i,
-        const ConstArrayAccessor1<double>& values) const;
+    double laplacianAt(size_t i,
+                       const ConstArrayAccessor1<double>& values) const;
 
     //!
     //! Returns the laplacian of the given values at i-th particle.
     //!
     //! \warning You must update the neighbor lists
     //! (SphSystemData2::buildNeighborLists) before calling this function.
     //!
-    Vector2D laplacianAt(
-        size_t i,
-        const ConstArrayAccessor1<Vector2D>& values) const;
+    Vector2D laplacianAt(size_t i,
+                         const ConstArrayAccessor1<Vector2D>& values) const;
 
     //! Builds neighbor searcher with kernel radius.
     void buildNeighborSearcher();

include/jet/sph_system_data3.h

@@ -87,17 +87,27 @@ class SphSystemData3 : public ParticleSystemData3 {
     //! \brief Sets the relative kernel radius.
     //!
     //! Sets the relative kernel radius compared to the target particle
-    //! spacing (i.e. kernal radius / target spacing).
+    //! spacing (i.e. kernel radius / target spacing).
     //! Once this function is called, hash grid and density should
     //! be updated using updateHashGrid() and updateDensities).
     //!
     void setRelativeKernelRadius(double relativeRadius);
 
+    //!
+    //! \brief Sets the absolute kernel radius.
+    //!
+    //! Sets the absolute kernel radius compared to the target particle
+    //! spacing (i.e. relative kernel radius * target spacing).
+    //! Once this function is called, hash grid and density should
+    //! be updated using updateHashGrid() and updateDensities).
+    //!
+    void setKernelRadius(double kernelRadius);
+
     //!
     //! \brief Returns the relative kernel radius.
     //!
     //! Returns the relative kernel radius compared to the target particle
-    //! spacing (i.e. kernal radius / target spacing).
+    //! spacing (i.e. kernel radius / target spacing).
     //!
     double relativeKernelRadius() const;
 
@@ -115,9 +125,8 @@ class SphSystemData3 : public ParticleSystemData3 {
     //! particle layout. For example, density or pressure arrays can be
     //! used.
     //!
-    double interpolate(
-        const Vector3D& origin,
-        const ConstArrayAccessor1<double>& values) const;
+    double interpolate(const Vector3D& origin,
+                       const ConstArrayAccessor1<double>& values) const;
 
     //!
     //! \brief Returns interpolated vector value at given origin point.
@@ -127,24 +136,20 @@ class SphSystemData3 : public ParticleSystemData3 {
     //! particle layout. For example, velocity or acceleration arrays can be
     //! used.
     //!
-    Vector3D interpolate(
-        const Vector3D& origin,
-        const ConstArrayAccessor1<Vector3D>& values) const;
+    Vector3D interpolate(const Vector3D& origin,
+                         const ConstArrayAccessor1<Vector3D>& values) const;
 
     //! Returns the gradient of the given values at i-th particle.
-    Vector3D gradientAt(
-        size_t i,
-        const ConstArrayAccessor1<double>& values) const;
+    Vector3D gradientAt(size_t i,
+                        const ConstArrayAccessor1<double>& values) const;
 
     //! Returns the laplacian of the given values at i-th particle.
-    double laplacianAt(
-        size_t i,
-        const ConstArrayAccessor1<double>& values) const;
+    double laplacianAt(size_t i,
+                       const ConstArrayAccessor1<double>& values) const;
 
     //! Returns the laplacian of the given values at i-th particle.
-    Vector3D laplacianAt(
-        size_t i,
-        const ConstArrayAccessor1<Vector3D>& values) const;
+    Vector3D laplacianAt(size_t i,
+                         const ConstArrayAccessor1<Vector3D>& values) const;
 
     //! Builds neighbor searcher with kernel radius.
     void buildNeighborSearcher();

requirements.txt

@@ -0,0 +1,2 @@
+numpy
+matplotlib