Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
paxbun committed Oct 25, 2021
1 parent 77feb0c commit bcc5575
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,10 +150,13 @@ Then you will be able to see that the temperature information sent by the client

## How to add custom algorithm implementers

The main algorithm implementations reside in the C++ part, not the Rust part. Go to [`Space.hh`](./server/core/Public/leth/Space.hh) and see the definition of `Space`. `Space` is a class which represents an algorithm implementer. Refer to [`MonteCarloSpace.hh`](./server/core/Public/leth/MonteCarloSpace.hh) and [`MonteCarloSpace.cc`](./server/core/Source/MonteCarloSpace.cc) to find out what each virtual function must do. Currently, there are two `Space`s implemented as follows:
The main algorithm implementations reside in the C++ part, not the Rust part. Go to [`Space.hh`](./server/core/Public/leth/Space.hh) and see the definition of `Space`. `Space` is a class which represents an algorithm implementer. Refer to [`MonteCarloSpace.hh`](./server/core/Public/leth/MonteCarloSpace.hh) and [`MonteCarloSpace.cc`](./server/core/Source/MonteCarloSpace.cc) to find out what each virtual function must do. Currently, there are one virtual `Space` and two `Space`s implemented as follows:

- `MonteCarloSpace` ([Header](./server/core/Public/leth/MonteCarloSpace.hh)/[Source](./server/core/Source/MonteCarloSpace.cc))
- `SuccessiveOverRelaxationSpace` ([Header](./server/core/Public/leth/SuccessiveOverRelaxationSpace.hh)/[Source](./server/core/Source/SuccessiveOverRelaxationSpace.cc))
- Virtual `Space`s
- `MatrixSpace` ([Header](./server/core/Public/leth/MatrixSpace.hh)/[Source](./server/core/Source/MatrixSpace.cc))
- `Space`s
- `MonteCarloSpace` ([Header](./server/core/Public/leth/MonteCarloSpace.hh)/[Source](./server/core/Source/MonteCarloSpace.cc))
- `SuccessiveOverRelaxationSpace : MatrixSpace` ([Header](./server/core/Public/leth/SuccessiveOverRelaxationSpace.hh)/[Source](./server/core/Source/SuccessiveOverRelaxationSpace.cc))

After implementing your own `Space` class, go to [`Config.cc`](./server/core/Source/Config.cc) and find the function `leth_create`. The definition of `leth_create` is as shown below:

Expand Down

0 comments on commit bcc5575

Please sign in to comment.