Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enable full uniform B field via RK integrator #368

Merged
merged 2 commits into from
Mar 25, 2025
Merged

enable full uniform B field via RK integrator #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1695919
enable full uniform B field via RK integrator
SeverinDiederichs Mar 23, 2025
cbe912c
minor cleaning
SeverinDiederichs Mar 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions examples/Example1/src/DetectorConstruction.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,10 @@ void DetectorConstruction::ConstructSDandField()

field = std::make_unique<CovfieField>(fFieldFile);
#else
// Set a 3D magnetic field vector for a uniform field in Bz. If no file is provided, no magnetic field is used in the
// Set a 3D magnetic field vector for a uniform B field. If no field is provided, no magnetic field is used in the
// G4 transport
if (std::abs(fMagFieldVector[2]) > 0.0) {
G4cout << G4endl
<< " *** SETTING CONSTANT MAGNETIC FIELD IN Z: fieldValue in z = " << fMagFieldVector[2] / kilogauss
if (fMagFieldVector.mag2() > 0.0) {
G4cout << G4endl << " *** SETTING CONSTANT MAGNETIC FIELD: fieldValues = " << fMagFieldVector / kilogauss
<< " [kilogauss] *** " << G4endl << G4endl;

field = std::make_unique<UniformField>(fMagFieldVector);
Expand Down
7 changes: 3 additions & 4 deletions examples/IntegrationBenchmark/src/DetectorConstruction.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,10 @@ void DetectorConstruction::ConstructSDandField()

field = std::make_unique<CovfieField>(fFieldFile);
#else
// Set a 3D magnetic field vector for a uniform field in Bz. If no file is provided, no magnetic field is used in the
// Set a 3D magnetic field vector for a uniform B field. If no field is provided, no magnetic field is used in the
// G4 transport
if (std::abs(fMagFieldVector[2]) > 0.0) {
G4cout << G4endl
<< " *** SETTING CONSTANT MAGNETIC FIELD IN Z: fieldValue in z = " << fMagFieldVector[2] / kilogauss
if (fMagFieldVector.mag2() > 0.0) {
G4cout << G4endl << " *** SETTING CONSTANT MAGNETIC FIELD: fieldValues = " << fMagFieldVector / kilogauss
<< " [kilogauss] *** " << G4endl << G4endl;

field = std::make_unique<UniformField>(fMagFieldVector);
Expand Down
51 changes: 24 additions & 27 deletions include/AdePT/core/AdePTTransport.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ inline __constant__ __device__ struct G4HepEmParameters g4HepEmPars;
inline __constant__ __device__ struct G4HepEmData g4HepEmData;

inline __constant__ __device__ adeptint::VolAuxData *gVolAuxData = nullptr;
inline __constant__ __device__ double BzFieldValue = 0;
inline __constant__ __device__ bool ApplyCuts = false;

bool InitializeVolAuxArray(adeptint::VolAuxArray &array)
Expand Down Expand Up @@ -228,44 +227,33 @@ __global__ void ClearLeakedQueues(LeakedTracks all)
all.leakedGammas->clear();
}

bool InitializeField(double bz)
{
// Initialize field
COPCORE_CUDA_CHECK(cudaMemcpyToSymbol(BzFieldValue, &bz, sizeof(double)));
return true;
}

bool InitializeGeneralField(GeneralMagneticField &magneticField)
template <typename FieldType>
bool InitializeBField(FieldType &magneticField)
{

#ifdef ADEPT_USE_EXT_BFIELD

// Allocate and copy the GeneralMagneticField instance (not the field array itself), and set the global device pointer
GeneralMagneticField *dMagneticFieldInstance = nullptr;
COPCORE_CUDA_CHECK(cudaMalloc(&dMagneticFieldInstance, sizeof(GeneralMagneticField)));
COPCORE_CUDA_CHECK(
cudaMemcpy(dMagneticFieldInstance, &magneticField, sizeof(GeneralMagneticField), cudaMemcpyHostToDevice));
COPCORE_CUDA_CHECK(cudaMemcpyToSymbol(gMagneticField, &dMagneticFieldInstance, sizeof(GeneralMagneticField *)));
// Allocate and copy the FieldType instance (not the field array itself), and set the global device pointer
FieldType *dMagneticFieldInstance = nullptr;
COPCORE_CUDA_CHECK(cudaMalloc(&dMagneticFieldInstance, sizeof(FieldType)));
COPCORE_CUDA_CHECK(cudaMemcpy(dMagneticFieldInstance, &magneticField, sizeof(FieldType), cudaMemcpyHostToDevice));
COPCORE_CUDA_CHECK(cudaMemcpyToSymbol(gMagneticField, &dMagneticFieldInstance, sizeof(FieldType *)));

#endif
return true;
}

void FreeGeneralField()
template <typename FieldType>
void FreeBField()
{
#ifdef ADEPT_USE_EXT_BFIELD
GeneralMagneticField *dMagneticFieldInstance = nullptr;
FieldType *dMagneticFieldInstance = nullptr;

// Retrieve the global device pointer from the symbol
COPCORE_CUDA_CHECK(cudaMemcpyFromSymbol(&dMagneticFieldInstance, gMagneticField, sizeof(GeneralMagneticField *)));
COPCORE_CUDA_CHECK(cudaMemcpyFromSymbol(&dMagneticFieldInstance, gMagneticField, sizeof(FieldType *)));

if (dMagneticFieldInstance) {
// Free the device memory and reset global device pointer
COPCORE_CUDA_CHECK(cudaFree(dMagneticFieldInstance));
GeneralMagneticField *nullPtr = nullptr;
COPCORE_CUDA_CHECK(cudaMemcpyToSymbol(gMagneticField, &nullPtr, sizeof(GeneralMagneticField *)));
FieldType *nullPtr = nullptr;
COPCORE_CUDA_CHECK(cudaMemcpyToSymbol(gMagneticField, &nullPtr, sizeof(FieldType *)));
}
#endif
}

void PrepareLeakedBuffers(int numLeaked, adeptint::TrackBuffer &buffer, GPUstate &gpuState)
Expand Down Expand Up @@ -377,8 +365,12 @@ void FreeGPU(GPUstate &gpuState, G4HepEmState *g4hepem_state)
FreeG4HepEmData(g4hepem_state->fData);
delete g4hepem_state;

// Free magnetic field map
FreeGeneralField();
// Free magnetic field
#ifdef ADEPT_USE_EXT_BFIELD
FreeBField<GeneralMagneticField>();
#else
FreeBField<UniformMagneticField>();
#endif
}

template <typename IntegrationLayer>
Expand Down Expand Up @@ -623,6 +615,11 @@ void ShowerGPU(IntegrationLayer &integration, int event, adeptint::TrackBuffer &

adept_scoring::EndOfTransport<IntegrationLayer>(*scoring, scoring_dev, gpuState.stream, integration);
}

// explicit instantiation
template bool InitializeBField<GeneralMagneticField>(GeneralMagneticField &);
template bool InitializeBField<UniformMagneticField>(UniformMagneticField &);

} // namespace adept_impl

#endif
5 changes: 3 additions & 2 deletions include/AdePT/core/AdePTTransport.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
#include <AdePT/core/HostScoringStruct.cuh>
#include <AdePT/core/AdePTConfiguration.hh>
#include <AdePT/magneticfield/GeneralMagneticField.h>
#include <AdePT/magneticfield/UniformMagneticField.h>

#include <VecGeom/base/Config.h>
#ifdef VECGEOM_ENABLE_CUDA
Expand Down Expand Up @@ -108,8 +109,8 @@ class AdePTTransport : public AdePTTransportInterface {
/// @brief Used to map VecGeom to Geant4 volumes for scoring
void InitializeSensitiveVolumeMapping(const G4VPhysicalVolume *g4world, const vecgeom::VPlacedVolume *world);
void InitBVH();
bool InitializeField(double bz);
bool InitializeGeneralField();
bool InitializeBField();
bool InitializeBField(UniformMagneticField &Bfield);
bool InitializeGeometry(const vecgeom::cxx::VPlacedVolume *world);
bool InitializePhysics();
};
Expand Down
64 changes: 35 additions & 29 deletions include/AdePT/core/AdePTTransport.icc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,13 @@
namespace adept_impl {
/// Forward declarations for methods implemented in AdePTTransport.cu
using TrackBuffer = adeptint::TrackBuffer;
bool InitializeField(double);
template <typename FieldType>
bool InitializeBField(FieldType &);
template <typename FieldType>
void FreeField();
bool InitializeApplyCuts(bool);
bool InitializeGeneralField(GeneralMagneticField &);
bool InitializeVolAuxArray(adeptint::VolAuxArray &);
void FreeVolAuxArray(adeptint::VolAuxArray &);
void FreeGeneralField(GeneralMagneticField &);
G4HepEmState *InitG4HepEm();
GPUstate *InitializeGPU(TrackBuffer &, int, int);
AdeptScoring *InitializeScoringGPU(AdeptScoring *scoring);
Expand Down Expand Up @@ -60,19 +61,7 @@ AdePTTransport<IntegrationLayer>::AdePTTransport(AdePTConfiguration &configurati
}

template <typename IntegrationLayer>
bool AdePTTransport<IntegrationLayer>::InitializeField(double bz)
{
return adept_impl::InitializeField(bz);
}

template <typename IntegrationLayer>
bool AdePTTransport<IntegrationLayer>::InitializeApplyCuts(bool applycuts)
{
return adept_impl::InitializeApplyCuts(applycuts);
}

template <typename IntegrationLayer>
bool AdePTTransport<IntegrationLayer>::InitializeGeneralField()
bool AdePTTransport<IntegrationLayer>::InitializeBField()
{
if (!fBfieldFile.empty()) {
// Initialize magnetic field data from file
Expand All @@ -81,11 +70,33 @@ bool AdePTTransport<IntegrationLayer>::InitializeGeneralField()
}

// Delegate the setup of the global view pointer to adept_impl
return adept_impl::InitializeGeneralField(fMagneticField);
return adept_impl::InitializeBField(fMagneticField);
}
return true; // no file provided, but no error encountered, so true is returned
}

template <typename IntegrationLayer>
bool AdePTTransport<IntegrationLayer>::InitializeBField(UniformMagneticField &Bfield)
{
vecgeom::Vector3D<float> position{
0.,
0.,
0.,
};
auto field_value = Bfield.Evaluate(position);
if (field_value.Mag2() > 0) {
// Delegate the setup of the global view pointer to adept_impl
return adept_impl::InitializeBField(Bfield);
}
return true; // no B field provided, but no error encountered, so true is returned
}

template <typename IntegrationLayer>
bool AdePTTransport<IntegrationLayer>::InitializeApplyCuts(bool applycuts)
{
return adept_impl::InitializeApplyCuts(applycuts);
}

template <typename IntegrationLayer>
void AdePTTransport<IntegrationLayer>::AddTrack(
int pdg, int parent_id, double energy, double vertexEnergy, double x, double y, double z, double dirx, double diry,
Expand Down Expand Up @@ -184,22 +195,17 @@ void AdePTTransport<IntegrationLayer>::Initialize(bool common_data)
throw std::runtime_error("AdePTTransport<IntegrationLayer>::Initialize cannot initialize physics on GPU");

#ifdef ADEPT_USE_EXT_BFIELD
// Try to initialize field from file, otherwise initialize from vector
if (!InitializeGeneralField()) {
// Try to initialize field from file
if (!InitializeBField()) {
throw std::runtime_error(
"AdePTTransport<IntegrationLayer>::Initialize cannot initialize GeneralMagneticField on GPU");
// NOTE: if the field option is a run-time option and not a compile time option, uncomment the code below
// to use uniform field in case no file was provided. ToDo: this requires changing the return of
// InitializeGeneralField
// double bz = fIntegrationLayer.GetUniformFieldZ();
// if (!InitializeField(bz))
// throw std::runtime_error("AdePTTransport<IntegrationLayer>::Initialize cannot initialize field on GPU");
}
#endif
// Initialize field from vector
double bz = fIntegrationLayer.GetUniformFieldZ();
if (!InitializeField(bz))
#else
auto field_values = fIntegrationLayer.GetUniformField(); // Get the field value
std::unique_ptr<UniformMagneticField> Bfield = std::make_unique<UniformMagneticField>(field_values);
if (!InitializeBField(*Bfield))
throw std::runtime_error("AdePTTransport<IntegrationLayer>::Initialize cannot initialize field on GPU");
#endif

// Do the material-cut couple index mapping once
// as well as set flags for sensitive volumes and region
Expand Down
4 changes: 3 additions & 1 deletion include/AdePT/core/AdePTTransportStruct.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
#include <AdePT/core/CommonStruct.h>
#include <AdePT/core/HostScoringStruct.cuh>
#include <AdePT/magneticfield/GeneralMagneticField.h>
#include <AdePT/magneticfield/UniformMagneticField.h>

#include "Track.cuh"
#include <AdePT/base/TrackManager.cuh>
Expand Down Expand Up @@ -91,10 +92,11 @@ extern __constant__ struct G4HepEmParameters g4HepEmPars;
extern __constant__ struct G4HepEmData g4HepEmData;

extern __constant__ __device__ adeptint::VolAuxData *gVolAuxData;
extern __constant__ __device__ double BzFieldValue;
extern __constant__ __device__ bool ApplyCuts;
#ifdef ADEPT_USE_EXT_BFIELD
__device__ GeneralMagneticField *gMagneticField = nullptr;
#else
__device__ UniformMagneticField *gMagneticField = nullptr;
#endif

} // namespace adept_impl
Expand Down
50 changes: 23 additions & 27 deletions include/AdePT/core/AsyncAdePTTransport.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,44 +446,33 @@ G4HepEmState *InitG4HepEm()
return state;
}

bool InitializeField(double bz)
{
// Initialize field
COPCORE_CUDA_CHECK(cudaMemcpyToSymbol(BzFieldValue, &bz, sizeof(double)));
return true;
}

bool InitializeGeneralField(GeneralMagneticField &magneticField)
template <typename FieldType>
bool InitializeBField(FieldType &magneticField)
{

#ifdef ADEPT_USE_EXT_BFIELD

// Allocate and copy the GeneralMagneticField instance (not the field array itself), and set the global device pointer
GeneralMagneticField *dMagneticFieldInstance = nullptr;
COPCORE_CUDA_CHECK(cudaMalloc(&dMagneticFieldInstance, sizeof(GeneralMagneticField)));
COPCORE_CUDA_CHECK(
cudaMemcpy(dMagneticFieldInstance, &magneticField, sizeof(GeneralMagneticField), cudaMemcpyHostToDevice));
COPCORE_CUDA_CHECK(cudaMemcpyToSymbol(gMagneticField, &dMagneticFieldInstance, sizeof(GeneralMagneticField *)));
// Allocate and copy the FieldType instance (not the field array itself), and set the global device pointer
FieldType *dMagneticFieldInstance = nullptr;
COPCORE_CUDA_CHECK(cudaMalloc(&dMagneticFieldInstance, sizeof(FieldType)));
COPCORE_CUDA_CHECK(cudaMemcpy(dMagneticFieldInstance, &magneticField, sizeof(FieldType), cudaMemcpyHostToDevice));
COPCORE_CUDA_CHECK(cudaMemcpyToSymbol(gMagneticField, &dMagneticFieldInstance, sizeof(FieldType *)));

#endif
return true;
}

void FreeGeneralField()
template <typename FieldType>
void FreeBField()
{
#ifdef ADEPT_USE_EXT_BFIELD
GeneralMagneticField *dMagneticFieldInstance = nullptr;
FieldType *dMagneticFieldInstance = nullptr;

// Retrieve the global device pointer from the symbol
COPCORE_CUDA_CHECK(cudaMemcpyFromSymbol(&dMagneticFieldInstance, gMagneticField, sizeof(GeneralMagneticField *)));
COPCORE_CUDA_CHECK(cudaMemcpyFromSymbol(&dMagneticFieldInstance, gMagneticField, sizeof(FieldType *)));

if (dMagneticFieldInstance) {
// Free the device memory and reset global device pointer
COPCORE_CUDA_CHECK(cudaFree(dMagneticFieldInstance));
GeneralMagneticField *nullPtr = nullptr;
COPCORE_CUDA_CHECK(cudaMemcpyToSymbol(gMagneticField, &nullPtr, sizeof(GeneralMagneticField *)));
FieldType *nullPtr = nullptr;
COPCORE_CUDA_CHECK(cudaMemcpyToSymbol(gMagneticField, &nullPtr, sizeof(FieldType *)));
}
#endif
}

bool InitializeApplyCuts(bool applycuts)
Expand Down Expand Up @@ -1204,10 +1193,18 @@ void FreeGPU(std::unique_ptr<AsyncAdePT::GPUstate, AsyncAdePT::GPUstateDeleter>
// Free G4HepEm data
FreeG4HepEmData(g4hepem_state.fData);

// Free magnetic field map
FreeGeneralField();
// Free magnetic field
#ifdef ADEPT_USE_EXT_BFIELD
FreeBField<GeneralMagneticField>();
#else
FreeBField<UniformMagneticField>();
#endif
}

// explicit instantiation
template bool InitializeBField<GeneralMagneticField>(GeneralMagneticField &);
template bool InitializeBField<UniformMagneticField>(UniformMagneticField &);

} // namespace async_adept_impl

