dolfinx-external-operator

dolfinx-external-operator is a framework implementing the concept of external operators within DOLFINx and aims to define constitutive models of solid mechanics via third-party software in FEniCSx.

Additionally, the framework shows how DOLFINx can be extended by enabling the general automatic differentiation (AD) techniques through the JAX library.

Documentation

In the documentation, you can find the implementation of

• von Mises plasticity via Numba,
• Mohr-Coulomb plasticity with apex smoothing via JAX.

Installation

From the source directory:

pip install .

Building Documentation

pip install .[docs]
cd build/
jupyter-book build .

and follow the instructions printed.

Development

To continuously build and view the documentation in a web browser

pip install sphinx-autobuild
cd build/
jupyter-book config sphinx .
sphinx-autobuild . _build/html -b html

To check and fix formatting

pip install `.[lint]`
ruff check .
ruff format .

Citation

If you use dolfinx-external-operator in your research, please cite the following publication (BibLaTex):

@inproceedings{ORBi-bd33839e-f32f-4005-b706-a618d5bf1b0d,
	AUTHOR = {Latyshev, Andrey and Bleyer, Jérémy and Hale, Jack and Maurini, Corrado},
	TITLE = {A framework for expressing general constitutive models in FEniCSx},
	LANGUAGE = {English},
    BOOKTITLE = {CSMA 2024},
	YEAR = {February 2024},
	SIZE = {8},
	LOCATION = {Giens, France},
}

@software{Latyshev2024dolfinx-external-operator,
  title = {dolfinx-external-operator: v.0.0.1},
  author = {Latyshev, Andrey and Hale, Jack},
  date = {2024},
  doi = {10.5281/zenodo.10907418},
  organization = {Zenodo}
}