GField Class Reference

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

#include <gfield.h>

Inheritance diagram for GField:

Collaboration diagram for GField:

Public Member Functions
	GField ()=default
	Default constructor. More...
virtual	~GField ()=default
	Virtual destructor. More...
virtual void	GetFieldValue (const double x[3], double *bfield) const =0
	Pure virtual function to get the magnetic field value. More...
G4FieldManager *	create_FieldManager ()
	Creates the G4FieldManager for the field. More...
virtual void	load_field_definitions (GFieldDefinition gfd)
	Sets the field definition for the field. More...
void	gFLogMessage (std::string message)
	Logs a message with the field context. More...
int	get_field_parameter_int (std::string key)
double	get_field_parameter_double (std::string key)

Static Public Member Functions
static GField *	instantiate (const dlhandle handle)

Protected Attributes
GFieldDefinition	gfield_definitions

Detailed Description

Definition at line 69 of file gfield.h.

Constructor & Destructor Documentation

GField()

GField::GField ( )

default

~GField()

virtual GField::~GField ( )

virtualdefault

Member Function Documentation

create_FieldManager()

G4FieldManager * GField::create_FieldManager

(

)

Returns

Pointer to the G4FieldManager.

Definition at line 21 of file gfield.cc.

get_field_parameter_double()

double GField::get_field_parameter_double ( std::string  key )

inline

Definition at line 114 of file gfield.h.

get_field_parameter_int()

int GField::get_field_parameter_int ( std::string  key )

inline

Definition at line 111 of file gfield.h.

GetFieldValue()

virtual void GField::GetFieldValue ( const double  x[3], double *  bfield  ) const

pure virtual

Parameters

x	Position in space.
bfield	Magnetic field vector.

gFLogMessage()

void GField::gFLogMessage ( std::string  message )

inline

Parameters

message

Message to log.

Definition at line 107 of file gfield.h.

instantiate()

static GField* GField::instantiate ( const dlhandle  handle )

inlinestatic

Definition at line 133 of file gfield.h.

load_field_definitions()

virtual void GField::load_field_definitions ( GFieldDefinition  gfd )

inlinevirtual

Parameters

gfd	Field definition to set.

Reimplemented in GField_MultipolesFactory.

Definition at line 99 of file gfield.h.

Field Documentation

gfield_definitions

GFieldDefinition GField::gfield_definitions

protected

Definition at line 129 of file gfield.h.

---

The documentation for this class was generated from the following files:

• gfield.h
• gfield.cc