Reorganize a bit the structure of the wall files

doc/index.rst

@@ -70,8 +70,9 @@ Table of Contents
 .. toctree::
     :numbered:
 
-    fluid
+    mathematical/mathematical
     discretization
+    wall_model
     operators/operators
     support/support
     development/development

doc/operators/composite_materials.rst → doc/mathematical/composite_material.rst

@@ -1,30 +1,8 @@
-Wall Degradation Modeling
-=========================
-
-Conserved Quantities
-^^^^^^^^^^^^^^^^^^^^
-.. autoclass:: mirgecom.wall_model.PorousFlowDependentVars
-
-Equations of State
-^^^^^^^^^^^^^^^^^^
-.. autoclass:: mirgecom.wall_model.WallEOS
-.. autoclass:: mirgecom.wall_model.WallDependentVars
-
-Model-specific properties
-^^^^^^^^^^^^^^^^^^^^^^^^^
-    The properties of the materials are defined in specific files. These files
-    are required by :class:`~mirgecom.wall_model.WallEOS`.
-
-Carbon fiber
-------------
-.. automodule:: mirgecom.materials.carbon_fiber
-
-TACOT
------
-.. automodule:: mirgecom.materials.tacot
+Wall Degradation
+================
 
 Carbon Fiber Oxidation 
-^^^^^^^^^^^^^^^^^^^^^^
+----------------------
 
     This section covers the response of carbon fiber when exposed to oxygen.
     The carbon fibers are characterized as a highly porous material,
@@ -35,7 +13,7 @@ Carbon Fiber Oxidation
 
     The temporal evolution of mass density is solved in
     order to predict the material degradation. As the
-    :class:`~mirgecom.materials.carbon_fiber.Oxidation` progresses,
+    :attr:`~mirgecom.materials.carbon_fiber.Oxidation` progresses,
     the temporal evolution of the fibers mass is given by
 
     .. math ::
@@ -77,36 +55,35 @@ Carbon Fiber Oxidation
 
     From the conserved variables, it is possible to compute the oxidation
     progress, denoted by
-    :attr:`~mirgecom.wall_model.WallDependentVars.tau`.
+    :attr:`~mirgecom.wall_model.PorousWallVars.tau`.
     As a consequence, the instantaneous material properties will change due to
     the mass loss.
 
     The
     :attr:`~mirgecom.eos.GasDependentVars.temperature`
     is evaluated using Newton iteration based on both
     :attr:`~mirgecom.eos.PyrometheusMixture.get_internal_energy` and
-    :attr:`~mirgecom.wall_model.WallEOS.enthalpy`,
+    :attr:`~mirgecom.wall_model.PorousWallEOS.enthalpy`,
     as well as their respective derivatives, namely
     :attr:`~mirgecom.eos.PyrometheusMixture.heat_capacity_cv` and
-    :attr:`~mirgecom.wall_model.WallEOS.heat_capacity`.
+    :attr:`~mirgecom.wall_model.PorousWallEOS.heat_capacity`.
     Note that :mod:`pyrometheus` is used to handle the species properties.
 
 Composite Materials
-^^^^^^^^^^^^^^^^^^^
+-------------------
 
     This section covers the response of composite materials made of phenolic
     resin and carbon fibers.
-    The carbon fibers are characterized as a highly porous material,
-    with void fraction $\approx 90\%$. Phenolic resins are added to rigidize
-    the fibers by permeating the material and filling partially the gaps between
-    fibers. As the material is heated up by the flow, the resin pyrolysis, i.e.,
-    it degrades and produces gaseous species.
+    Phenolic resins are added to rigidize the fibers by permeating the
+    material and filling partially the gaps between fibers, reducing the porousity
+    to $\approx 80\%$. As the material is heated up by the flow, the resin
+    pyrolyses, i.e., it degrades and produces gaseous species.
 
-    The temporal evolution of wall density is solved in
-    order to predict the material degradation. As the
+    The temporal evolution of wall density is solved in order to predict the
+    material degradation. As the
     :class:`~mirgecom.materials.tacot.Pyrolysis` progresses, the mass of each 
     $i$ constituents of the resin, denoted by
