Welcome to Muscat’s documentation!

Table of Contents

• Getting Started
  • What is Muscat
  • Install Muscat
  • Your First Script
  • Asking for Help
  • Contributing to Muscat
  • Citing Muscat
  • Muscat License
  • External Contributions
• Installing Muscat
  • Conda
  • PIP
  • Manual Installation (from Sources) for Developers
  • Requirements
• Muscat Cheat Sheet
  • Mesh Import, Export and Creation
  • Mesh Manipulation
  • Field Manipulation
• Examples
  • Examples of usage of filters
  • Pre/Post deep learning
  • Two inclusions mechanical analysis
  • Distance computation from a surface mesh
  • Field Transfer Threads Performance
  • Dump mesh into a XDMF file
  • Export Data in separated variables (PXDMF Format)
  • Mesh adaption
  • Computation of strains using Muscat Integrator
• Principles
  • Containers
  • Filters
  • Fields
  • Fields Transfer
  • Solving Linear Systems
  • Parallel Computations
• Tools
  • ParaView And Others External Tools
  • Mesh File Converter
  • Utilities

Developer documentation

• Overview
  • Architecture of the Project
  • Folder Architecture
• CMake
  • Architecture of the Build System
  • CMake Compilation
  • Notes for Maintaining the Build System
• Cython
  • Overview
  • Interfacing with Cpp
  • Numpy and Eigency
  • Compilation
• Elements
  • Overview
  • Descriptions of the Elements
• Kokkos
• Testing Infrastructure
  • Coverage
  • Disabling Tests
• Muscat Cpp API
  • Containers
  • Finite Element Tools
  • Helper Functions
  • Implicit Geometry Engine
  • Linear Algebra Tools

Indices and tables

• Index

• Module Index