Skip to content

adtzlr/felupe

Finite element analysis for continuum mechanics of solid bodies.

FElupe PyPI version shields.io Conda Version PyPI - Python Version Documentation Status License: GPL v3 Project Status: Active – The project has reached a stable, usable state and is being actively developed. codecov DOI Codestyle black PyPI - Downloads lite-badge Open In Colab Streamlit App

FElupe is a Python 3.9+ finite element analysis package focusing on the formulation and numerical solution of nonlinear problems in continuum mechanics of solid bodies. This package is intended for scientific research, but is also suitable for running nonlinear simulations in general. In addition to the transformation of general weak forms into sparse vectors and matrices, FElupe provides an efficient high-level abstraction layer for the simulation of the deformation of solid bodies.

✨ Highlights

Efficient NumPy-based math is realized by element-wise operating trailing axes [1]. The finite element method, as used in FElupe, is based on [2], [3] and [4]. Related scientific articles are listed in the sections of the API reference.

Note

The name FElupe is a combination of FE (finite element) and the german word Lupe (magnifying glass) as a synonym for getting an insight how a finite element analysis code looks like under the hood.

📦 Installation

Install Python, open a terminal and run

pip install felupe[all]

The documentation covers more details, like required and optional dependencies and how to install the latest development version.

🚀 Getting Started

This minimal code-block demonstrates a nonlinear simulation of a hyperelastic cube under compression.

import felupe as fem

mesh = fem.Cube(n=8)
region = fem.RegionHexahedron(mesh)
field = fem.FieldContainer(fields=[fem.Field(region, dim=3)])

boundaries, loadcase = fem.dof.uniaxial(field, clamped=True, move=-0.3)
solid = fem.SolidBody(umat=fem.NeoHooke(mu=1, bulk=5), field=field)

step = fem.Step(items=[solid], boundaries=boundaries)
job = fem.Job(steps=[step]).evaluate()

solid.plot("Principal Values of Cauchy Stress").show()

Solid Body

📖 Documentation

The documentation is located here.

🧩 Extension Packages

The capabilities of FElupe may be enhanced with extension packages created by the community.

Package Description
hyperelastic Constitutive hyperelastic material formulations
matadi Material Definition with Automatic Differentiation (AD)
tensortrax Differentiable Tensors based on NumPy Arrays
feplot A visualization tool for FElupe

🛠️ Testing

To run the FElupe unit tests, check out this repository and type

tox

📝 Scientific Publications

A list of articles in which FElupe is involved. If you use FElupe in your scientific work, please star this repository, cite it DOI and add your publication to this list.

Expand the list...

📄 Changelog

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

📚 References

[1] T. Gustafsson and G. McBain, "scikit-fem: A Python package for finite element assembly", Journal of Open Source Software, vol. 5, no. 52. The Open Journal, p. 2369, Aug. 21, 2020. DOI:10.21105/joss.02369.

[2] J. Bonet and R. D. Wood, "Nonlinear Continuum Mechanics for Finite Element Analysis". Cambridge University Press, Mar. 13, 2008. DOI:10.1017/cbo9780511755446.

[3] K. J. Bathe, "Finite Element Procedures". 2006, isbn: 978-0-9790049-0-2.

[4] O. C. Zienkiewicz, R. L. Taylor and J. Z. Zhu, "The Finite Element Method: its Basis and Fundamentals". Elsevier, 2013. DOI:10.1016/c2009-0-24909-9.

🔓 License

FElupe - finite element analysis (C) 2021-2025 Andreas Dutzler, Graz (Austria).

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.