-    :attr:`~mirgecom.wall_model.PorousFlowDependentVars.material_densities`,
+    :attr:`~mirgecom.wall_model.PorousWallVars.material_densities`,
     is calculated as
 
     .. math ::
@@ -156,40 +133,27 @@ Composite Materials
 
     From the conserved variables, it is possible to compute the decomposition
     status, denoted by
-    :attr:`~mirgecom.wall_model.WallDependentVars.tau`.
+    :attr:`~mirgecom.wall_model.PorousWallVars.tau`.
     This yields the proportion of virgin (unpyrolyzed material) to char (fully
     pyrolyzed) and, consequently, the different thermophysicochemical
     properties of the solid phase. Thus, the instantaneous material properties
     depend on the current state of the material, as well as the 
     :attr:`~mirgecom.eos.GasDependentVars.temperature`.
-    It is evaluated using Newton iteration based on both
-    :attr:`~mirgecom.materials.tacot.GasProperties.enthalpy` (tabulated
-    data) or 
-    :attr:`~mirgecom.eos.PyrometheusMixture.get_internal_energy` (Pyrometheus)
-    and
-    :attr:`~mirgecom.wall_model.WallEOS.enthalpy`,
-    as well as their respective derivatives, namely
-    :attr:`~mirgecom.materials.tacot.GasProperties.heat_capacity` and
-    :attr:`~mirgecom.wall_model.WallEOS.heat_capacity`.
+    It is evaluated using Newton iteration based on
+    :attr:`~mirgecom.eos.PyrometheusMixture.get_internal_energy` and
+    :attr:`~mirgecom.wall_model.PorousWallEOS.enthalpy`,
+    as well as their respective derivatives
+    :attr:`~mirgecom.eos.PyrometheusMixture.heat_capacity_cv` and
+    :attr:`~mirgecom.wall_model.PorousWallEOS.heat_capacity`.
 
     In *MIRGE-Com*, the solid properties are obtained by fitting polynomials
     to tabulated data for easy evaluation of the properties based on the
     temperature. The complete list of properties can be find, for instance, in
     :mod:`~mirgecom.materials.tacot`.
     Different materials can be incorporated as separated files.
-
-    The
-    :class:`~mirgecom.materials.tacot.GasProperties` are obtained based on
-    tabulated data, assuming chemical equilibrium, and evaluated with splines
-    for interpolation of the entries. However, the data is currently obtained
-    by PICA.
 
 .. important ::
 
     The current implementation follows the description of [Lachaud_2014]_ 
     for type 2 code. Additional details, extensive formulation and references
     are provided in https://github.com/illinois-ceesd/phenolics-notes
-
-Helper Functions
-----------------
-.. autofunction:: mirgecom.multiphysics.phenolics.initializer

doc/fluid.rst → doc/mathematical/fluid.rst

@@ -1,6 +1,5 @@
-================================
-Mathematical Model of Fluid Flow
-================================
+Fluid Flow
+==========
 
 .. raw:: latex
 

doc/mathematical/mathematical.rst

@@ -0,0 +1,8 @@
+==================
+Mathematical Model
+==================
+
+.. toctree::
+
+   fluid
+   composite_material

doc/operators/operators.rst

@@ -9,4 +9,3 @@ Operators
    artificial_viscosity
    gas-dynamics
    thermally_coupled
-   composite_materials

doc/wall_model.rst

@@ -0,0 +1,23 @@
+Wall Model
+==========
+
+.. automodule:: mirgecom.wall_model
+
+Material specification
+^^^^^^^^^^^^^^^^^^^^^^
+
+Carbon fiber
+""""""""""""
+.. automodule:: mirgecom.materials.carbon_fiber
+
+TACOT
+"""""
+.. automodule:: mirgecom.materials.tacot
+
+User-defined material
+"""""""""""""""""""""
+.. automodule:: mirgecom.materials.prescribed_porous_material
+
+Helper Functions
+^^^^^^^^^^^^^^^^
+.. automodule:: mirgecom.materials.initializer