Implementation object of a dipole magnetic field. More...

#include <FieldTypes.h>

Inheritance diagram for dd4hep::DipoleField:

Public Member Functions
	DipoleField ()
	Initializing constructor. More...

virtual void	fieldComponents (const double pos, double field)
	Call to access the field components at a given location. More...

Public Member Functions inherited from dd4hep::CartesianField::Object
	Object ()
	Default constructor. More...

virtual	~Object ()
	Default destructor. More...

Public Member Functions inherited from dd4hep::CartesianField::TypedObject
	NamedObject (const char nam, const char typ="")
	Default constructor. More...

	NamedObject (const std::string &nam)
	Default constructor. More...

	NamedObject (const std::string &nam, const std::string &typ)
	Default constructor. More...

	NamedObject ()=default
	Default constructor. More...

	NamedObject (const NamedObject &c)=default
	Default constructor. More...

	NamedObject (NamedObject &&c)=default
	Default constructor. More...

Public Member Functions inherited from dd4hep::NamedObject
	NamedObject (const char nam, const char typ="")
	Initializing constructor. More...

	NamedObject (const std::string &nam)
	Initializing constructor. More...

	NamedObject (const std::string &nam, const std::string &typ)
	Initializing constructor. More...

	NamedObject ()=default
	Standard constructor. More...

	NamedObject (const NamedObject &c)=default
	Copy constructor. More...

	NamedObject (NamedObject &&c)=default
	Move constructor. More...

virtual	~NamedObject ()=default
	Default destructor. More...

NamedObject &	operator= (const NamedObject &c)=default
	Assignment operator. More...

NamedObject &	operator= (NamedObject &&c)=default
	Move assignment operator. More...

const char *	GetName () const
	Access name. More...

void	SetName (const char *nam)
	Set name (used by Handle) More...

void	SetTitle (const char *tit)
	Set Title (used by Handle) More...

const char *	GetTitle () const
	Get name (used by Handle) More...

Public Attributes
double	zmax

double	zmin

double	rmax

Coefficents	coefficents

Public Attributes inherited from dd4hep::CartesianField::Object
Properties	properties
	Field extensions. More...

Public Attributes inherited from dd4hep::CartesianField::TypedObject
int	field_type { UNKNOWN }
	Field type. More...

Public Attributes inherited from dd4hep::NamedObject
std::string	name
	The object name. More...

std::string	type
	The object type. More...

Additional Inherited Members
Public Types inherited from dd4hep::CartesianField::Object
typedef std::vector< double >	Coefficents
	Utility definition for concrete implementations. More...

Detailed Description

Implementation object of a dipole magnetic field.

Generic dipole magnetic field

Author: M.Frank

Version: 1.0

Definition at line 77 of file FieldTypes.h.

Constructor & Destructor Documentation

◆ DipoleField()

DipoleField::DipoleField ( )

Initializing constructor.

Definition at line 68 of file FieldTypes.cpp.

Member Function Documentation

◆ fieldComponents()

void DipoleField::fieldComponents	(	const double *	pos,
		double *	field
	)

virtual

Call to access the field components at a given location.

Compute the field components at a given location and add to given field.

Implements dd4hep::CartesianField::Object.

Definition at line 73 of file FieldTypes.cpp.

Member Data Documentation

◆ coefficents

Coefficents dd4hep::DipoleField::coefficents

Definition at line 82 of file FieldTypes.h.

◆ rmax

double dd4hep::DipoleField::rmax

Definition at line 81 of file FieldTypes.h.

◆ zmax

double dd4hep::DipoleField::zmax

Definition at line 79 of file FieldTypes.h.

◆ zmin

double dd4hep::DipoleField::zmin

Definition at line 80 of file FieldTypes.h.

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

DDCore/include/DD4hep/FieldTypes.h
DDCore/src/FieldTypes.cpp

Public Member Functions

Public Attributes

Additional Inherited Members