example_pkg

Search symbols

Type part of a name or a dotted path

A tiny package, so the example site has an API reference to render.

Classes

Name	Description
Grid	A uniform grid of cells on [start, stop].

Functions

Name	Description
linspace_midpoints	The midpoints of cells uniform cells on [start, stop].

Modules

• gridA uniform 1D grid.

Gridclassdataclass#

Re-exported from example_pkg.gridView source

class Grid(start: float, stop: float, cells: int)

A uniform grid of cells on [start, stop].

Attributes

Name	Type	Description
start	float	Left end of the domain.
stop	float	Right end of the domain.
cells	int	Number of cells.

cellsattributeinstance attribute#

View source

cells: int

startattributeinstance attribute#

View source

start: float

stopattributeinstance attribute#

View source

stop: float

spacingproperty#

View source

spacing: float

The cell width $h = (b - a) / n$.

nodesmethod#

View source

def nodes() -> np.ndarray

The cells + 1 cell boundaries.

Returns

np.ndarray

The node coordinates.

linspace_midpointsfunction#

Re-exported from example_pkg.gridView source

def linspace_midpoints(start: float, stop: float, cells: int) -> np.ndarray

The midpoints of cells uniform cells on [start, stop].

Parameters

Name	Type	Description
start	float	Left end of the domain.
stop	float	Right end of the domain.
cells	int	Number of cells.

Returns

np.ndarray

An array of length cells.