Main SfePy repository
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
deployment-CI Add updated configs for Travis/AppVeyor testing. Sep 5, 2017
doc docs: http -> https in sfepy-related links Nov 30, 2018
examples update tests and examples for current ScipyEigenvalueSolver Dec 13, 2018
meshes new meshes/2d/cross-51-0.34.mesh Nov 15, 2018
script script/plot_mesh.py: new --no-axes, --no-show, figname options Dec 1, 2018
sfepy Merge branch 'allow-n-eigs-none' Dec 14, 2018
tests update tests and examples for current ScipyEigenvalueSolver Dec 13, 2018
.appveyor.yml Changed 'version' statement. Oct 11, 2018
.gitignore Add solver_table.rst (gen_solver_table.py output) to .gitignore. Mar 19, 2018
.travis.yml Add re-run tests with --raise switch in case of failure. Sep 5, 2017
AUTHORS update AUTHORS Dec 27, 2017
INSTALL docs: http -> https in sfepy-related links Nov 30, 2018
LICENSE update years in LICENSE Apr 17, 2014
MANIFEST.in fix path in MANIFEST.in Sep 23, 2015
Makefile python setup.py ... via Makefile May 31, 2011
README.rst docs: http -> https in sfepy-related links Nov 30, 2018
btrace_python started SfePy, based on sfe-release-00.35.01.tgz Dec 19, 2007
build_helpers.py Manually fix syntax in some support files Jun 15, 2016
extractor.py Fix redefining help Dec 8, 2016
homogen.py Fix redefining help Dec 8, 2016
phonon.py Fix redefining help Dec 8, 2016
postproc.py Fix redefining help Dec 8, 2016
probe.py Fix redefining help Dec 8, 2016
run_tests.py Fix redefining help Dec 8, 2016
setup.py update setup.py files Nov 24, 2018
sfepy-run update sfepy-run Nov 24, 2018
simple.py fix PDESolverApp / EVPSolverApp selection Nov 26, 2018
simple_homog_mpi.py new `simple_homog_mpi` solver - allows to run parallel micro-macro co… Jul 25, 2017
site_cfg_template.py support DEBUG_MESH flag in sfepy/fem/extmods/ May 20, 2013
test_install.py update test_install.py Nov 24, 2018

README.rst

CI

SfePy (Simple finite elements in Python)

SfePy [1] is a software for solving systems of coupled partial differential equations (PDEs) by the finite element method in 1D, 2D and 3D. It can be viewed both as black-box PDE solver, and as a Python package which can be used for building custom applications. The word "simple" means that complex FEM problems can be coded very easily and rapidly. Its source code can be found on github [2].

SfePy is based primarily on NumPy [3] and SciPy [4]. See the INSTALL file for installation instructions or refer to [1].

  • License: New BSD License, see the LICENSE file.
  • Authors: Robert Cimrman and Contributors, see the AUTHORS file.

How to start

SfePy uses so called "problem definition files" (also referred to as "input files" or "problem description files"") that describe the partial differential equations (PDEs), boundary conditions, function spaces and other ingredients of the finite element (FE) formulation of a PDE-related problem, see [1]. The PDEs are given in weak formulation as usual in the FE context, see [5], where each equation is composed of one or more terms. To see which terms are available consult doc/sfepy_manual.pdf, or see them online [6].

In order to solve a problem, a problem description file has to be created. There is also an interactive solution support for advanced users [7]. When starting to solve a new problem, it is best to have a look at example problem definition files in the examples/ directory - copy the one that is similar to the problem at hand, and modify it.

While a problem definition file describes a mathematical problem, it does not contain a discretized solution domain (a FE mesh). The FE mesh must be provided in another file in one of the supported formats, notably the legacy VTK format [8]. SfePy does not provide meshing tools, but it can use a number of standard formats. The results are almost exclusively stored in legacy VTK files, or custom HDF5 files. Many standard open-source tools can be used to display the VTK files, namely paraview [9], or mayavi [10]. The latter is supported directly within SfePy, via the postproc.py script.

Once an input file and a corresponding mesh file are prepared, the solution of the problem can be attempted using the simple.py script, see the documentation.

References

[1](1, 2, 3) https://sfepy.org - main SfePy development site (releases, mailing lists, wiki, issue tracking, downloads, documentation, examples)
[2]https://github.com/sfepy - master git repository
[3]http://numpy.org
[4]http://scipy.org
[5]http://en.wikipedia.org/wiki/Weak_formulation
[6]https://docs.sfepy.org/doc/terms_overview.html
[7]https://docs.sfepy.org/doc/tutorial.html#interactive-example-linear-elasticity
[8]http://www.vtk.org/VTK/img/file-formats.pdf
[9]http://paraview.org/
[10]http://code.enthought.com/projects/mayavi/