Merge pull request #5 from LLNL/feature/zagaris2/mint-user-guide

Mint User Guide

src/axom/core/numerics/Matrix.hpp

@@ -308,7 +308,7 @@ class Matrix
    *  ...
    * \endcode
    */
-  const T* getColumn( IndexType j ) const;
+  AXOM_HOST_DEVICE const T* getColumn( IndexType j ) const;
 
   /*!
    * \brief Returns pointer to the \f$ jth \f$ column of an \f$ M \times N \f$
@@ -329,7 +329,7 @@ class Matrix
    *  ...
    * \endcode
    */
-  T* getColumn( IndexType j );
+  AXOM_HOST_DEVICE T* getColumn( IndexType j );
 
   /*!
    * \brief Returns a const pointer for strided access along the main diagonal.
@@ -768,15 +768,15 @@ AXOM_HOST_DEVICE T& Matrix< T >::operator()(IndexType i, IndexType j)
 
 //-----------------------------------------------------------------------------
 template < typename T >
-const T* Matrix< T >::getColumn( IndexType j ) const
+AXOM_HOST_DEVICE const T* Matrix< T >::getColumn( IndexType j ) const
 {
   assert( (j>=0) && (j < m_cols) );
   return &m_data[ j*m_rows ];
 }
 
 //-----------------------------------------------------------------------------
 template < typename T >
-T* Matrix< T >::getColumn( IndexType j )
+AXOM_HOST_DEVICE T* Matrix< T >::getColumn( IndexType j )
 {
   assert( (j>=0) && (j < m_cols) );
   return &m_data[ j*m_rows ];

src/axom/mainpage.md

@@ -7,7 +7,7 @@ Axom provides libraries that address common computer science needs.  It grew fro
 
 * @subpage coretop provides shared utility functionality to all components.
 * @subpage lumberjacktop provides logging aggregation and filtering capability.
-* @subpage minttop provides a mesh representation with finite element operations.
+* @subpage minttop provides a comprehensive mesh data model.
 * @subpage primaltop provides an API for geometric primitives and computational geometry tests.
 * @subpage questtop provides an API to query point distance and position relative to meshes.
 * @subpage sidretop provides a data store with hierarchical structure.

src/axom/mint/README.md

@@ -1,7 +1,17 @@
-Mint: Mesh data model {#minttop}
+Mint: Mesh Data Model {#minttop}
 ============
 
-[Mint](@ref axom::mint) provides a flexible [mesh](@ref axom::mint::Mesh) data model that allows the representation of structured, unstructured, and other mesh types.  Mint also provides an extensible [finite element](@ref axom::mint::FiniteElement) discretization library.
+[Mint](@ref axom::mint) is a C++ library that provides:
 
-The [Mint guide](../../../sphinx/axom_docs/html/axom/mint/docs/sphinx/index.html)
+1. A comprehensive  [mesh](@ref axom::mint::Mesh) data model that can support
+   structured, unstructured and particle mesh discretizations.
+
+2. A mesh-aware execution model that supports on-node fine-grain parallelism for 
+   traversing and operating on a mesh. 
+
+Mint serves as as fundmental building block that underpins the development of
+computational tools and numerical discretization methods, enabling implementations 
+that are born *parallel* and *portable* to new and emerging architectures.
+
+The [Mint User Guide](https://axom.readthedocs.io/en/develop/axom/mint/docs/sphinx/index.html)
 introduces these concepts in more detail.

src/axom/mint/docs/sphinx/index.rst

@@ -1,4 +1,29 @@
-Mint User Documentation
-=======================
+.. ## Copyright (c) 2017-2019, Lawrence Livermore National Security, LLC and
+.. ## other Axom Project Developers. See the top-level COPYRIGHT file for details.
+.. ##
+.. ## SPDX-License-Identifier: (BSD-3-Clause)
 
-TODO:
+================
+Mint User Guide
+================
+
+ .. include:: sections/synopsis.rst
+
+.. toctree::
+   :caption: Table Of Contents
+   :maxdepth: 2
+   :hidden:
+
+   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
+
+.. include:: sections/citations.rst

src/axom/mint/docs/sphinx/sections/appendix.rst

@@ -0,0 +1,49 @@
+.. ## Copyright (c) 2017-2019, Lawrence Livermore National Security, LLC and
+.. ## other Axom Project Developers. See the top-level COPYRIGHT file for details.
+.. ##
+.. ## SPDX-License-Identifier: (BSD-3-Clause)
+
+.. _sections/mint/appendix:
+
+Appendix
+---------
+
+.. _MintApplicationCodeExample:
+
+Mint Application Code Example
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Below is the complete :ref:`MintApplicationCodeExample` presented in
+the :ref:`sections/mint/getting_started` section. The code can be found in the Axom
+source code under ``src/axom/mint/examples/mint_uniform_mesh.cpp``.
+
+.. literalinclude:: ../../../examples/mint_uniform_mesh.cpp
+   :start-after: sphinx_tutorial_basic_example_start
+   :end-before: sphinx_tutorial_basic_example_end
+   :language: C++
+   :linenos:
+
+.. _axomLambdaMacro:
+
+AXOM_LAMBDA Macro
+^^^^^^^^^^^^^^^^^
+
+The ``AXOM_LAMBDA`` convenience macro expands to:
+
+ * ``[=]`` capture by value when the `Axom Toolkit`_ is compiled without CUDA.
+ * ``[=] __host__ __device__`` when the `Axom Toolkit`_ is compiled with CUDA
+
+.. _rawSidreData:
+
+Raw Sidre Data
+^^^^^^^^^^^^^^
+
+.. literalinclude:: raw_sidre_data.txt
+   :language: json
+   :linenos:
+
+.. #############################################################################
+..  CITATIONS
+.. #############################################################################
+
+.. include:: citations.rst