Commit f7f8a03f authored by Ann Almgren's avatar Ann Almgren
Browse files

Adding info about gmake

parent f32aa424

docs/source/Building.rst→docs/source/BuildingCMake.rst

+3 −3
Original line number Diff line number Diff line 
Building MFiX-Exa

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

Building MFiX-Exa with CMake

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



There are two options to building MFiX-Exa:

There are two options to building MFiX-Exa with cmake:



o **SUPERBUILD (default):** Utilities download and build AMReX as part

of the MFiX-Exa build process. This method is strongly encouraged as it

docs/source/BuildingGMake.rst

0 → 100644
+53 −0
Original line number Diff line number Diff line 
Building MFiX-Exa with gmake

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



Building MFiX-Exa with gmake 



If you want to use gmake to build MFiX_Exa, you will need to have already

cloned amrex into a local directory:



.. code:: shell



    > git clone https://github.com/amrex-codes/amrex



If you want to run MFIX-Exa using the SIMPLE algorithm or the projection

method with normal velocity components defined on faces, then the easiest

way to build it is:



.. code:: shell



    > git clone http://mfix.netl.doe.gov/gitlab/exa/mfix.git

    > cd mfix/exec



(If you want to run MFIX-Exa using the projection method with cell-centered

velocity components, replace exec above with exec_cc)



Edit the GNUmakefile to set AMREX_HOME to be the path to the directory

where you have put amrex.  Other options that you can set include



+-----------------+------------------------------+------------------+-------------+

| Option name     | Description                  | Possible values  | Default     |

|                 |                              |                  | value       |

+=================+==============================+==================+=============+

| COMP            | Compiler (gnu or intel)      | gnu / intel      | None        |

+-----------------+------------------------------+------------------+-------------+

| USE_MPI         | Whether to enable MPI        | TRUE / FALSE     | FALSE       |

+-----------------+------------------------------+------------------+-------------+

| USE_OMP         | Whether to enable OpenMP     | TRUE / FALSE     | FALSE       |

+-----------------+------------------------------+------------------+-------------+

| DEBUG           | Whether to use DEBUG mode    | TRUE / FALSE     | FALSE       |

+-----------------+------------------------------+------------------+-------------+

| PROFILE         | Include profiling info       | TRUE / FALSE     | FALSE       |

+-----------------+------------------------------+------------------+-------------+

| TINY_PROFILE    | Include tiny profiling info  | TRUE / FALSE     | FALSE       |

+-----------------+------------------------------+------------------+-------------+

| COMM_PROFILE    | Include comm profiling info  | TRUE / FALSE     | FALSE       |

+-----------------+------------------------------+------------------+-------------+

| TRACE_PROFILE   | Include trace profiling info | TRUE / FALSE     | FALSE       |

+-----------------+------------------------------+------------------+-------------+



Then type



.. code:: shell



    > make

docs/source/Introduction.rst

+2 −1
Original line number Diff line number Diff line
@@ -7,7 +7,8 @@ MFiX-Exa Introduction 
   :maxdepth: 1



   Structure

   Building

   BuildingCMake

   BuildingGMake

   RunningTestSuite

   RegressionTesting

docs/source/ParticleBasics.rst

+5 −7
Original line number Diff line number Diff line
@@ -9,13 +9,11 @@ Particle Basics 


In MFiX-Exa, particles are managed by the `MFIXParticleContainer

<https://amrex-codes.github.io/MFIX-Exa/doxygen/class_m_f_i_x_particle_container.html>`_

class.  This class is derived from AMReX's :cpp:`NeighbourParticleContainer`

and handles all of the particle data. Most importantly,

:cpp:`MFIXParticleContainer` also provides the functions for solving the

class.  This class is derived from AMReX's :cpp:`NeighborParticleContainer`

and handles all of the particle data. 

:cpp:`MFIXParticleContainer` provides the functions for solving the

particle dynamics (based on particle-particle, particle-fluid, and

particle-wall forces). Most importantly, :cpp:`MFIXParticleContainer` also

provides the functions for solving the particle dynamics (based on

particle-particle, particle-fluid, and particle-wall forces).

particle-wall forces)





Particle Dynamics
@@ -45,7 +43,7 @@ method. It's structure is: 


    while (n < nsubsteps) // step over number of substeps (DES part)

    {

        // Neighbourlist house-keeping

        // Neighborlist house-keeping

        if (n % 25 == 0) {

            clearNeighbors(lev);

            Redistribute();