Import geant4maker. #659

klendathu2k · 2024-02-21T17:54:51Z

Draft PR for geant4star. Supersedes #617.

Branch was rebased against current main (02/21/24). Plus few additional fixes to get it to run (up to loading G3) in the current environment.

NOTE: The code should be functional, but requires two modules which we don't currently have in spack, plus an update to a newer version of the geant4 library. Specifically, we need to add a GEANT3 VMC library, and update the Geant 4 VMC library to one which supports multi-engine simulations.

These versions have been tested together by the VMC team.

I should also mention that we are at a point of divergence in the ROOT / VMC development. Currently we are using the VMC version 1.1, which is built with ROOT. The next version is 2.0, which is shipped separately. The GEANT3 VMC 3.9p1 release includes fixes to sensitive volumes which we require, and is the last version able to run with VMC 1.1. Any move to a new version of ROOT, VMC and/or Geant (either G3 or G4) likely entails advancing to a new version of all of these packages... with the possible exception of ROOT.

Code compiles against root 6.24 in our production environment:

starver dev config/v0.3.0-rhel7-root6.24.06
setenv STAR .
cons

StGeant4Maker should be excluded from all ROOT5 builds (in CI)
StGeant4Maker should be excluded from 32 bit builds
root5 and root6 builds should pass CI tests

[g4star] Update stacker and agml extension classes to enable multi engine tracking and user defined hits in the geant4 application. Few additional fixes and cleanups in the code. [g4star] Import the StGeant4Maker into the repository. Builds under root 6.24 (with some additional compilation flags). [g4star] Defer mysql load until StBFChain can do it. [g4star] Add geant4vmc, geant4mk and fastjet chain options. Load libfastjet with stargen package b/c one or more filters depends on it. (Should consider splitting filters into sep chain opt). [g4star] Cleanup commented out includes. [g4star] Reduce compile time warnings... [g4star] ... more reduction of compiler warnings ... and even more reduction of compiler warnings... [g4star] And modify cons to pickup the include paths to geant4 and geant4 vmc libraries

…e" option (which was meant as documentation).

klendathu2k · 2024-02-21T18:02:23Z

StRoot/StGeant4Maker/AgMLBTofVolumeId.h

AgMLBTofVolumeId and similarly named classes implement the unique volume IDs defined in pams/sim/g2t/g2t_volume_id.g. They provide the unique associated between hits and hardware channels.

klendathu2k · 2024-02-21T18:04:34Z

StRoot/StGeant4Maker/AgStarDummy.cxx

AgStarDummy inserts a few dummy routines (mangled to look like FORtran routines) which satisfy dependencies between the StarGenerator package and starsim.

klendathu2k · 2024-02-21T18:16:31Z

StRoot/StarGenerator/BASE/StarPrimaryMaker.h


  /// Return a pointer to the event
  StarGenEvent *event() { return mPrimaryEvent; }
+  /// Return a pointer to the stack 


Exposes the particle stack to StGeant4Maker for PushPrimaries.

klendathu2k · 2024-02-21T18:18:13Z

StarVMC/StarAgmlLib/AgMLExtension.cxx

+
+}
+
+std::map<TString, AgMLExtension*> AgMLExtension::mExtensionMap;


The GEANT3 VMC took use of both the "user" and "framework" extensions to TGeoVolume, leaving us with the only option of keeping a map between volume names and extension data.

iraklic

does this mean we did not have btof and eemc in AgML format before? (I though we did)

klendathu2k · 2024-02-21T19:25:42Z

does this mean we did not have btof and eemc in AgML format before? (I though we did)

I assume you are referring to the "volume ID" classes? No. These are new classes to support the geant4star application.

mgr/Conscript-standard

plexoos · 2024-03-06T14:27:47Z

If you have a chance please try to build with this dependencies

module load geant4-vmc-5-0-p5-root-6.24.06 geant4-10.5.1 geant3-3-8-root-6.24.06

Geant3-3-9-p1 is currently missing from the spack repo so, I'll need to add it

klendathu2k · 2024-03-06T14:32:51Z

Hi Dmitri, Will do. The changes in Geant3-3-9-p1 are w/ respect to sensitive detector functionality, not interface, so building against it will at least allow me to test a pure G4 simulation. Thanks, Jason

