Skip to main content

Topological Free-energy Gradient Theory toolkit for topology-force, topology optimization, and topological free-gradient solving.

Project description

TFGT

TFGT (tfgt) is a Python package for fluid-topology computation based on the Topological Free-energy Gradient Theory.

Current release: 0.2.0.

Vision and Positioning

This project is positioned as a computational extension to Navier-Stokes, not a replacement.

We keep the classical conservation structure and inject one additional, explicit topology-force channel:

f_top = -lambda0 * grad(F_top)

used in NS++ momentum form:

rho * Du/Dt = -grad(p) + div(tau) - lambda0 * grad(F_top)

At API level, users only need model parameters and fields:

  • lambda0: topology-force coupling factor
  • E0: baseline energy scale for cross-scale parameterization
  • F_top: topological free-energy field

lambda0 can be supplied directly (its CFUT origin can remain hidden in engineering workflows), and E0 can be used directly as a fixed baseline from particle-mass research.

Core modeling identity:

f_top = -lambda0 * grad(F_top)

This equivalent topological force can be injected into an NS++ momentum model:

rho * Du/Dt = -grad(p) + div(tau) - lambda0 * grad(F_top)

Theory Snapshot

This package is initialized from the research note:

C:\Users\18858\Desktop\MD_2026-04-28_10-09-36_668.md

Canonical baseline parameters implemented here:

  • lambda0 = 4*pi*alpha
  • E0 = 0.026 eV

Practical Scope

The library targets practical NS-based macroscopic physics and engineering:

  • Aerodynamics and flow-control analysis
  • High-viscosity/non-Newtonian regimes (magma, asphalt, similar media)
  • Friction/interface interpretation under topology-gradient correction
  • Topology optimization where grad(F_top) is used as driving signal
  • Semantic-to-geometry solving where semantic relations are compiled into topological free energy and solved by -lambda * grad(F_top)
  • Engineering equipment spatial layout optimization with occupancy, connection-topology, access, load, and obstacle constraints

Installation

pip install tfgt

From source:

pip install .

Quick Start

import numpy as np
from tfgt import TFGTParameters, topological_force, nspp_rhs, topological_activity_index

# Build a synthetic free-energy field F_top on a 2D grid.
x = np.linspace(-1.0, 1.0, 64)
y = np.linspace(-1.0, 1.0, 64)
xx, yy = np.meshgrid(x, y, indexing="ij")
F_top = np.exp(-6.0 * (xx**2 + yy**2))

params = TFGTParameters()
force = topological_force(F_top, lambda_top=params.lambda0, spacing=(x[1] - x[0], y[1] - y[0]))

rho = 1.0
pressure_gradient = np.zeros_like(force)
tau_divergence = np.zeros_like(force)
velocity = np.zeros_like(force)

dudt = nspp_rhs(
    velocity=velocity,
    rho=rho,
    pressure_gradient=pressure_gradient,
    tau_divergence=tau_divergence,
    f_top=F_top,
    lambda_top=params.lambda0,
    spacing=(x[1] - x[0], y[1] - y[0]),
)

print("dudt shape:", dudt.shape)
print("TAI:", topological_activity_index(F_top, lambda_top=params.lambda0))

Topological Free Gradient Solver

TopologicalFreeGradientSolver is the focused solver kernel for converting semantic constraints into geometric updates through TFGT:

semantic constraints -> F_top(q) -> -lambda * grad(F_top) -> geometry update
from tfgt import (
    SemanticGeometryConfig,
    SemanticGeometryConstraint,
    TopologicalFreeGradientSolver,
)

solver = TopologicalFreeGradientSolver(
    constraints=(
        SemanticGeometryConstraint("separate", "train_a", "train_b", distance=8.0, weight=2.0),
        SemanticGeometryConstraint("inside", "panel", "control_zone", weight=3.0),
    ),
    zones={
        "control_zone": ((20.0, 0.0, 0.0), (30.0, 10.0, 10.0)),
    },
    config=SemanticGeometryConfig(step_size=0.4, max_iters=80, lambda_top=1.0),
)

