Commit 1fa031e9 authored by William D. Fullmer's avatar William D. Fullmer
Browse files

MFiX-Exa -> MFIX-Exa

parent be361f97

docs/doxygen/doxygen.conf

+1 −1
Changes for docs/doxygen/doxygen.conf: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 
# title of most generated pages and in a few other places.

# The default value is: My Project.



PROJECT_NAME           = "MFiX-Exa"

PROJECT_NAME           = "MFIX-Exa"



# The PROJECT_NUMBER tag can be used to enter a project or revision number. This

# could be handy for archiving the generated documentation or if some version

docs/doxygen/main.dox

+1 −1
Changes for docs/doxygen/main.dox: 1 added line, 1 removed line.
Original line number Diff line number Diff line 
/**

\mainpage MFiX-Exa: A multi-phase flow simulation tool based on MFiX-Classic, incorporating the massively parallel, block-structured adaptive mesh refinement (AMR) functionality of AMReX.

\mainpage MFIX-Exa: A multi-phase flow simulation tool based on MFiX-Classic, incorporating the massively parallel, block-structured adaptive mesh refinement (AMR) functionality of AMReX.



AMReX is available at https://github.com/AMReX-Codes/amrex

docs/picvva/source/conf.py

+9 −9
Changes for docs/picvva/source/conf.py: 9 added lines, 9 removed lines.
Original line number Diff line number Diff line
@@ -48,9 +48,9 @@ source_suffix = '.rst' 
master_doc = 'index'



# General information about the project.

project = u'MFiX-Exa'

copyright = u'2017-2018, MFiX-Exa Team'

author = u'MFiX-Exa Team'

project = u'MFIX-Exa'

copyright = u'2017-2018, MFIX-Exa Team'

author = u'MFIX-Exa Team'



# The version info for the project you're documenting, acts as replacement for

# |version| and |release|, also used in various other places throughout the
@@ -148,8 +148,8 @@ latex_elements = { 
# (source start file, target name, title,

#  author, documentclass [howto, manual, or own class]).

latex_documents = [

    (master_doc, 'mfix.tex', u'MFiX-Exa Documentation',

     u'MFiX-Exa Team', 'manual'),

    (master_doc, 'picvva.tex', u'MFIX-Exa PIC VVA Manual',

     u'MFIX-Exa Team', 'manual'),

]
@@ -158,7 +158,7 @@ latex_documents = [ 
# One entry per manual page. List of tuples

# (source start file, name, description, authors, manual section).

man_pages = [

    (master_doc, 'mfix', u'MFiX-Exa Documentation',

    (master_doc, 'picvva', u'MFIX-Exa PIC VVA Manual',

     [author], 1)

]
@@ -169,7 +169,7 @@ man_pages = [ 
# (source start file, target name, title, author,

#  dir menu entry, description, category)

texinfo_documents = [

    (master_doc, 'mfix', u'MFiX-Exa Documentation',

     author, 'MFiX-Exa Term', "MFiX-Exa, it's MFiX... but now with more Exa!",

     'Miscellaneous Aardvark'),

    (master_doc, 'picvva', u'MFIX-Exa PIC VVA Manual',

     author, 'MFIX-Exa Team', "MFIX-Exa Particle-in-Cell Verification, Validation and Applicaiton Manual",

     'Technical Report'),

]

docs/picvva/source/intro.rst

+1 −25
Changes for docs/picvva/source/intro.rst: 1 added line, 25 removed lines.
Original line number Diff line number Diff line 
Introduction

============



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.

Coming soon, Work In Progress... 



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

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

MFiX-Exa is being developed at NETL and LBNL as part of the U.S. Department of

Energy's `Exascale Computing Project (ECP) <https://www.exascaleproject.org/>`_

MFiX-Exa heavily leverages `AMReX`_ which is also supported by ECP as part of

the AMReX Co-Design Center.



.. _AMReX: https://amrex-codes.github.io/

docs/source_docs/CITests.rst

+1 −1
Changes for docs/source_docs/CITests.rst: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ Continuous Integration 
======================



The following regression tests are run every time a commit is pushed to the main

MFiX-Exa repository on the NETL gitlab.

MFIX-Exa repository on the NETL gitlab.



For each of the tests in the chart below, there are

three directional variations; these are identified in the repository as,