impactx icon indicating copy to clipboard operation
impactx copied to clipboard

Clean-up of dipole parameters and documentation

Open cemitch99 opened this issue 3 months ago • 3 comments

Currently, there are several models of dipoles available: Sbend, ExactSbend, CFbend, ExactCFbend, as well as the associated DipEdge. The choices of parameter sets associated with these models are not always consistent, and the relationships cause some confusion for users.

Example: The ExactSbend element requires a bend angle in degrees, while DipEdge requires a pole face angle in radians (for historical reasons). Using radians consistently, while preserving the option for degrees to avoid a breaking change, is a possible option.

Some effort should be made to make the parameter inputs consistent, or at least to make the relationships more explicit to the user.

Diagrams illustrating the definitions of some key parameters would be helpful.

cemitch99 avatar Sep 26 '25 00:09 cemitch99

Related to #1160, let us also add a section just for a concrete how-to to build the special case of an rbend

ax3l avatar Nov 04 '25 17:11 ax3l

I don't think this requires a separate section. In fact, I already mention this case at the end of this documentation section. It only requires a sentence or two--even less if we link to an example. Adding another section makes it appear more complicated than it is.

cemitch99 avatar Nov 04 '25 19:11 cemitch99

Agreed.

ax3l avatar Nov 10 '25 19:11 ax3l