Package API
grid_generator
Public package interface for grid_generator.
CartesianConfig
dataclass
Complete configuration for one Cartesian grid.
__post_init__()
Validate output options.
CubicSegment
dataclass
Terminal cubic transition matching the incoming linear region.
__post_init__()
Validate the transition point count.
EquidistantSegment
dataclass
One equidistant region ending at a specified coordinate.
__post_init__()
Require exactly one resolution control.
EquidistantSpec
dataclass
Equally spaced points between two endpoints.
__post_init__()
Validate the distribution bounds and point count.
GeometricSpec
dataclass
Geometrically changing spacing between two endpoints.
__post_init__()
Validate the geometric-distribution parameters.
QuinticSegment
dataclass
Quintic transition matching adjacent linear regions.
__post_init__()
Validate the transition point count.
SegmentedSpec
dataclass
Ordered linear and polynomial regions forming one distribution.
__post_init__()
Validate segment ordering and polynomial neighborhoods.
TanhSpec
dataclass
Hyperbolic-tangent point clustering at one or both endpoints.
__post_init__()
Validate the tanh-distribution parameters.
generate_cartesian(source)
Generate a Cartesian grid from a config object or TOML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
source
|
CartesianConfig | str | Path
|
Validated configuration or configuration file path. |
required |
Returns:
| Type | Description |
|---|---|
Dataset
|
Grid-only CFD dataset with physical coordinate arrays. |
load_cartesian_config(path)
Read and validate a Cartesian-grid TOML configuration.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
str | Path
|
Configuration file path. |
required |
Returns:
| Type | Description |
|---|---|
CartesianConfig
|
Validated Cartesian configuration. |
build_distribution(spec)
Build and validate one configured point distribution.
Cartesian Generation
cartesian
Cartesian tensor-product grid generation.
generate_cartesian(source)
Generate a Cartesian grid from a config object or TOML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
source
|
CartesianConfig | str | Path
|
Validated configuration or configuration file path. |
required |
Returns:
| Type | Description |
|---|---|
Dataset
|
Grid-only CFD dataset with physical coordinate arrays. |
Cartesian Configuration
cartesian
Configuration contract for Cartesian tensor-product grids.
CartesianConfig
dataclass
Complete configuration for one Cartesian grid.
__post_init__()
Validate output options.
load_cartesian_config(path)
Read and validate a Cartesian-grid TOML configuration.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
str | Path
|
Configuration file path. |
required |
Returns:
| Type | Description |
|---|---|
CartesianConfig
|
Validated Cartesian configuration. |
One-Dimensional Distributions
distributions
Reusable one-dimensional point distributions.
CubicSegment
dataclass
Terminal cubic transition matching the incoming linear region.
__post_init__()
Validate the transition point count.
EquidistantSegment
dataclass
One equidistant region ending at a specified coordinate.
__post_init__()
Require exactly one resolution control.
EquidistantSpec
dataclass
Equally spaced points between two endpoints.
__post_init__()
Validate the distribution bounds and point count.
GeometricSpec
dataclass
Geometrically changing spacing between two endpoints.
__post_init__()
Validate the geometric-distribution parameters.
QuinticSegment
dataclass
Quintic transition matching adjacent linear regions.
__post_init__()
Validate the transition point count.
SegmentedSpec
dataclass
Ordered linear and polynomial regions forming one distribution.
__post_init__()
Validate segment ordering and polynomial neighborhoods.
TanhSpec
dataclass
Hyperbolic-tangent point clustering at one or both endpoints.
__post_init__()
Validate the tanh-distribution parameters.
build_distribution(spec)
Build and validate one configured point distribution.