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 (const std::shared_ptr< GOptions > &gopt)
	Default constructor.
virtual void	GetFieldValue (const double x[3], double *bfield) const =0
	Pure virtual function to get the magnetic field value.
G4FieldManager *	create_FieldManager ()
	Creates the G4FieldManager for the field.
virtual void	load_field_definitions (GFieldDefinition gfd)
	Sets the field definition for the field.
int	get_field_parameter_int (const std::string &key)
double	get_field_parameter_double (const std::string &key)
void	set_loggers (const std::shared_ptr< GOptions > &g)

Static Public Member Functions
static GField *	instantiate (const dlhandle h, std::shared_ptr< GOptions > g)

Protected Attributes
GFieldDefinition	gfield_definitions

Detailed Description

Definition at line 62 of file gfield.h.

Constructor & Destructor Documentation

GField()

GField::GField ( const std::shared_ptr< GOptions > & gopt )

inlineexplicit

Definition at line 69 of file gfield.h.

Member Function Documentation

create_FieldManager()

G4FieldManager * GField::create_FieldManager

(

)

Returns

Pointer to the G4FieldManager.

Definition at line 23 of file gfield.cc.

get_field_parameter_double()

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

inline

Definition at line 91 of file gfield.h.

get_field_parameter_int()

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

inline

Definition at line 90 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.

instantiate()

static GField * GField::instantiate ( const dlhandle h, std::shared_ptr< GOptions > g )

inlinestatic

Definition at line 116 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 88 of file gfield.h.

set_loggers()

void GField::set_loggers ( const std::shared_ptr< GOptions > & g )

inline

Definition at line 93 of file gfield.h.

Field Documentation

gfield_definitions

GFieldDefinition GField::gfield_definitions

protected

Definition at line 113 of file gfield.h.

---

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

• gfield.h
• gfield.cc