…

On 2024-03-06 09:28, Dmitri Smirnov wrote: If you have a chance please try to build with this dependencies module load geant4-vmc-5-0-p5-root-6.24.06 geant4-10.5.1 geant3-3-8-root-6.24.06 Geant3-3-9-p1 is currently missing from the spack repo so, I'll need to add it -- Reply to this email directly, view it on GitHub [1], or unsubscribe [2]. You are receiving this because you authored the thread.Message ID: ***@***.***> Links: ------ [1] #659 (comment) [2] https://github.com/notifications/unsubscribe-auth/ANL4LVED3RAU7JXGIH4UKPDYW4RXBAVCNFSM6AAAAABDTP5ZLOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOBQHE4TGNBTGA

plexoos · 2024-03-06T16:54:15Z

geant3@3-9-p1 is also available on the SDCC machines now. So, the following modules can be used for testing:

module load geant4-vmc-5-0-p5-root-6.24.06 geant4-10.5.1 geant3-3-9-p1-root-6.24.06

klendathu2k · 2024-03-12T19:04:00Z

With the last three pushes, code compiles and runs the TPC to completion. Albeit with no hits generated. Reason TBC.

…or 20 test, and the full install.

…a given geometry tag.

...

…s a 'stubs' library.

…t in events generated on each Make of the chain.

…runtime issues.

...

1. Geometry option will be looked for in the bfc, physicssim chains. Finally lookup via call to GetDatabase. 2. Under embed mode, responsability for setting the vertex will be under the control of an embedding maker.

…e job for now.

Copilot

Pull Request Overview

This PR imports the geant4maker codebase to enable Geant4-based simulations within the STAR framework. The changes primarily involve removing obsolete StarVMC application files and test utilities, updating geometry configurations, adding support for Root6/Cling, and introducing Geant4-specific simulation infrastructure.

Key Changes

Removal of obsolete StarVMC application implementation files and associated testing infrastructure (StarBASE)
Updates to AgML geometry handling and extensions to support both Geant3 and Geant4 engines
Root6/Cling compatibility improvements across multiple macro and header files
Addition of embedding support macros and unit testing framework for Geant4

Reviewed Changes

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

Show a summary per file

File	Description
StarVMC/StarVMCApplication/*	Removed obsolete VMC application headers and implementations
StarVMC/StarBASE/*	Removed baseline analysis infrastructure no longer needed
StarVMC/StarAgmlLib/*	Updated AgML extensions to support multi-engine simulations
StRoot/macros/*.C	Added Root6/Cling preprocessor directives for compatibility
StRoot/StarGenerator/*	Enhanced generator framework with improved maker registration
StRoot/St_geant_Maker/*	Added documentation and embedding preparation infrastructure
StarVMC/Geometry/StgmGeo/StgmGeo1.xml	Updated geometry to separate sensitive volume materials

Copilot · 2025-11-18T13:44:31Z

StarVMC/StarAgmlLib/AgMLExtension.h

  TString GetVolumeName(){ return mVolumeName; }

-  int GetVolumeId( int* numbv ){ return mVolumeId ? mVolumeId->id( numbv ) : 0; }
+  int GetVolumeId( int* numbv ){ return mVolumeId->id( numbv ); }


Potential null pointer dereference. The previous destructor removed the delete mVolumeId and nulled the pointer, but this getter does not check if mVolumeId is null before dereferencing it. This could cause a crash if GetVolumeId is called after the object is destroyed or before SetVolumeIdentifier is called.

Copilot · 2025-11-18T13:44:31Z

StarVMC/StarAgmlLib/AgMLExtension.cxx

+void AgMLExtension::Print( Option_t* opts ) const {
+
+//static const char* en[] = { "default", "geant3", "geant4" };
+
+  LOG_INFO << mModuleName.Data() << ":"
+	   << mFamilyName.Data() << ":"
+	   << mVolumeName.Data() << " this="
+	   << this << " sens="
+	   << mSensitive << " tracking="
+	   << mTracking << " nbranch="
+	   << mBranchings << " nuser="
+    //	   << mHitScoring.size() << " engine="
+    //    	   << (mEngine>=0 && mEngine < 2) ? en[mEngine] : "invalid!? " 
+	   << endm;
+
+}


Commented-out code should be removed rather than left in the source. Lines 24, 33, and 34 contain commented debug code that appears to be unfinished or unnecessary. Remove these lines to improve code clarity.

Copilot · 2025-11-18T13:44:31Z

StarDb/AgMLGeometry/CreateGeometry.h


-#if !defined(__CINT__) || defined(__CLING__)
+
+#if !defined(__CINT__) || !defined(__CLING__)


Incorrect conditional logic. The condition !defined(__CINT__) || !defined(__CLING__) will always evaluate to true (unless both CINT and CLING are defined, which is unlikely). This should use && instead: #if !defined(__CINT__) && !defined(__CLING__)

Suggested change

#if !defined(__CINT__) || !defined(__CLING__)

#if !defined(__CINT__) && !defined(__CLING__)

Copilot · 2025-11-18T13:44:32Z

StRoot/StarGenerator/BASE/StarParticleStack.h

+#ifndef __CLING__
 #include "TClonesArray.h"
+#endif


[nitpick] Inconsistent use of preprocessor guards. The file uses #ifndef __CLING__ on line 10 but #ifndef __CINT__ is used elsewhere in the codebase. Consider using a consistent pattern across all files, preferably #if !(defined(__CINT__) || defined(__CLING__)) as seen in other files.

Copilot · 2025-11-18T13:44:32Z

StarVMC/StarAgmlLib/StarTGeoStacker.cxx

-	  AgMLScoring* scoring = kv.second;
-	  agmlExt -> AddHitScoring( scoring );
-	}
+        // NOTE: user hits have not been defined at this point, add to extension at point of definition


[nitpick] While this comment explains why user hits are not added here, it would be helpful to reference where in the code they are actually added (AgModule.cxx line 95-107) for better traceability.

Suggested change

// NOTE: user hits have not been defined at this point, add to extension at point of definition

// NOTE: user hits have not been defined at this point; they are added to the extension at the point of definition (see AgModule.cxx lines 95-107 for details)

Copilot · 2025-11-18T13:44:33Z

StarVMC/StarAgmlLib/StarTGeoStacker.cxx

      agmlExt->SetFamilyName( block->GetName() );
-      agmlExt->SetModuleName( module->GetName() );
-      agmlExt->SetSensitive( mMedium.par("isvol") );
+      agmlExt->SetModuleName( module->GetName() );      


[nitpick] The code now checks both medium and material for the 'isvol' parameter. Consider adding a comment explaining this fallback logic and why checking both is necessary for proper sensitive volume detection.

Suggested change

agmlExt->SetModuleName( module->GetName() );

agmlExt->SetModuleName( module->GetName() );

// Check both medium and material for the 'isvol' parameter.

// The sensitive volume flag ('isvol') may be defined in either the medium or the material.

// We first check the medium, and if not set, fall back to the material to ensure proper sensitive volume detection.

klendathu2k added 8 commits February 20, 2024 16:10

[geant4star] Load packages required for G4* for 64bit builds.

4ef0d92

... and the CLHEP package required by G4 as well ...

78ea6c0

Fix duplicate.

e4a4ba7

Restore gcomad for agstar dummy routines

6dca37a

Extern causes issues at runtime

5c25821

Duplicate load removed.

b5a7f99

Make multi-engine simulation the default. Comment out the "NAME:engin…

6c1e9dc

…e" option (which was meant as documentation).

klendathu2k commented Feb 21, 2024

View reviewed changes

klendathu2k marked this pull request as ready for review February 21, 2024 18:23

klendathu2k requested review from R-Witt, fisyak, genevb, iraklic, nigmatkulov, perevbnlgov and plexoos as code owners February 21, 2024 18:23

iraklic approved these changes Feb 21, 2024

View reviewed changes

klendathu2k commented Feb 28, 2024

View reviewed changes

mgr/Conscript-standard Show resolved Hide resolved

klendathu2k added 3 commits March 12, 2024 13:57

Handle ROOT version dependence for VMC library.

40e8340

Add VMC include path if separate from ROOT.

f164cd2

Load VMC, G3/G4 VMC and concrete libraries for 64bit builds.

80f70bb

klendathu2k and others added 28 commits May 20, 2025 01:01

Silently skip nonsensitive volumes.

18b893b

The FMS is a calorimeter.

f9bfa29

Silence is golden.

23f993a

FMS sensitive detectors

25999bb

Properly handle multiple sensitive detectors mapped to single g2t table.

6ef05fd

Handle BTOF back to (c) 2010.

6237bbd

Update MTD. Add BBC, VPD and ETOF.

07c2ef0

Handle inner TPC padrows from before the iTPC, during the single sect…

5747a5c

…or 20 test, and the full install.

Update the volume id factory.

c8e6c80

Allows instrospection about the detector models which are applied in …

506efd0

…a given geometry tag.

Remove unused struct.

bbd80bd

Remove actions associated with the ancient (now removed) G3 VMC package.

5eb453c

Example macro for running geant4 ala embedding.

78ea004

Ensure that the geant4 maker is instantiated only once..

8dc2444

...

Dummy routines should live in the StarGenerator area and be shipped a…

e3e542a

…s a 'stubs' library.

Make configuration available via attributes which, if set, will resul…

9d6bb4e

…t in events generated on each Make of the chain.

Additional verbosity.

1e11d2c

Removed unused TObjArray dependency. Clingwrap TClonesArray to avoid …

aa36d8a

…runtime issues.

Clingwraps. Allow configuration purely at the 'maker' level.

e32ecb9

Avoid runtime problems w/ root6

0e077b9

...

Additional chain options aimed at supporting geant4 embedding.

c577489

Should have been part of 8dc2444.

37eaf60

Early geometry initialization if geant4star maker exists.

9697309

Define an embedding mode.

1b5e01e

1. Geometry option will be looked for in the bfc, physicssim chains. Finally lookup via call to GetDatabase. 2. Under embed mode, responsability for setting the vertex will be under the control of an embedding maker.

ignore

9e00f36

Initial working root6 compatible embedding macro. Only supports singl…

6a28788

…e job for now.

Add README.md. Add documentation block for each class.

d630aac

Update documentation.

5d2d19a

klendathu2k requested a review from Copilot November 18, 2025 13:42

Copilot AI reviewed Nov 18, 2025

View reviewed changes


		}

		std::map<TString, AgMLExtension*> AgMLExtension::mExtensionMap;


		#if !defined(__CINT__) \|\| defined(__CLING__)

		#if !defined(__CINT__) \|\| !defined(__CLING__)

	#if !defined(__CINT__) \|\| !defined(__CLING__)
	#if !defined(__CINT__) && !defined(__CLING__)

	// NOTE: user hits have not been defined at this point, add to extension at point of definition
	// NOTE: user hits have not been defined at this point; they are added to the extension at the point of definition (see AgModule.cxx lines 95-107 for details)

-      agmlExt->SetModuleName( module->GetName() );
+      agmlExt->SetModuleName( module->GetName() );
+      // Check both medium and material for the 'isvol' parameter.
+      // The sensitive volume flag ('isvol') may be defined in either the medium or the material.
+      // We first check the medium, and if not set, fall back to the material to ensure proper sensitive volume detection.

Import geant4maker. #659

Are you sure you want to change the base?

Import geant4maker. #659

Conversation

klendathu2k commented Feb 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

klendathu2k Feb 21, 2024

Choose a reason for hiding this comment

Uh oh!

klendathu2k Feb 21, 2024

Choose a reason for hiding this comment

Uh oh!

klendathu2k Feb 21, 2024

Choose a reason for hiding this comment

Uh oh!

klendathu2k Feb 21, 2024

Choose a reason for hiding this comment

Uh oh!

iraklic left a comment

Choose a reason for hiding this comment

Uh oh!

klendathu2k commented Feb 21, 2024

Uh oh!

Uh oh!

plexoos commented Mar 6, 2024

Uh oh!

klendathu2k commented Mar 6, 2024 via email

Uh oh!

plexoos commented Mar 6, 2024

Uh oh!

klendathu2k commented Mar 12, 2024

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

klendathu2k commented Feb 21, 2024 •

edited

Loading