Commit f42d9698 authored by Charles G Waldman's avatar Charles G Waldman
Browse files

Update docs (!197)

parent 9eb9d4cc

docs/source_docs/user_guide/inputs/advanced.rst

+5 −5
Changes for docs/source_docs/user_guide/inputs/advanced.rst: 5 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -32,11 +32,11 @@ The following inputs must be preceded by the prefix ``amrex``: 
+------------------------+-----------------------------------------------------------------------+-------------+--------------+

|                        | Description                                                           |   Type      | Default      |

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

| fpe_trap_invalid       |  Abort if an invalid floating point exception is encountered.         |  Int        | 0            |

| fpe_trap_invalid       |  Abort if an invalid floating point exception is encountered.         |  Bool       | false        |

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

| fpe_trap_zero          |  Abort if a division by zero is computed.                             |  Int        | 0            |

| fpe_trap_zero          |  Abort if a division by zero is computed.                             |  Bool       | false        |

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

| fpe_trap_overflow      |  Abort if an overflow is detected.                                    |  Int        | 0            |

| fpe_trap_overflow      |  Abort if an overflow is detected.                                    |  Bool       | false        |

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



GPU memory
@@ -47,12 +47,12 @@ The following inputs must be preceded by the prefix ``amrex``: 
+----------------------------+-----------------------------------------------------------------------+-------------+---------------+

|                            | Description                                                           |   Type      | Default       |

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

| the_arena_is_managed       | Use managed memory for the main arena.                                |  Int        | 0             |

| the_arena_is_managed       | Use managed memory for the main arena.                                |  Bool       | false         |

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

| the_arena_init_size        | Initial size of main memory arena (bytes).  If not specified, use     |  Int        | Unspecified   |

|                            | 3/4 of system device memory.                                          |             |               |

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

| abort_on_out_of_gpu_memory | Abort if free device memory is less than the amount an arena is       |  Int        | 0             |

| abort_on_out_of_gpu_memory | Abort if free device memory is less than the amount an arena is       |  Bool       | false         |

|                            | asked to allocate.                                                    |             |               |

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

| use_gpu_aware_mpi          | For GPU runs,controls the memory type used for AMReX's communication  |  Bool       | false         |

docs/source_docs/user_guide/inputs/chemical_reactions.rst

+6 −6
Changes for docs/source_docs/user_guide/inputs/chemical_reactions.rst: 6 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -176,10 +176,10 @@ to chemical reactions. 
  #----------------------------------------------------------------------

  species.solve  =  CH4  H2  CO  H2O  CO2  O2  N2  Fe2O3  FeO  inert



  species.diffusivity = constant

  species.diffusivity.model     = constant

  species.diffusivity.constant  =  2.31000e-5  # m^2 / sec



  species.specific_heat = NASA7-poly

  species.specific_heat.model = NASA7-poly



  # Methane

  species.CH4.molecular_weight  = 16.04276e-3
@@ -281,12 +281,12 @@ to chemical reactions. 


  fluid.species =  CH4  H2  CO  H2O  CO2  O2  N2



  fluid.viscosity          = constant

  fluid.viscosity.constant = 4.73e-5  #air @ 1200K

  fluid.viscosity.molecular.model    = constant

  fluid.viscosity.molecular.constant = 4.73e-5  #air @ 1200K



  fluid.specific_heat = mixture



  fluid.thermal_conductivity          = constant

  fluid.thermal_conductivity.model    = constant

  fluid.thermal_conductivity.constant = 0.024
@@ -297,7 +297,7 @@ to chemical reactions. 


  solids.species  =  Fe2O3  FeO  inert



  solids.specific_heat = mixture

  solids.specific_heat.model = mixture





  # Chemistry model settings