Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 3.86 KB

index.rst

File metadata and controls

99 lines (69 loc) · 3.86 KB

Mint User Guide

Mint provides a comprehensive mesh data model and a mesh-aware, fine-grain, parallel execution model that underpins the development of computational tools and numerical discretization methods. Thereby, enable implementations that are born parallel and portable to new and emerging architectures.

API Documentation

Doxygen generated API documentation can be found here: API documentation

Key Features

Requirements

Mint is designed to be light-weight and self-contained. The only requirement for using Mint is a C++11 compliant compiler. However, to realize the full spectrum of capabilities, support for the following third-party libraries is provided:

For further information on how to build the Axom Toolkit using these third-party libraries, consult the Axom Quick Start Guide.

About this Guide

This guide discusses the basic concepts and architecture of Mint.

  • The :ref:`sections/mint/getting_started` section provides a quick introduction to Mint, designed to illustrate high-level concepts and key capabilities, in the context of a small working example.
  • The :ref:`sections/tutorial` section provides code snippets that demonstrate specific topics in a structured and simple format.
  • For complete documentation of the interfaces of the various classes and functions in Mint consult the Mint Doxygen API Documentation.
  • Complete examples and code walk-throughs of mini-apps using Mint are provided in the :ref:`sections/examples` section.

Additional questions, feature requests or bug reports on Mint can be submitted by creating a new issue on Github or by sending e-mail to the Axom Developers mailing list at axom-dev@llnl.gov.

.. toctree::
   :caption: Contents

   sections/getting_started.rst
   sections/preliminary_concepts.rst
   sections/mesh_representation.rst
   sections/mesh_types.rst
   sections/architecture.rst
   sections/execution_model.rst
   sections/fem.rst
   sections/tutorial.rst
   sections/examples.rst
   sections/faq.rst
   sections/appendix.rst