diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 73c423e..bfd0141 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -1,4 +1,4 @@ -name: Build documentation +name: Deploy documentation on: push: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 7e08a0f..e44282c 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,4 +1,4 @@ -name: Test +name: Run unit tests on: push: diff --git a/README.md b/README.md index b43ba0e..8b9c508 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# libgran ![Unit tests workflow badge](https://github.com/egor-demidov/libgran/actions/workflows/test.yml/badge.svg) +# libgran ![Unit tests workflow badge](https://github.com/egor-demidov/libgran/actions/workflows/test.yml/badge.svg) ![Documentation deployment workflow badge](https://github.com/egor-demidov/libgran/actions/workflows/build-docs.yml/badge.svg) libgran is a Discrete Element Method (DEM) framework for simulating the mechanical behavior of soot aggregates. DEM is a technique for simulation of granular media consisting of rigid spherical particles. The resultant force and torque acting diff --git a/Writerside/.idea/.gitignore b/Writerside/.idea/.gitignore new file mode 100644 index 0000000..26d3352 --- /dev/null +++ b/Writerside/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/Writerside/.idea/Writerside.iml b/Writerside/.idea/Writerside.iml new file mode 100644 index 0000000..6102194 --- /dev/null +++ b/Writerside/.idea/Writerside.iml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/Writerside/.idea/modules.xml b/Writerside/.idea/modules.xml new file mode 100644 index 0000000..b2bb62a --- /dev/null +++ b/Writerside/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/Writerside/.idea/vcs.xml b/Writerside/.idea/vcs.xml new file mode 100644 index 0000000..d5a5af2 --- /dev/null +++ b/Writerside/.idea/vcs.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/Writerside/hi.tree b/Writerside/hi.tree index fd9d2dc..7f45e16 100644 --- a/Writerside/hi.tree +++ b/Writerside/hi.tree @@ -6,6 +6,7 @@ name="libgran documentation" start-page="Installation.md"> + diff --git a/Writerside/topics/Overview.md b/Writerside/topics/Overview.md new file mode 100644 index 0000000..91763a1 --- /dev/null +++ b/Writerside/topics/Overview.md @@ -0,0 +1,14 @@ +# Overview + +libgran is a Discrete Element Method (DEM) framework for simulating the mechanical behavior of soot aggregates. DEM is a +technique for simulation of granular media consisting of rigid spherical particles. The resultant force and torque acting +on each particle are computed and used with Newton's second law to compute the motion of particles: +```tex +m\ddot{\mathbf{x}}=\mathbf{f} +``` +```tex +I\ddot{\omega}=\bm{\tau} +``` +The forces that particles experience arise from friction at inter-particle contacts, bonding between particles, +inter-particle attraction, field forces, etc. libgran contains a bonded and a non-bonded contact model, a Van der Waals +attraction model and is designed to be easily extensible with custom models. \ No newline at end of file