Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Fix toc in documentation and a typo #255

Merged
merged 3 commits into from
Sep 2, 2024
Merged

DOC: Fix toc in documentation and a typo #255

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dbd527a
Fix toc in documentation and typo.
Sep 1, 2024
8548287
Revert TOC bullet style in README
Sep 2, 2024
8b908d1
Uncommented pre-commit hook
Sep 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,18 @@ GPGI stands for **G**eneric **P**article + **G**rid data **I**nterface

- [Installation](#installation)
- [Supported applications](#supported-applications)
* [Builtin deposition methods](#builtin-deposition-methods)
* [Supported geometries](#supported-geometries)
- [Builtin deposition methods](#builtin-deposition-methods)
- [Supported geometries](#supported-geometries)
- [Time complexity](#time-complexity)
- [Usage](#usage)
* [Supplying arbitrary metadata](#supplying-arbitrary-metadata)
* [Boundary conditions](#boundary-conditions)
+ [Builtin recipes](#builtin-recipes)
+ [Define custom recipes](#define-custom-recipes)
* [Weight fields (Depositing intensive quantities)](#weight-fields-depositing-intensive-quantities)
* [Count Sorting](#count-sorting)
- [Supplying arbitrary metadata](#supplying-arbitrary-metadata)
- [Boundary conditions](#boundary-conditions)
- [Builtin recipes](#builtin-recipes)
- [Define custom recipes](#define-custom-recipes)
- [Weight fields (Depositing intensive quantities)](#weight-fields-depositing-intensive-quantities)
- [Count Sorting](#count-sorting)
- [Deposition algorithm](#deposition-algorithm)
- [Thread safety](#thread-safety)

<!-- tocstop -->

Expand Down Expand Up @@ -84,7 +85,7 @@ Their signature need to be compatible with `gpgi.types.DepositionMethodT`.

An important step in performing deposition is to associate particle indices to cell indices. This step is called "particle indexing".
In directions where the grid is uniformly stepped (if any), indexing a particle is an O(1) operation.
In the more general case, indexing is performed by bisection, which is a O(log(nx))) operation (where nx represents the number of cells in the direction of interest).
In the more general case, indexing is performed by bisection, which is a O(log(nx)) operation (where nx represents the number of cells in the direction of interest).


## Usage
Expand Down