From c6dc0fb5661e29b572b3051647f13b233d32ea35 Mon Sep 17 00:00:00 2001
From: Ann Almgren <asalmgren@lbl.gov>
Date: Wed, 17 Oct 2018 18:01:10 -0700
Subject: [PATCH] Add intro and move existing Intro into Getting Started
---
docs/source/GettingStarted.rst | 14 ++++++++++++
docs/source/Introduction.rst | 39 ++++++++++++++++++++++++++--------
docs/source/index.rst | 1 +
3 files changed, 45 insertions(+), 9 deletions(-)
create mode 100644 docs/source/GettingStarted.rst
diff --git a/docs/source/GettingStarted.rst b/docs/source/GettingStarted.rst
new file mode 100644
index 0000000..d84b219
--- /dev/null
+++ b/docs/source/GettingStarted.rst
@@ -0,0 +1,14 @@
+.. _Chap:GettingStarted
+
+Getting Started
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ Structure
+ BuildingCMake
+ BuildingGMake
+ RunningTestSuite
+ RegressionTesting
+
diff --git a/docs/source/Introduction.rst b/docs/source/Introduction.rst
index dc0c3e3..d3902c9 100644
--- a/docs/source/Introduction.rst
+++ b/docs/source/Introduction.rst
@@ -1,14 +1,35 @@
-.. _Chap:Introduction
-
MFiX-Exa Introduction
==================
-.. toctree::
- :maxdepth: 1
+MFiX-Exa is a new massively parallel code for computing multiphase
+flow in which solid particles interact with the gas surrounding them.
+
+It is built on top of AMReX, a publicly available software framework designed for building
+massively parallel block-structured adaptive mesh refinement (AMR)
+applications.
+
+MFiX-Exa relies on the same fundamental physics as in MFIX but the spatial and
+time discretizations differ. Specifically,
+
+- Fluid velocity is defined at cell centers; pressure is defined at nodes.
+
+- The advection algorithm includes an intermediate MAC projection for face-centered
+ advection velocities
+
+- Incompressibility of the fluid is imposed through the use of a projection at the
+ end of the time step rather than through SIMPLE iterations
+
+- The representation of the complex geometry includes mesh refinement around the
+ fluid-solid interface, which is represented used the embedded boundary, or
+ cut-cell approach
+
+- Parallelization via flat MPI, OpenMP, hybrid MPI/OpenMP, or MPI/MPI.
+
+- Porting of MFiX-Exa to GPUs is in progress.
+
+- Parallel I/O using AMReX native I/O or HDF5.
+
+- Plotfile format supported by AmrVis, VisIt, ParaView, and yt.
- Structure
- BuildingCMake
- BuildingGMake
- RunningTestSuite
- RegressionTesting
+MFiX-Exa is being developed at NETL, LBNL, and CU as part of DOE's Exascale Computing Project.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 1c1b6e7..fa73cba 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -21,6 +21,7 @@ the master branch at the beginning of each month.
:caption: Contents:
Introduction
+ GettingStarted
Particle
ParticleBasics
ParticleFluid
--
GitLab