Skip to content

Commit

Permalink
Updated readme and workflow names
Browse files Browse the repository at this point in the history
  • Loading branch information
Egor Demidov committed Feb 18, 2024
1 parent ac45850 commit d4831ff
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build documentation
name: Deploy documentation

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test
name: Run unit tests

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions Writerside/.idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Writerside/.idea/Writerside.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Writerside/.idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions Writerside/.idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Writerside/hi.tree
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
name="libgran documentation"
start-page="Installation.md">

<toc-element topic="Overview.md"/>
<toc-element topic="Installation.md"/>
<toc-element topic="Tutorials.md">
<toc-element topic="Example-simulation.md"/>
Expand Down
14 changes: 14 additions & 0 deletions Writerside/topics/Overview.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit d4831ff

Please sign in to comment.