--- title: Gyre summary: "Gyre is a differentiable, high-order computational fluid dynamics capability: the flow discipline that a multidisciplinary design optimization framework wraps." level: 1 keywords: [home, overview, reading paths] # The home page is assembled by docs/theme/templates/home.html from the fields below. # `link` and the entries of `pages` are paths of pages under docs/content; the build # fails if one of them does not exist. hero: eyebrow: Differentiable high-order CFD title: A flow solver built to be differentiated text: "Gyre provides converged flows, functionals, coupling fields and exact derivative products of a high-order discontinuous-Galerkin solver — as a library, a service and an agent interface. It is the discipline an optimization framework wraps; it contains no optimizer." actions: - {label: What Gyre is, link: overview/what-is-gyre.md} - {label: Get started, link: guide/getting-started.md} - {label: API explorer, link: /api/docs} paths: - id: mdo title: MDO integrator icon: graph who: You wrap Gyre as a discipline in an optimization framework and need its interface, its derivatives and evidence that they are right. depth: 2 pages: - overview/what-is-gyre.md - guide/mdo-integration.md - guide/gradients.md - examples/aerostructural-coupling.md - examples/openmdao.md - verification/derivatives.md - verification/discipline-contract.md - theory/adjoint-and-sensitivities.md - id: cfd title: CFD practitioner icon: airfoil who: You want to set up, run and judge flow solutions, and to know what the solver can and cannot do. depth: 2 pages: - overview/capabilities-and-limits.md - guide/getting-started.md - guide/cases.md - guide/meshes.md - examples/naca0012-euler.md - examples/transonic.md - examples/cylinder-re40.md - examples/turbulent-flat-plate.md - examples/sphere.md - examples/imported-mesh.md - verification/index.md - id: dev title: Solver developer icon: code who: You change the code and need to know how it is organised, how the kernels are written and how changes are tested. depth: 3 pages: - overview/architecture.md - engineering/design-decisions.md - engineering/code-structure.md - engineering/differentiable-programming.md - engineering/testing-strategy.md - engineering/development-process.md - reference/authoring.md - id: analyst title: Numerical analyst icon: sigma who: You want the equations, the discretization and the proofs, and the verification studies that test them. depth: 4 pages: - theory/governing-equations.md - theory/dgsem.md - theory/two-point-fluxes.md - theory/viscous-br2.md - theory/turbulence-model.md - theory/implicit-solver.md - theory/adjoint-and-sensitivities.md - theory/error-estimation.md - verification/order-of-accuracy.md - verification/turbulence.md - id: ops title: Operator icon: server who: You deploy and run the service for others on a tailnet, and need to know what is running and whether it is healthy. depth: 2 pages: - guide/deployment.md - guide/service.md - engineering/service-architecture.md - engineering/pipelines-and-provenance.md - engineering/performance.md - id: agent title: AI agent icon: bot who: You are, or you operate, an agent that drives Gyre through its tool interface. Start from llms.txt; every page is also served as Markdown. depth: 2 pages: - guide/agents.md - examples/agent-session.md - reference/mcp-tools.md - reference/rest-api.md - reference/case-schema.md - guide/meshes.md - guide/pipelines.md highlights: - title: Differentiable by construction icon: gradient text: The numerical kernels are pure JAX functions, so Jacobian products, adjoints and shape sensitivities come from automatic differentiation of the same code that computes the flow. link: engineering/differentiable-programming.md - title: High-order, entropy-conservative volume terms icon: layers text: Split-form discontinuous-Galerkin spectral elements on curved meshes, with entropy-conservative two-point fluxes. A discrete entropy inequality is proven for the two entropy-stable interface fluxes (matrix dissipation in entropy variables, and Lax–Friedrichs); the default classical Roe flux is dissipative in the verification study. link: theory/dgsem.md - title: Exact adjoints, through shocks and turbulence icon: sigma text: One transposed solve per output gives derivatives with respect to flow conditions and every surface node, in two and three dimensions; shock capturing and the turbulence closure, wall distance included, are part of the linearisation. link: theory/adjoint-and-sensitivities.md - title: A discipline, not an optimizer icon: graph text: A framework-neutral contract — solve, outputs, loads and displacements, forward and reverse products — that an MDO framework wraps, locally or over the network. link: guide/mdo-integration.md - title: Service, pipelines and agents icon: server text: One deployable unit serves a REST API with warm sessions, declarative pipelines, a Model Context Protocol endpoint, and this documentation stamped with the running revision. link: guide/service.md - title: Evidence with provenance icon: shield text: Verification pages render the output of the verification suite; every chart and table names the revision, time and device that produced it. link: verification/index.md ---