namespace AsyncAdePT {
Expand All @@ -1216,7 +1213,6 @@ __constant__ __device__ struct G4HepEmParameters g4HepEmPars;
__constant__ __device__ struct G4HepEmData g4HepEmData;

__constant__ __device__ adeptint::VolAuxData *gVolAuxData = nullptr;
__constant__ __device__ double BzFieldValue = 0;
__constant__ __device__ bool ApplyCuts = false;

/// Transfer volume auxiliary data to GPU
Expand Down
5 changes: 3 additions & 2 deletions include/AdePT/core/AsyncAdePTTransport.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
#include <AdePT/core/AsyncAdePTTransportStruct.hh>
#include <AdePT/core/PerEventScoringStruct.cuh>
#include <AdePT/magneticfield/GeneralMagneticField.h>
#include <AdePT/magneticfield/UniformMagneticField.h>

#include <VecGeom/base/Config.h>
#include <VecGeom/management/CudaManager.h> // forward declares vecgeom::cxx::VPlacedVolume
Expand Down Expand Up @@ -74,8 +75,8 @@ private:

void Initialize();
void InitBVH();
bool InitializeField(double bz);
bool InitializeGeneralField();
bool InitializeBField();
bool InitializeBField(UniformMagneticField &Bfield);
bool InitializeGeometry(const vecgeom::cxx::VPlacedVolume *world);
bool InitializePhysics();

Expand Down
Loading