License
βββ
βββββββββ βββββ βββββ βββ ββββ
βββββββββ βββββ ββββββ βββ βββββββ
βββββββ βββ βββββββββββββββββββββββββ βββ
βββββββ βββ ββββ ββββββ βββββββββββββββββ
βββ βββ βββ ββββββ ββββββ ββββββββββ
βββ βββ βββ βββββββ§ββββββ ββββββββββ
ββββββ ββββββ βββ
ββββββββ ββββββββ βββ βββββββ
βββ βββββββ ββββ βββ βββββββββββββββββ
ββββ βββββββ ββββ βββββ ββββββ ββββββ ββ
βββββββββ ββββββββ βββββ βββββββββββββ
ββββββββ βββββββ βββββββββββββ
Rennes βββ
βββ
@author: François Mahé
@mail: francois.mahe@ens-rennes.fr
(Univ Rennes, ENS Rennes, CNRS, IPR - UMR 6251, F-35000 Rennes, France)
@project: FiberMat
@version: v1.0
License
-------
MIT License
Copyright (c) 2024 François Mahé
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Description
-----------
A mechanical solver to simulate fiber packing and perform statistical analysis.
References
----------
MahΓ©, F. (2023). Statistical mechanical framework for discontinuous composites:
application to the modeling of flow in SMC compression molding (Doctoral
dissertation, Γcole centrale de Nantes).
FiberMat is a mechanical solver to simulate fiber packing and perform statistical analysis. It generates realistic 3D fiber mesostructures and computes internal forces and deformations.
This code is the result of thesis work that can be found in:
Requirements:
Run the following commands:
# Install `FiberMat`
pip install fibermat
# Try it out
python -c "import fibermat"
-
Create a conda environment:
# Create conda environment conda create -n fibermat python=3.11 # Activate the environment conda activate fibermat # Optional pip install jupyter
-
Install FiberMat:
# Install `FiberMat` pip install --upgrade fibermat # Try it out python -c "import fibermat"
-
To leave
fibermat
environment, runconda deactivate
.
Clone the repository and run pip
command:
# Clone the repository
git clone git@github.com:fmahe/fibermat.git
cd ./fibermat
# Install `FiberMat`
pip install --upgrade .
FiberMat's documentation is created using Sphinx [1].
-
Clone the repository:
# Clone the repository git clone git@github.com:fmahe/fibermat.git cd ./fibermat
-
Install dependencies required to compile documentation:
-
Install the packages listed in
requirements.txt
with Pip:# Install dependencies pip install -r requirements.txt
-
Alternatively, you can create a new environment that already meets the requirements:
# Create an environment from the `environment.yml` file conda env create -n fibermat -f ./environment.yml # Activate the environment conda activate fibermat
-
-
Execute
./make
script:# Build the sources ./make --all
-
Test the library:
pytest
[1] : Here a tutorial (fr) for Sphinx: Introduction Γ Sphinx, un outil de documentation puissant.
See the tutorial in jupyter-notebook.ipynb
.
from fibermat import *
# Generate a set of fibers
mat = Mat(100, length=25., width=2., thickness=0.5, size=50., shear=1., tensile=2500.)
# Build the fiber network
net = Net(mat, periodic=True)
# Stack fibers
stack = Stack(net, threshold=10)
# Create the fiber mesh
mesh = Mesh(stack)
# Solve the mechanical packing problem
sol = solve(Model(mesh), packing=4.)
# Export as VTK
msh = vtk_mesh(
mesh,
sol.displacement(1),
sol.rotation(1),
sol.force(1),
sol.torque(1),
)
msh.plot(scalars="force", cmap=plt.cm.twilight_shifted)
msh.save("outputs/msh.vtk")