Skip to content

Commit 6ae700a

Browse files
author
polycfd
authored
Merge pull request #6 from polycfd/changes_to_documentation
Additions to the documentation, extended auto-tests
2 parents 65123c7 + f17b6c0 commit 6ae700a

File tree

5 files changed

+60
-0
lines changed

5 files changed

+60
-0
lines changed

‎.github/workflows/test_run.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,35 @@ jobs:
1515
runs-on: macOS-latest
1616
steps:
1717
- uses: actions/checkout@v3
18+
1819
- name: Configure lib
1920
run: cmake -S ${{github.workspace}}/lib -B ${{github.workspace}}/lib -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
2021
- name: Build lib
2122
run: cmake --build ${{github.workspace}}/lib --config ${{env.BUILD_TYPE}}
23+
24+
- name: Configure bubble with gas-temperature model
25+
run: cmake -S ${{github.workspace}}/examples/gastemperature/build -B ${{github.workspace}}/examples/gastemperature/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
26+
- name: Build bubble with gas-temperature model
27+
run: cmake --build ${{github.workspace}}/examples/gastemperature/build --config ${{env.BUILD_TYPE}}
28+
- name: Run bubble with gas-temperature model
29+
run: ${{github.workspace}}/examples/gastemperature/build/gastemperature_apecss -options ${{github.workspace}}/examples/gastemperature/run.apecss -freq 20e3 -amp 70e3 -tend 0.001
30+
2231
- name: Configure laser-induced cavitation
2332
run: cmake -S ${{github.workspace}}/examples/laserinducedcavitation/build -B ${{github.workspace}}/examples/laserinducedcavitation/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
2433
- name: Build laser-induced cavitation
2534
run: cmake --build ${{github.workspace}}/examples/laserinducedcavitation/build --config ${{env.BUILD_TYPE}}
2635
- name: Run laser-induced cavitation
2736
run: ${{github.workspace}}/examples/laserinducedcavitation/build/lic_apecss -options ${{github.workspace}}/examples/laserinducedcavitation/run.apecss -tend 12e-6
37+
38+
- name: Configure Rayleigh collapse
39+
run: cmake -S ${{github.workspace}}/examples/rayleighcollapse/build -B ${{github.workspace}}/examples/rayleighcollapse/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
40+
- name: Build Rayleigh collapse
41+
run: cmake --build ${{github.workspace}}/examples/rayleighcollapse/build --config ${{env.BUILD_TYPE}}
42+
- name: Run Rayleigh collapse (simple)
43+
run: ${{github.workspace}}/examples/rayleighcollapse/build/rayleigh_apecss -options ${{github.workspace}}/examples/rayleighcollapse/simple.apecss -tend 1
44+
- name: Run Rayleigh collapse (with emissions)
45+
run: ${{github.workspace}}/examples/rayleighcollapse/build/rayleigh_apecss -options ${{github.workspace}}/examples/rayleighcollapse/emissions.apecss -tend 0.2
46+
2847
- name: Configure ultrasound
2948
run: cmake -S ${{github.workspace}}/examples/ultrasound/build -B ${{github.workspace}}/examples/ultrasound/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
3049
- name: Build ultrasound
@@ -33,23 +52,48 @@ jobs:
3352
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/lipidcoated_simple.apecss -freq 2.9e6 -amp 130e3 -tend 2e-6
3453
- name: Run ultrasound (lipid-coated)
3554
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/lipidcoated_emissions.apecss -tend 11e-6 -freq 1e6 -amp 600e3
55+
- name: Run ultrasound (sonoluminescence)
56+
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/sonolum_emissions.apecss -tend 40e-6 -freq 23.5e3 -amp 145e3
57+
- name: Run ultrasound (Kelvin-Voigt)
58+
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/kelvinvoigt.apecss -tend 6e-6 -freq 1e6 -amp 3e6
3659
- name: Run ultrasound (Zener)
3760
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/zener.apecss -tend 5e-6 -freq 1e6 -amp 1e6
61+
- name: Run ultrasound (Oldroyd-B)
62+
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/oldroydb.apecss -tend 3e-6 -freq 3e6 -amp 400e3
3863

