darsia.ExtrudedPorousGeometry#

class ExtrudedPorousGeometry(porosity, depth, space_dim, num_voxels, dimensions=None, voxel_size=None, **kwargs)[source]#

Bases: WeightedGeometry

Class containing information of a porous geometry.

Constructor for extruded, porous, two-dimensional geometry.

Parameters:
porosityfloat or array

Porosity.

depthfloat or array

Effective depth.

space_dimint

See Geometry.

num_voxelstuple

See Geometry.

dimensionslist

See Geometry.

voxel_sizelist

See Geometry.

Methods

integrate(data)

Integrate data over the entire geometry.

make_extensive(data)

Convert intensive values to integrated per-cell values on geometry grid.

normalize(img, img_ref[, return_ratio])

Normalize image with respect to another one, such that both have the same integral.

subregion(roi)

Extract subregion of the geometry.

update(depth)

Update effective depth and recompute weighted volume.

Attributes

weight

Weight of the geometry, can be a scalar or an array.

voxel_volume

Effective voxel volume in 3d.

cached_voxel_volume

Internal copy of the voxel volume for efficient integration.

space_dim

Spatial dimension of geometry.

num_voxels

Number of voxels in each spatial direction.

voxel_size

Dimensions of a single voxel.

dimensions

Dimensions of geometry.

update(depth)[source]#

Update effective depth and recompute weighted volume.

Parameters:
depthfloat or array

Effective depth.