josie.boundary package¶

Submodules¶

josie.boundary.boundary module¶

This module implements the different curve parametrization to describe the boundaries of a domain

class josie.boundary.boundary.Boundary(side, curve, cells_idx, ghost_cells_idx)¶

Bases: object

A simple dataclass coupling a BoundaryCurve with the indices of the cells within the Mesh.centroids data structure that are part of that boundary cells_idx, the side of the boundary (class:BoundarySide), and the corresponding indices of the ghost cells within the Mesh._centroids

side¶

The BoundarySide which the Boundary is member of

Type: josie.boundary.boundary.BoundarySide

boundary_curve¶: The BoundaryCurve

cells_idx¶

The cell indices. It’s a tuple containing MAX_DIMENSIONALITY MeshIndex elements. Each element indexes the structured Mesh on one axis to provide the cells that are part of the BoundaryCurve.

Type: Union[Tuple[Union[int, slice, numpy.ndarray], …], numpy.ndarray]

ghost_cells_idx¶

The ghost cell indices. It’s a tuple containing MAX_DIMENSIONALITY MeshIndex elements. Each element indexes the structured Mesh on one axis to provide the cells that are part of the BoundaryCurve.

Type: Union[Tuple[Union[int, slice, numpy.ndarray], …], numpy.ndarray]

Example

For example the left boundary of a 2D structured mesh will be given by a tuple (0, None). That means that if we consider the Solver, we can access the values of the fields associated to the boundary cells by:

solver.values[0, :]

apply_bc(cells, t)¶: Proxy method to BoundaryCurve.bc()

cells_idx: Union[Tuple[Union[int, slice, numpy.ndarray], ...], numpy.ndarray]¶

curve: josie.boundary.boundary.BoundaryCurve¶

ghost_cells_idx: Union[Tuple[Union[int, slice, numpy.ndarray], ...], numpy.ndarray]¶

init_bc(cells)¶: Proxy method to BoundaryCurve.init()

side: josie.boundary.boundary.BoundarySide¶

class josie.boundary.boundary.BoundaryCurve¶

Bases: object

A class representing a BoundaryCurve. A BoundaryCurve is parametrized with a single parameter. It implements a __call__() method that returns the $(x,y)$ values of the curve for a given $\xi$ parameter value.