modify the comments and spell error checks

Xiangyu-Hu · Sep 1, 2023 · 5801ae5 · 5801ae5
1 parent 3d7336f
commit 5801ae5
Show file tree

Hide file tree

Showing 5 changed files with 185 additions and 187 deletions.
diff --git a/src/shared/kernels/anisotropic_kernel.h b/src/shared/kernels/anisotropic_kernel.h
@@ -26,7 +26,7 @@
  *			implemented in derived classes. The kernel function define the relevance
  * 			between two neighboring particles. Basically, the further the two
  *			particles, the less relevance they have.
- * @author	 Zhentong Wang and Xiaojing Tang
+ * @author	  Xiaojing Tang and Zhentong Wang
  * @version	0.1
  * @version  0.3.0
  */
@@ -88,9 +88,11 @@ class AnisotropicKernel : public KernelType
         this->factor_d2W_3D_ = this->factor_W_3D_;
     };
 
+    /** Calculates the transform tensor form anisotropic space to isotropic space **/
     Mat2d getCoordinateTransformationTensorG(Vec2d kernel_vector, Vec2d transform_vector);
     Mat3d getCoordinateTransformationTensorG(Vec3d kernel_vector, Vec3d transform_vector);
 
+   /** Calculates the unit vector between a pair of particles **/
     virtual Vec2d e(const Real &distance, const Vec2d &displacement) const override;
     virtual Vec3d e(const Real &distance, const Vec3d &displacement) const override;
 

diff --git a/src/shared/kernels/base_kernel.h b/src/shared/kernels/base_kernel.h
@@ -96,7 +96,7 @@ class Kernel
     virtual Vec3d e(const Real &distance, const Vec3d &displacement) const { return displacement / (distance + TinyReal); };
 
     /**
-     * check if particles are within cutOff radius
+     * check if particles are within cutoff radius
      */
     virtual bool checkIfWithinCutOffRadius(Vec2d displacement)
     {
@@ -216,4 +216,4 @@ class Kernel
     void reduceTwice(); /** reduce for linear structures or filaments */
 };
 } // namespace SPH
-#endif // BASE_KERNELS_H
+#endif // BASE_KERNELS_H
diff --git a/src/shared/particle_dynamics/solid_dynamics/elastic_dynamics.cpp b/src/shared/particle_dynamics/solid_dynamics/elastic_dynamics.cpp
@@ -79,7 +79,7 @@ void Integration1stHalfPK2::initialization(size_t index_i, Real dt)
     F_[index_i] += dF_dt_[index_i] * dt * 0.5;
     rho_[index_i] = rho0_ / F_[index_i].determinant();
     // obtain the first Piola-Kirchhoff stress from the second Piola-Kirchhoff stress
-    // it seems using reproducing correction here increases convergence rate near the free surface
+    // it seems using reproducing correction here increases convergence rate near the free surface, note that the correction matrix is in a form of transpose
     stress_PK1_B_[index_i] = elastic_solid_.StressPK1(F_[index_i], index_i) * B_[index_i].transpose();
 }
 //=================================================================================================//