Skip to content

PE - DOCS - Delineate the boundary-response torque from the KineticForces NTV torque - #424

Draft
logan-nc wants to merge 1 commit into
developfrom
docs/torque-output-delineation
Draft

PE - DOCS - Delineate the boundary-response torque from the KineticForces NTV torque#424
logan-nc wants to merge 1 commit into
developfrom
docs/torque-output-delineation

Conversation

@logan-nc

Copy link
Copy Markdown
Collaborator

Small clarity fix prompted by issue #423's torque cross-validation: PerturbedEquilibrium/Energies/toroidal_torque was annotated simply as "net toroidal torque on the plasma", which invites direct comparison with KineticForces/<method>/total_torque — a distinct construction.

This PR renames nothing (clean-break renames deferred until the gpout_dw port lands, issue #423) but states the delineation in all three places a user would look: the PerturbedEquilibriumState docstring, the HDF5 long_name, and the computation site in Response.jl. The delineation:

  • Boundary-response torque (this output): −2n·Im⟨Φ_tot, Λ⁻¹Φ_tot⟩/4 — the anti-Hermitian boundary quadratic form. Equals the volume-integrated Euler–Lagrange kinetic torque for converged self-consistent solutions (δW surface-term identity); their numerical difference is a solution/grid diagnostic.
  • ψ-resolved EL torque profile (gpout_dw, unported — issue Port gpout_dw / gpout_dw_matrix (psi-resolved torque response profiles and matrices) as the grid-logic diagnostic #423): same model, volume-resolved.
  • NTV torque (KineticForces/): independent energy-space bounce-average evaluation; agreement with the above tests whether the EL matrices faithfully discretize the drift-kinetic operator.

⚠️ REQUIRES THIRD-PARTY HUMAN REVIEW BEFORE MERGING — NON-NEGOTIABLE.

🤖 Generated with Claude Code

https://claude.ai/code/session_01LzbLFQKyuRE5DYZmLokKmk

…rces NTV torque

GPEC now reports torque through two distinct constructions and will gain a third
(the gpout_dw psi-resolved profile, issue #423): the PE scalar is the boundary
quadratic form of the anti-Hermitian plasma inductance, equal to the
volume-integrated Euler-Lagrange kinetic torque only for converged
self-consistent solutions, and a distinct construction from the KineticForces
energy-space NTV evaluation. State this in the struct docstring, the HDF5
long_name, and at the computation site so no output is just called 'torque'.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LzbLFQKyuRE5DYZmLokKmk
@github-actions github-actions Bot added the docs Documentation only label Aug 22, 2026
@github-actions

Copy link
Copy Markdown
Contributor

This pull request is missing an assignee and a reviewer.

If you are not ready to name them, mark this pull request as a draft.
docs/development/contributors.md suggests lead developers to ask.
Merging is not blocked here, but no pull request may be merged without human review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant