Acceleration #26

stewartboogert · 2024-11-28T00:34:53Z

No description provided.

lnevay

Various little comments. But work in progress 👍

src/BDSComponentFactory.cc

include/BDSFieldEMAcceleration.hh

examples/features/fields/acceleration/axialstandingapprox_full_multiple.gmad

include/BDSFieldEMAcceleration.hh

include/BDSFieldEMAxialStandingApprox.hh

src/BDSFieldEMCircularTM.cc

src/BDSMagnetStrength.cc

lnevay · 2025-02-19T13:38:07Z

examples/features/fields/waveguide/Analysis.ipynb

I think we should avoid committing notebooks as they inflate the repository size and are more personal. Python scripts fine.

lnevay · 2025-02-19T13:38:48Z

include/BDSFieldEMAcceleration.hh

+{
+public:
+  BDSFieldEMAcceleration();
+  ~BDSFieldEMAcceleration();


Destructor should be marked virtual.

lnevay · 2025-02-19T13:40:19Z

include/BDSFieldEMAcceleration.hh

+#include "BDSFieldEM.hh"
+
+#include <vector>
+


Please add some basic doxygen just before the class declaration.

/** * @brief brief description * * @author Stewart Boogert */

lnevay · 2025-02-19T13:41:10Z

include/BDSFieldEMAxialStandingApprox.hh

+class BDSFieldEMAxialStandingApprox : public BDSFieldEMAcceleration {
+public:
+  BDSFieldEMAxialStandingApprox() = delete;
+


virtual ~BDSFieldEMAxisStandingApprox() = default;

lnevay · 2025-02-19T13:41:38Z

include/BDSFieldEMAxlalFloquetApprox.hh

+class BDSFieldEMAxialFloquetApprox : public BDSFieldEMAcceleration {
+public:
+  BDSFieldEMAxialFloquetApprox() = delete;
+


lnevay · 2025-02-19T13:41:51Z

include/BDSFieldEMAxlalFloquetApprox.hh

+#include "BDSFieldEMAcceleration.hh"
+
+class BDSMagnetStrength;
+


src/BDSComponentFactory.cc

lnevay · 2025-02-19T13:44:51Z

src/BDSFieldEMAxialFloquetApprox.cc

@@ -0,0 +1,62 @@
+//
+// Created by Boogert Stewart on 01/12/2024.


Licence missing.

lnevay · 2025-02-19T13:45:27Z

src/BDSFieldEMAxialFloquetApprox.cc

+//
+
+#include "BDSFieldEMAxlalFloquetApprox.hh"
+#include "BDSMagnetStrength.hh"


#include "G4ThreeVector.hh" #include <cmath>

lnevay · 2025-02-19T13:46:05Z

src/BDSFieldEMAxialStandingApprox.cc

@@ -0,0 +1,124 @@
+//
+// Created by Boogert Stewart on 25/11/2024.


Licence. Authorship goes in header in doxygen.

Defo. I'll stick it in as we have it now But we should really rewrite the header to reflect contributions from all. Copyright Royal Holloway is not totally inaccurate and not great for you, me, Fabian, Giacommo, etc. I'll raise an issue

lnevay · 2025-02-19T13:48:20Z

Oh, noticed we're missing the description in the manual also. source/dev_fields.rst please.

Copilot

Pull Request Overview

This PR extends the accelerator module by adding three new RF field types—transversemagnetic, axialstandingapprox, and axialfloquetapprox—along with their data keys, unit factors, integrator support, factory registration, and class implementations. It also fixes the half-wavelength calculation for cell length and updates related enum dictionaries.

Added new cavity parameter keys and unit factors in BDSMagnetStrength.
Introduced BDSFieldEMCircularTM, BDSFieldEMAxialStandingApprox, and BDSFieldEMAxialFloquetApprox classes with factory wiring.
Updated integrator set, field/type mappings, and component factories; corrected cellLength = c_light/(2*frequency).

Reviewed Changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
src/BDSMagnetStrength.cc	Extended strength keys/unit factors and removed TODOs
src/BDSIntegratorSet.cc	Added integrator fields and missing cases
src/BDSFieldType.cc	Registered new field types in the field‐type map
src/BDSFieldFactory.cc	Wired new field classes into EM factory
src/BDSFieldEMCircularTM.cc	Implemented Circular TM mode
src/BDSFieldEMAxialStandingApprox.cc	Implemented axial standing-wave approximation
src/BDSFieldEMAxialFloquetApprox.cc	Implemented axial Floquet approximation skeleton
src/BDSComponentFactory.cc	Set user limits for RF steps; fixed half-wavelength bug
src/BDSCavityFieldType.cc	Extended cavity‐field enum and mappings
src/BDSBeamlineIntegral.cc	Added stub for axialstandingapprox energy integration
include/*	Updated integrator, field, and cavity type headers

Comments suppressed due to low confidence (3)

src/BDSFieldType.cc:98

String mapping typo: "axialsfloquetapprox" should be "axialfloquetapprox" for consistency.

src/BDSFieldFactory.cc:73

Header filename typo: should be "BDSFieldEMAxialFloquetApprox.hh" to match the class name.

#include "BDSFieldEMAxlalFloquetApprox.hh"

include/BDSFieldEMAxlalFloquetApprox.hh:21

Header guard typo with extra 'B' prefix and misspelling; should be #define BDSFIELDEMAXIALFLOQUETAPPROX_H.

#define BBDSFIELDEMAXLALFLOQUETAPPROX_H

Copilot · 2025-07-07T11:00:24Z

src/BDSMagnetStrength.cc

+    {"cavity_tphase", {"",    1.0}},
+    {"cavity_zphase", {"",    1.0}},
+    {"coilRadialThickness", {"m", CLHEP::m}},
+    {"cavity_zphase", {"",    1.0}},


Duplicate entry for "cavity_zphase" in unitsFactorsMap will override the first; remove the redundant entry.

Suggested change

{"cavity_zphase", {"", 1.0}},

Copilot · 2025-07-07T11:00:24Z

src/BDSMagnetStrength.cc

+  "cavity_efield", /* TODO not needed */
+  "cavity_travelling", /* TODO not needed */
+  "cavity_radius", /* TODO not needed */
+  "cavity_length", /* TODO not needed */
+  "cavity_m", /* TODO not needed */
+  "cavity_n", /* TODO not needed */
+  "cavity_p", /* TODO not needed */
+  "cavity_tphase", /* TODO not needed */
+  "cavity_zphase", /* TODO not needed */


[nitpick] Remove or resolve the "TODO not needed" comments on keys to reduce clutter and clarify which cavity parameters are actually required.

Suggested change

"cavity_efield", /* TODO not needed */

"cavity_travelling", /* TODO not needed */

"cavity_radius", /* TODO not needed */

"cavity_length", /* TODO not needed */

"cavity_m", /* TODO not needed */

"cavity_n", /* TODO not needed */

"cavity_p", /* TODO not needed */

"cavity_tphase", /* TODO not needed */

"cavity_zphase", /* TODO not needed */

// Removed unnecessary keys: cavity_efield, cavity_travelling, cavity_radius, cavity_length, cavity_m, cavity_n, cavity_p, cavity_tphase, cavity_zphase

Copilot · 2025-07-07T11:00:25Z

src/BDSIntegratorSet.cc

                         BDSIntegratorType::g4classicalrk4,      // rfpillbox
+                         BDSIntegratorType::g4classicalrk4,      // transversemagnetic
+                         BDSIntegratorType::g4classicalrk4,      // axialstandingapprox
+                         BDSIntegratorType::g4classicalrk4,      // axialsfloquetapprox


Comment typo: "axialsfloquetapprox" should read "axialfloquetapprox" to match the field type.

Suggested change

BDSIntegratorType::g4classicalrk4, // axialsfloquetapprox

BDSIntegratorType::g4classicalrk4, // axialfloquetapprox

Copilot · 2025-07-07T11:00:25Z

src/BDSIntegratorSet.cc

+    case BDSFieldType::transversemagnetic:
+      {return transversemagnetic; break;}
+    case BDSFieldType::axialstandingapprox:
+      {return axialstandingapprox; break;}


The Integrator switch is missing a case for axialfloquetapprox; add case BDSFieldType::axialfloquetapprox: return axialfloquetapprox;.

Suggested change

{return axialstandingapprox; break;}

{return axialstandingapprox; break;}

case BDSFieldType::axialfloquetapprox:

{return axialfloquetapprox; break;}

Copilot · 2025-07-07T11:00:25Z

src/BDSComponentFactory.cc

+  G4double period = 1. / (element->frequency*CLHEP::hertz);
+  // choose the smallest length scale based on the length of the component of the distance
+  // travelled in one period - so improved for high frequency fields
+  G4double limit = 1;


Variable limit is hardcoded to 1 instead of using period * stepFraction; update to limit = period * stepFraction for correct RF step sizing.

Suggested change

G4double limit = 1;

G4double limit = period * stepFraction;

Copilot · 2025-07-07T11:00:25Z

src/BDSBeamlineIntegral.cc

            }
+          case BDSCavityFieldType::axialstandingapprox:
+            {
+              //dEk = particleCharge *;


Placeholder in axialstandingapprox case is incomplete; implement the energy change calculation or remove the stub.

Suggested change

//dEk = particleCharge *;

// Implement energy change calculation for axialstandingapprox cavity field type

G4double transitTimeFactor = BDSFieldEMRFCavity::TransitTimeFactor(frequency, phase, thisComponentArcLength, designParticle.Beta());

dEk = particleCharge * eField * thisComponentArcLength * transitTimeFactor * std::cos(phase);

break;

Former-commit-id: 58452c9056ef0dbf2698a9a506452f963b0e2086

Former-commit-id: 8f9ffc9a203baf4d4f55f63a4d3ff1ab4f908c5d

Former-commit-id: 3293a94763a56a484404c83e666132a80168d692

Former-commit-id: 035fb3cb56eb695b34179095596a13f6521509ae

Former-commit-id: f44ebde262ed474b96ef776e247d743946274585

Former-commit-id: 87a533dd6af5e4c4c7cbb5b68f836d9f88c37547

Former-commit-id: c8f30b39ce5fa03f80aa6656a9c57012fde1fb97

Former-commit-id: 62eff660968aecc3c778d4a44b51bb8a0db4a53e

Former-commit-id: d963f91867acc1c3a0a44d3a7bbd0796d9853ef9

lnevay reviewed Dec 4, 2024

View reviewed changes

stewartboogert force-pushed the acceleration branch from 6b9c399 to ac12885 Compare January 17, 2025 22:32

stewartboogert force-pushed the acceleration branch 3 times, most recently from 6bc6f37 to 7b13bfa Compare February 14, 2025 21:22

lnevay requested changes Feb 19, 2025

View reviewed changes

stewartboogert force-pushed the acceleration branch from 7b13bfa to 65f6eb9 Compare March 8, 2025 10:29

stewartboogert force-pushed the acceleration branch from 65f6eb9 to 8054815 Compare June 13, 2025 15:45

stewartboogert requested a review from Copilot July 7, 2025 10:40

stewartboogert force-pushed the acceleration branch from 8054815 to d57af23 Compare July 7, 2025 10:47

Copilot AI reviewed Jul 7, 2025

View reviewed changes

stewartboogert force-pushed the acceleration branch 3 times, most recently from 19559ab to 741d88e Compare July 29, 2025 20:52

stewartboogert force-pushed the acceleration branch from f44a27e to 664b070 Compare August 7, 2025 21:51

stewartboogert force-pushed the acceleration branch 2 times, most recently from c8d0b7a to 35254a4 Compare October 4, 2025 12:17

stewartboogert force-pushed the acceleration branch 9 times, most recently from d87429f to 8345dbf Compare October 17, 2025 20:51

stewartboogert and others added 3 commits October 31, 2025 16:10

WIP : TM field for arbitrary mnp.

5b9d78d

Former-commit-id: 58452c9056ef0dbf2698a9a506452f963b0e2086

WIP : Fix Bessel function recursion

07b76bd

Former-commit-id: 8f9ffc9a203baf4d4f55f63a4d3ff1ab4f908c5d

WIP : Add query to test field

4cb24ff

Former-commit-id: 3293a94763a56a484404c83e666132a80168d692

stewartboogert and others added 29 commits October 31, 2025 16:10

Test files

e795afd

Former-commit-id: 035fb3cb56eb695b34179095596a13f6521509ae

WIP : Add run of multiple files

906388b

Former-commit-id: f44ebde262ed474b96ef776e247d743946274585

Lower energy tests

e2e1a16

Former-commit-id: 87a533dd6af5e4c4c7cbb5b68f836d9f88c37547

Make shorter steps for RF

332989b

Former-commit-id: c8f30b39ce5fa03f80aa6656a9c57012fde1fb97

WIP : acceleration

42b68a9

Former-commit-id: 62eff660968aecc3c778d4a44b51bb8a0db4a53e

acceleration : WIP

0b09ab5

Former-commit-id: d963f91867acc1c3a0a44d3a7bbd0796d9853ef9

acceleration: tidy ready for testing

89b7563

Load axial file

186ca91

Add min and max functions

91029bd

acceleration: Added derivative approximation version of cavity fields

8c195f8

Add zeroes function

cec74bd

Wired up axialstandingapprox field type

363e83f

Fixed synchronousT?

08364d8

acceleration: working test

e502174

acceleration: rename input variables

983fdac

acceleration: cavity phase (untested)

f931441

acceleration : fix vector include

ac10023

acceleration : remove old test files

2d53230

acceleration : simplify examples

c23bf33

acceleration : move examples to correct directory

ec54c89

acceleration : remove old comments

6631e91

acceleration : remove debug IO

27b2d0e

acceleration : removed old axial class

a9db4ef

acceleration : remove transit time from voltage

e11724d

acceleration : added Floquet Fourier axial field

36ceb14

acceleration : code formatting and tidying

2125c4a

field: resolve code review changes

704db75

fix rebase

f768a43

acceleration: remove zeroing of important parameters

215e337

stewartboogert force-pushed the acceleration branch from 8345dbf to 215e337 Compare October 31, 2025 16:31

		#include "BDSFieldEMAcceleration.hh"

		class BDSMagnetStrength;

		@@ -0,0 +1,62 @@
		//
		// Created by Boogert Stewart on 01/12/2024.

		@@ -0,0 +1,124 @@
		//
		// Created by Boogert Stewart on 25/11/2024.

	BDSIntegratorType::g4classicalrk4, // axialsfloquetapprox
	BDSIntegratorType::g4classicalrk4, // axialfloquetapprox

-              //dEk = particleCharge *;
+              // Implement energy change calculation for axialstandingapprox cavity field type
+              G4double transitTimeFactor = BDSFieldEMRFCavity::TransitTimeFactor(frequency, phase, thisComponentArcLength, designParticle.Beta());
+              dEk = particleCharge * eField * thisComponentArcLength * transitTimeFactor * std::cos(phase);
+              break;

Acceleration #26

Are you sure you want to change the base?

Acceleration #26

Uh oh!

Conversation

stewartboogert commented Nov 28, 2024

Uh oh!

lnevay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lnevay commented Feb 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants