Skip to content

Commit

Permalink
Adjustment of README
Browse files Browse the repository at this point in the history
  • Loading branch information
andrei-punko committed Nov 2, 2024
1 parent 8fb4cd4 commit 9cdad24
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,25 @@
Migration to Java some part of C/C++ code from my [math-library](https://github.com/andrei-punko/math-library) repository

## Prerequisites

- JDK 21

Gradle isn't required because of embedded Gradle presence in the project

## Supported PD equation types
## How to build
```shell
./gradlew clean build
```

- Parabolic equation (described heat/mass transfer):
## Supported PD equation types
- Parabolic equation (described heat/mass transfer process):
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):
- Hyperbolic equation (described oscillation process):
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

## Border conditions types

## Supported border conditions types
- Border condition type 1 (definite mode): U(X,t)
- Border condition type 2 (definite force): dU_dx(X,t)
- Border condition type 3 (elastic fixing): dU_dx(X,t) = h*(U(X,t) - Theta(t))
Expand All @@ -30,15 +32,8 @@ Gradle isn't required because of embedded Gradle presence in the project
The finite-difference method was used, in result we get tridiagonal system of linear equations
and solve it with help of tridiagonal matrix algorithm (or Thomas algorithm) (or "метод прогонки" in Russian).

## How to build

```shell
./gradlew clean build
```

## Usage notes

Check solved problems in tests:
- [Diffusion problem with type 1 of both condition types](src/test/java/by/andd3dfx/math/pde/solver/ParabolicEquationSolver11Test.java)
- [Diffusion problem with type 2 of both condition types](src/test/java/by/andd3dfx/math/pde/solver/ParabolicEquationSolver22Test.java)
- [Wave equation (plucked string) with type 1 of both condition types](src/test/java/by/andd3dfx/math/pde/solver/HyperbolicEquationSolver11Test.java)
- [Diffusion problem with type 1 of both border conditions](src/test/java/by/andd3dfx/math/pde/solver/ParabolicEquationSolver11Test.java)
- [Diffusion problem with type 2 of both border conditions](src/test/java/by/andd3dfx/math/pde/solver/ParabolicEquationSolver22Test.java)
- [Wave equation (plucked string) with type 1 of both border conditions](src/test/java/by/andd3dfx/math/pde/solver/HyperbolicEquationSolver11Test.java)

0 comments on commit 9cdad24

Please sign in to comment.