From 3ada6aa07d53d33984f1ed889fe39e5b580a12d4 Mon Sep 17 00:00:00 2001 From: Jukka Aho Date: Sat, 9 May 2026 18:15:35 +0300 Subject: [PATCH] docs(physics): tidy Thermal tag docstring Drop a duplicated example line and remove the commented-out Fluid placeholder that suggested unfinished velocity dispatch. - Clarify `Thermal{Dim}` wording; delete stale `Fluid{Dim}` sketch. --- src/physics/types.jl | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/src/physics/types.jl b/src/physics/types.jl index 3ffaf13..645eca5 100644 --- a/src/physics/types.jl +++ b/src/physics/types.jl @@ -27,30 +27,16 @@ struct Elasticity{Dim} <: AbstractPhysics end """ Thermal{Dim} <: AbstractPhysics -Thermal physics (heat transfer) in Dim dimensions (2D or 3D). +Thermal physics (heat transfer) in `Dim` dimensions (2 or 3). Used for trait-based dispatch: ```julia required_field_type(Thermal{2}()) # → Temperature (2D plane heat) required_field_type(Thermal{3}()) # → Temperature (3D heat) -required_field_type(Thermal{2}()) # → Temperature (rotational symmetric 2D) ``` """ struct Thermal{Dim} <: AbstractPhysics end -# Note: Fluid physics type will be added when Velocity field type is implemented -# """ -# Fluid{Dim} <: AbstractPhysics -# -# Fluid physics in Dim dimensions. -# -# Used for trait-based dispatch: -# ```julia -# required_field_type(Fluid{3}()) # → Velocity{3} -# ``` -# """ -# struct Fluid{Dim} <: AbstractPhysics end - # ============================================================================ # TRAIT FUNCTIONS # ============================================================================