import numpy as np
from .._mesh import Mesh
from ._structured_grid import structured_grid
__all__ = [
"cylindric_grid",
]
class CylindricMesh(Mesh):
def __init__(self, dr, dz, layer, *args, **kwargs):
"""
Cylindric mesh.
This class is only intended to be used as output of :func:`cylindric_grid`.
Note
----
This class inherits from :class:`toughio.Mesh` but overwrites how face areas
and volumes are calculated.
"""
super(CylindricMesh, self).__init__(*args, **kwargs)
self._dr = dr
self._dz = dz[::-1] # From top to bottom
self._layer = layer
def _get_areas_heights(self):
"""Return areas and heights of cells in mesh."""
nr, nz = len(self._dr), len(self._dz)
r2 = np.cumsum(self._dr) ** 2
areas = np.tile(np.concatenate(([r2[0]], r2[1:] - r2[:-1])), nz) * np.pi
heights = np.tile(self._dz[:, None], nr).ravel()
return areas, heights
@property
def face_areas(self):
"""Areas of faces in mesh."""
nr, nz = len(self._dr), len(self._dz)
dr = np.concatenate(([0.0], self._dr))
perimeters_in = np.tile(np.cumsum(dr[:-1]), nz) * 2.0 * np.pi
perimeters_out = np.tile(np.cumsum(dr[1:]), nz) * 2.0 * np.pi
areas, heights = self._get_areas_heights()
sections = np.tile(self._dr, nz) * heights
out = np.transpose(
[
areas,
areas,
sections,
perimeters_out * heights,
sections,
perimeters_in * heights,
]
)
return (
out
if self._layer
else out.reshape((nz, nr, 6)).reshape((nz * nr, 6), order="F")
)
@property
def volumes(self):
"""Volumes of cell in mesh."""
nr, nz = len(self._dr), len(self._dz)
areas, heights = self._get_areas_heights()
out = areas * heights
return out if self._layer else out.reshape((nz, nr)).ravel(order="F")
[docs]def cylindric_grid(dr, dz, origin_z=None, layer=False, material="dfalt"):
"""
Generate a cylindric mesh as a radial XZ structured grid.
Parameters
----------
dr : array_like
Grid spacing along X axis.
dz : array_like
Grid spacing along Z axis.
origin_z : scalar, optional, default None
Depth of origin point.
layer : bool, optional, default False
If `True`, mesh will be generated by layers.
material : str, optional, default 'dfalt'
Default material name.
Returns
-------
toughio.Mesh
Output cylindric mesh.
"""
if not isinstance(dr, (list, tuple, np.ndarray)):
raise TypeError()
if not isinstance(dz, (list, tuple, np.ndarray)):
raise TypeError()
if not (origin_z is None or isinstance(origin_z, (int, float))):
raise TypeError()
if not isinstance(material, str):
raise TypeError()
dr = np.asarray(dr)
dz = np.asarray(dz)
if not (dr >= 0.0).all():
raise ValueError()
if not (dz >= 0.0).all():
raise ValueError()
origin_z = origin_z if origin_z is not None else -dz.sum()
mesh = structured_grid(
dr, [1.0], dz, origin=[0.0, -0.5, origin_z], layer=layer, material=material,
)
return CylindricMesh(
dr,
dz,
layer,
points=mesh.points,
cells=mesh.cells,
point_data=mesh.point_data,
cell_data=mesh.cell_data,
field_data=mesh.field_data,
)