Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
WeiqunZhang committed Sep 5, 2024
1 parent 645e21f commit 8303e8f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions Docs/sphinx_documentation/source/EB.rst
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,12 @@ following data:
// embedded boundary centroid
const MultiCutFab& getBndryCent () const;

// embedded boundary normal direction
const MultiCutFab& getBndryNormal () const;

// embedded boundary surface area
const MultiCutFab& getBndryArea () const;

// area fractions
Array<const MultiCutFab*,AMREX_SPACEDIM> getAreaFrac () const;

Expand All @@ -291,6 +297,17 @@ following data:
of the data is in the range of :math:`[-0.5,0.5]`, based on each
cell's local coordinates with respect to the regular cell's center.

- **Boundary normal** is in a :cpp:`MultiCutFab` with ``AMREX_SPACEDIM``
components representing the unit vector pointing toward the covered part.

- **Boundary area** is in a :cpp:`MultiCutFab` with a single component
representing the dimensionless boundary area. When the cell is isotropic
(i.e., :math:`\Delta x = \Delta y = \Delta z`), it's trivial to convert it
to physical units. If the cell size is anisotropic, the conversion
requires multiplying by a factor of :math:`\sqrt{(n_x \Delta y \Delta
z)^2 + (n_y \Delta x \Delta z)^2 + (n_z \Delta x \Delta y)^2}`, where
:math:`n` is the boundary normal vector.

- **Face centroid** is in a :cpp:`MultiCutFab` with ``AMREX_SPACEDIM`` components.
Each component of the data is in the range of :math:`[-0.5,0.5]`, based on
each cell's local coordinates with respect to the embedded boundary.
Expand Down

0 comments on commit 8303e8f

Please sign in to comment.