Skip to main content

Computational Adjoint-Based Shape Optimization and Optimal Control Software

Project description

CASHOCS

pypi https://zenodo.org/badge/DOI/10.5281/zenodo.4035940.svg Documentation Status license

CASHOCS is a computational adjoint-based shape optimization and optimal control software for python.

CASHOCS is based on the finite element package FEniCS and uses its high-level unified form language UFL to treat general PDE constrained optimization problems, in particular, shape optimization and optimal control problems.

Note, that we assume that you are (at least somewhat) familiar with PDE constrained optimization and FEniCS. For a introduction to these topics, we can recommend the textbooks

However, the CASHOCS tutorial also gives many references either to the underlying theory of PDE constrained optimization or to relevant demos and documentation of FEniCS.

Note, that the full CASHOCS documentation is available at https://cashocs.readthedocs.io/en/latest/index.html.

Installation

  • First, install FEniCS, version 2019.1. Note, that FEniCS should be compiled with PETSc and petsc4py.

  • Then, install meshio, with a h5py version that matches the HDF5 version used in FEniCS, and matplotlib. The version of meshio should be at least 4, but for compatibility it is recommended to use either use meshio 4.1 or 4.2.

  • You might also want to install GMSH, version 4.6. CASHOCS does not necessarily need this to function properly, but it is required for the remeshing functionality.

  • You can install CASHOCS via the PYPI:

    pip3 install cashocs

    You can install the newest (development) version of CASHOCS with:

    pip3 install git+https://github.com/sblauth/cashocs.git
  • To get the latest (development) version of CASHOCS, clone this repository with git and install it with pip

    git clone https://github.com/sblauth/cashocs.git
    cd cashocs
    pip3 install .

Usage

The complete CASHOCS documentation is available here https://cashocs.readthedocs.io/en/latest/index.html. For a detailed introduction, see the CASHOCS tutorial. The python source code for the demo programs is located inside the “demos” folder.

License

CASHOCS 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.

CASHOCS 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 CASHOCS. If not, see <https://www.gnu.org/licenses/>.

Contact / About

I’m Sebastian Blauth, a PhD student at Fraunhofer ITWM and TU Kaiserslautern, and I developed this project as part of my work. If you have any questions / suggestions / feedback, etc., you can contact me via sebastian.blauth@itwm.fraunhofer.de or sebastianblauth@web.de.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cashocs-1.0.1.tar.gz (78.0 kB view hashes)

Uploaded Source

Built Distribution

cashocs-1.0.1-py3-none-any.whl (115.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page