3964
linux:
4065
runs-on: ubuntu-latest
4166
steps:
4267
- uses: actions/checkout@v3
68+
4369
- name: Configure lib
4470
run: cmake -S ${{github.workspace}}/lib -B ${{github.workspace}}/lib -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
4571
- name: Build lib
4672
run: cmake --build ${{github.workspace}}/lib --config ${{env.BUILD_TYPE}}
73+
74+
- name: Configure bubble with gas-temperature model
75+
run: cmake -S ${{github.workspace}}/examples/gastemperature/build -B ${{github.workspace}}/examples/gastemperature/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
76+
- name: Build bubble with gas-temperature model
77+
run: cmake --build ${{github.workspace}}/examples/gastemperature/build --config ${{env.BUILD_TYPE}}
78+
- name: Run bubble with gas-temperature model
79+
run: ${{github.workspace}}/examples/gastemperature/build/gastemperature_apecss -options ${{github.workspace}}/examples/gastemperature/run.apecss -freq 20e3 -amp 70e3 -tend 0.001
80+
4781
- name: Configure laser-induced cavitation
4882
run: cmake -S ${{github.workspace}}/examples/laserinducedcavitation/build -B ${{github.workspace}}/examples/laserinducedcavitation/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
4983
- name: Build laser-induced cavitation
5084
run: cmake --build ${{github.workspace}}/examples/laserinducedcavitation/build --config ${{env.BUILD_TYPE}}
5185
- name: Run laser-induced cavitation
5286
run: ${{github.workspace}}/examples/laserinducedcavitation/build/lic_apecss -options ${{github.workspace}}/examples/laserinducedcavitation/run.apecss -tend 12e-6
87+
88+
- name: Configure Rayleigh collapse
89+
run: cmake -S ${{github.workspace}}/examples/rayleighcollapse/build -B ${{github.workspace}}/examples/rayleighcollapse/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
90+
- name: Build Rayleigh collapse
91+
run: cmake --build ${{github.workspace}}/examples/rayleighcollapse/build --config ${{env.BUILD_TYPE}}
92+
- name: Run Rayleigh collapse (simple)
93+
run: ${{github.workspace}}/examples/rayleighcollapse/build/rayleigh_apecss -options ${{github.workspace}}/examples/rayleighcollapse/simple.apecss -tend 1
94+
- name: Run Rayleigh collapse (with emissions)
95+
run: ${{github.workspace}}/examples/rayleighcollapse/build/rayleigh_apecss -options ${{github.workspace}}/examples/rayleighcollapse/emissions.apecss -tend 0.2
96+
5397
- name: Configure ultrasound
5498
run: cmake -S ${{github.workspace}}/examples/ultrasound/build -B ${{github.workspace}}/examples/ultrasound/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
5599
- name: Build ultrasound
@@ -58,5 +102,11 @@ jobs:
58102
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/lipidcoated_simple.apecss -freq 2.9e6 -amp 130e3 -tend 2e-6
59103
- name: Run ultrasound (lipid-coated)
60104
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/lipidcoated_emissions.apecss -tend 11e-6 -freq 1e6 -amp 600e3
105+
- name: Run ultrasound (sonoluminescence)
106+
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/sonolum_emissions.apecss -tend 40e-6 -freq 23.5e3 -amp 145e3
107+
- name: Run ultrasound (Kelvin-Voigt)
108+
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/kelvinvoigt.apecss -tend 6e-6 -freq 1e6 -amp 3e6
61109
- name: Run ultrasound (Zener)
62110
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/zener.apecss -tend 5e-6 -freq 1e6 -amp 1e6
111+
- name: Run ultrasound (Oldroyd-B)
112+
run: ${{github.workspace}}/examples/ultrasound/build/ultrasound_apecss -options ${{github.workspace}}/examples/ultrasound/oldroydb.apecss -tend 3e-6 -freq 3e6 -amp 400e3

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ The APECSS repository is structured as follows:
2828
- The [src](/src/) folder contains all source files (*.c) of APECSS.
2929
- The [.clang-format](.clang-format) file, which defines the formatting rules for the source code.
3030
- The [.gitignore](.gitignore) file telling _git_ which folders and files to ignore.
31+
- The [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file containing outlining the code of conduct for this repository.
32+
- The [CONTRIBUTING.md](CONTRIBUTING.md) file containing brief guidelines on how to contribute to APECSS.
3133
- The [LICENSE.txt](LICENSE.txt) file containing the Mozilla Public License Version 2.0.
3234
- The [README.md](README.md) file is the file you are currently reading.
3335

‎documentation/APECSS-Documentation.pdf‎

1.73 KB
Binary file not shown.

‎documentation/chapters/about.tex‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ \chapter{About APECSS}
2222
\item The {\tt src/} folder contains all source files ({\tt *.c}) of APECSS.
2323
\item The {\tt .clang-format} file, which defines the formatting rules for the source code, see Section \ref{sec:clang}.
2424
\item The {\tt .gitignore} file telling \textit{git} which folders and files to ignore.
25+
\item The {\tt CODE\_OF\_CONDUCT.md} file containing outlining the code of conduct for this repository.
26+
\item The {\tt CONTRIBUTING.md} file containing brief guidelines on how to contribute to APECSS.
2527
\item The {\tt LICENSE.txt} file containing the Mozilla Public License Version 2.0.
2628
\item The {\tt README.md} file with the most important information about APECSS.
2729
\end{itemize}

‎documentation/chapters/using.tex‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,3 +349,9 @@ \section{Units}
349349
\item Luminosity in candela [cd]
350350
\end{itemize}
351351

352+
\section{Automated testing}
353+
354+
Github {\it workflows} are run automatically to test the functionality of APECSS everytime a change is {\it pushed} to the {\tt main} branch of APECSS or if a {\it pull request} is opened.
355+
This includes a {\tt Build test} and a {\tt Run test}, the results of which are displayed in the rendered {\tt README.md} file of the Github repository.
356+
357+
The {\tt Build test} checks whether the APECSS library compiles correctly on Linux and MacOS operating systems. The {\tt Run test}, also conducted on both Linux and MacOS operating systems, is more comprehensive, in that it first compiles the APECSS library, then compiles and runs each example. Note that a successful {\tt Run test} does not imply correct results - the {\tt Run test} only tests the basic functionality of the code (e.g.~no segmentation faults), not the correctness of the results APECSS produces.

0 commit comments

Comments
 (0)