result = solver.solve(
    {
        "train_a": (5.0, 1.0, 5.0),
        "train_b": (8.0, 1.0, 5.0),
        "panel": (10.0, 1.0, 5.0),
    }
)

print(result.final_energy)
print(result.positions)

See docs/TOPOLOGICAL_FREE_GRADIENT_SOLVER.md for the solver boundary and API details.

API

  • TFGTParameters: canonical parameter container (alpha, lambda0, E0)
  • TFGTModel: high-level interface for NS++ RHS, Euler stepping, simulation loop
  • TopologyOptimizer: topology-force-driven optimization solver
  • TopologicalFreeGradientSolver: semantic constraints to geometry through F_top(q) and -lambda * grad(F_top)
  • SemanticGeometryConstraint, SemanticGeometryConfig: primitives for the topological free-gradient solver
  • layout_free_energy, layout_free_energy_gradient: practical layout objective/gradient for topology optimization
  • build_free_energy_field: compose F_top from temperature/concentration/phase
  • build_flow_free_energy_field: compose F_top from velocity/pressure flow observations
  • gradient_nd, laplacian_nd: finite-difference scalar field operators
  • topological_force: equivalent topology force from free-energy field
  • nspp_acceleration, nspp_rhs: NS++ helper terms
  • vorticity_2d, helicity_density_3d, enstrophy_2d, topological_activity_index
  • compare_baseline_vs_topology: scalar diagnostics for external validation
  • SpatialLayoutOptimizer: 2D equipment layout optimizer for engineering spaces
  • LayoutDomain, Equipment, LayoutConnection: layout problem definitions

Dynamic topology optimization:

  • TopologyOptimizer.optimize_dynamic: recompute physical gradients from the current design state each iteration
  • normalize_design_gradient: RMS-normalize external physics gradients before topology-force updates
  • blended_topology_gradient: blend geometric baseline gradients with FEA/flow/sensor-derived physical gradients

Build and Publish

Install dev tooling:

pip install -e .[dev]

Run tests:

pytest -q

Build package:

python -m build

Validate artifacts:

python -m twine check dist/*

Upload:

python -m twine upload dist/*

External Testing

Run black-box validation package:

python external_tests/run_external_validation.py

See outputs and report format in external_tests/README.md.

Topology optimization quickstart:

python examples/topo_opt_quickstart.py

Scientific Scope

tfgt currently provides a computational core and reference utilities for fluid-topology workflows. It does not claim experimental validation by itself. Use this library together with your own data, calibration, and falsifiability protocols.

Engineering/scientific boundary:

  • tfgt is solver-agnostic and intended for integration into existing CFD tools.
  • Claims should be benchmarked, calibrated, and falsifiable.
  • The package focuses on code-ready modeling, not standalone theoretical proof.

Philosophy (Chinese)

See docs/PHILOSOPHY_zh-CN.md for the full Chinese statement.

License

MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tfgt-0.2.0.tar.gz (52.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tfgt-0.2.0-py3-none-any.whl (30.9 kB view details)

Uploaded Python 3

File details

Details for the file tfgt-0.2.0.tar.gz.

File metadata

  • Download URL: tfgt-0.2.0.tar.gz
  • Upload date:
  • Size: 52.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for tfgt-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b137bf4c577d3eccc1efd3be27dbb80ef3620bf4cef1b9edb15a74e12db5dadd
MD5 3064f61ccbb1a4916418e5b7ccbeddb0
BLAKE2b-256 4aa8b0067b324d1e9f3c66a2c073464720a67a2d5f4728620456bc48a6482b85

See more details on using hashes here.

File details

Details for the file tfgt-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: tfgt-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 30.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for tfgt-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a7d34d965fe8815b90ed473a32166b66f3f1a6a8466f93d946f99be05f22677
MD5 931c3594d940aa58f669fc34d29a0112
BLAKE2b-256 2a450184f22685702314788d7368f3988a6ec57643d33c28bd5805613569fc8f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page