API Reference

Nothing is exported and nothing is rebound at the package's top level: every name is reached through the submodule that defines it.

using FlowGeometries: FlowGeometries as FG

One page per module — the reference is large enough that a single page is slow to load, and the split keeps each module's surface readable on its own. The index below spans all of them.

FlowGeometries.FlowGeometries — Module

FlowGeometries

Coordinate metrics, spherical samplings, and grid types.

AbstractGeometry
├── AbstractCartesianGeometry  ← CartesianGeometry
└── AbstractSphericalGeometry  ← SphericalGeometry

AbstractSphericalSampling
├── … spectral / lat-lon / HEALPix / cubed-sphere / icosahedral / Yin–Yang / scattered …

AbstractGrid
├── AbstractStructuredGrid     ← StructuredGrid
├── AbstractCurvilinearGrid    ← CurvilinearGrid
└── AbstractUnstructuredGrid   ← UnstructuredGrid

Nothing is exported and nothing is rebound at the top level: every name is reached through the submodule that defines it.

using FlowGeometries: FlowGeometries as FG

geo  = FG.Geometry.SphericalGeometry()
grid = FG.Connectivity.structured_grid(FG.SphericalSampling.GaussLegendreSampling(), 64)
FG.Grids.coords(grid, 2, 3)                  # (λ=, φ=)
FG.Geometry.distance(geo, p1, p2)

Submodules: Axes (coordinate axes and the spacing trait), Geometry (metrics), Stencils (neighbourhood shapes), Discretization (location, interpolation, staggering, derivative weights), SphericalSampling (where the points go), Grids (storage), Connectivity (topology), Operators (everything that reads or writes a field), Execution (how bulk loops run).

source

API Reference

Index