Plugin-driven magnetic-field framework. More...

Collaboration diagram for GField module:

Topics
	GField examples
	Example programs demonstrating how to configure and use the GField module.

	GField multipoles factory
	Multipole magnetic-field plugin implementation.

Namespaces
namespace	gfields

Data Structures
struct	GFieldDefinition
	Lightweight configuration carrier used to load and configure a GField plugin. More...

class	GField
	Abstract base class representing a magnetic field. More...

class	GMagneto
	Manager for magnetic fields and their associated `G4FieldManager` objects. More...

#define	GFIELD_DEFAULT_INTEGRATION_STEPPER "G4DormandPrince745"
	Default integration stepper name used when the requested stepper is unsupported.

#define	GFIELD_DEFAULT_MINIMUM_STEP "1.0*mm"
	Default minimum step for the chord finder (string with Geant4 units).

#define	GFIELD_DEFAULT_VERTEX "0*mm"
	Default origin coordinate component for multipole fields (string with Geant4 units).

#define	GFIELD_DEFAULT_ROTANGLE "0*deg"
	Default multipole roll rotation angle (string with Geant4 units).

#define	GFIELD_DEFAULT_VERBOSITY "0"
	Default verbosity level (string) for field-related configuration.

#define	ERR_WRONG_FIELD_ROTATION 1201

#define	ERR_WRONG_FIELD_NOT_FOUND 1202

#define	ERR_STEPPER_NOT_FOUND 1203

#define	ERR_WRONG_POLE_NUMBER 1204

Detailed Description

The module provides:

A common abstract interface for magnetic fields (GField),
A lightweight configuration carrier (GFieldDefinition),
A manager that loads plugins and builds G4FieldManager instances (GMagneto),
Option definitions for fields implemented in this module (namespace gfields).

The actual magnetic-field behavior is implemented in plugins (shared libraries) that expose a C factory symbol (see instantiate()).

Macro Definition Documentation

◆ ERR_STEPPER_NOT_FOUND

#define ERR_STEPPER_NOT_FOUND 1203

Definition at line 43 of file gfieldConventions.h.

◆ ERR_WRONG_FIELD_NOT_FOUND

#define ERR_WRONG_FIELD_NOT_FOUND 1202

Definition at line 42 of file gfieldConventions.h.

◆ ERR_WRONG_FIELD_ROTATION

#define ERR_WRONG_FIELD_ROTATION 1201

Definition at line 41 of file gfieldConventions.h.

◆ ERR_WRONG_POLE_NUMBER

#define ERR_WRONG_POLE_NUMBER 1204

Definition at line 44 of file gfieldConventions.h.

◆ GFIELD_DEFAULT_INTEGRATION_STEPPER

#define GFIELD_DEFAULT_INTEGRATION_STEPPER "G4DormandPrince745"

This is a Geant4 stepper class name expressed as a string.

Definition at line 13 of file gfieldConventions.h.

◆ GFIELD_DEFAULT_MINIMUM_STEP

#define GFIELD_DEFAULT_MINIMUM_STEP "1.0*mm"

This value is stored as a string to preserve unit expressions and is parsed later.

Definition at line 20 of file gfieldConventions.h.

◆ GFIELD_DEFAULT_ROTANGLE

#define GFIELD_DEFAULT_ROTANGLE "0*deg"

Definition at line 32 of file gfieldConventions.h.

◆ GFIELD_DEFAULT_VERBOSITY

#define GFIELD_DEFAULT_VERBOSITY "0"

Definition at line 37 of file gfieldConventions.h.

◆ GFIELD_DEFAULT_VERTEX

#define GFIELD_DEFAULT_VERTEX "0*mm"

Definition at line 27 of file gfieldConventions.h.

Topics

Namespaces

Data Structures