Skip to content

Commit f9febba

Browse files
jvdp1milancurcic
andauthored
Apply suggestions from code review as proposed by @milancurcic
Co-authored-by: Milan Curcic <caomaco@gmail.com>
1 parent 9c6bbbe commit f9febba

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,24 +66,24 @@ Alternatively, you can build using provided Makefiles:
6666
make -f Makefile.manual
6767
```
6868

69-
## Memory issues during compilation
69+
## Limiting the maximum rank of generated procedures
7070

71-
Some issues can be encountered during compilation on low RAM computers.
72-
These issues are due to the high number of procedures generated by the preprocessor.
73-
They can be avoided by limiting the maximum rank of generated procedures, as follows with `CMake`:
71+
Stdlib's preprocessor (fypp) by default generates specific procedures for arrays of all ranks, up to rank 15.
72+
This can result in long compilation times and, on some computers, exceeding available memory.
73+
If you know that you won't need all 15 ranks, you can specify the maximum rank for which the specific procedures will be generated.
74+
For example, with CMake:
7475

7576
```sh
7677
cmake -B build -DCMAKE_MAXIMUM_RANK=4
77-
7878
cmake --build build
79-
80-
cmake --build build --target test
79+
cmake --build build --target test
8180
```
8281
or as follows with `make`:
8382

8483
```sh
8584
make -f Makefile.manual FYPPFLAGS=-DMAXRANK=4
8685
```
86+
Note that currently the minimum value for maximum rank is 4.
8787

8888
## Documentation
8989

0 commit comments

Comments
 (0)