Adjust README & javadocs

andrei-punko · Oct 20, 2024 · ff1b8b2 · ff1b8b2
1 parent 4d956b9
commit ff1b8b2
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/README.MD b/README.MD
@@ -12,11 +12,13 @@ Gradle isn't required because of embedded Gradle presence in the project
 
 ## Supported PD equation types
 
-- Parabolic equation (described heat/mass transfer)  
-  Check [ParabolicEquation](src/main/java/by/andd3dfx/math/pde/equation/ParabolicEquation.java) class for details
+- Parabolic equation (described heat/mass transfer):  
+  M(x,t,U)*dU_dt = dU(K(x,t,U)*dU_dx)_dx + V(x,t,U)*dU_dx + F(x,t,U) where U = U(x,t)  
+  Check [ParabolicEquation](src/main/java/by/andd3dfx/math/pde/equation/ParabolicEquation.java) for details
 
-- Hyperbolic equation (described oscillation processes)  
-  Check [HyperbolicEquation](src/main/java/by/andd3dfx/math/pde/equation/HyperbolicEquation.java) class for details
+- Hyperbolic equation (described oscillation processes):  
+  M(x,t,U)*d2U_dt2 + L(x,t,U)*dU_dt = dU(K(x,t,U)*dU_dx)_dx + V(x,t,U)*dU_dx + F(x,t,U) where U = U(x,t)  
+  Check [HyperbolicEquation](src/main/java/by/andd3dfx/math/pde/equation/HyperbolicEquation.java) for details
 
 ## Solver
 The finite-difference method was used, in result we get tridiagonal system of linear equations 

diff --git a/src/main/java/by/andd3dfx/math/pde/equation/HyperbolicEquation.java b/src/main/java/by/andd3dfx/math/pde/equation/HyperbolicEquation.java
@@ -6,8 +6,8 @@
 import by.andd3dfx.math.pde.border.BorderConditionType3;
 
 /**
- * Hyperbolic equation:
- * M(x,t,U)*d2U_dt2 + L(x,t,U)*dU_dt = K(x,t,U)*d2U_dt2 + V(x,t,U)*dU_dt + F(x,t,U) where U = U(x,t)
+ * Hyperbolic equation (described oscillation processes):
+ * M(x,t,U)*d2U_dt2 + L(x,t,U)*dU_dt = dU(K(x,t,U)*dU_dx)_dx + V(x,t,U)*dU_dx + F(x,t,U) where U = U(x,t)
  */
 public class HyperbolicEquation extends Equation {
 

diff --git a/src/main/java/by/andd3dfx/math/pde/equation/ParabolicEquation.java b/src/main/java/by/andd3dfx/math/pde/equation/ParabolicEquation.java
@@ -6,8 +6,8 @@
 import by.andd3dfx.math.pde.border.BorderConditionType3;
 
 /**
- * Parabolic equation:
- * M(x,t,U)*dU_dt = dU(K(x,t,U)*dU_dt)_dt + V(x,t,U)*dU_dt + F(x,t,U) where U = U(x,t)
+ * Parabolic equation (described heat/mass transfer):
+ * M(x,t,U)*dU_dt = dU(K(x,t,U)*dU_dx)_dx + V(x,t,U)*dU_dx + F(x,t,U) where U = U(x,t)
  */
 public class ParabolicEquation extends Equation {