Implementation object of a field with constant strength. More...

#include <FieldTypes.h>

Inheritance diagram for dd4hep::ConstantField:

Public Types
enum	{ FIELD_LOCAL = 1, FIELD_TRANSLATED = 2, FIELD_ROTATED = 4 }

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

Public Member Functions
	ConstantField ()=default
	Initializing constructor. More...

virtual void	fieldComponents (const double , 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
Direction	direction
	Field direction. More...

Solid	volume { }
	Boundary volume (optional) More...

Transform3D	inverse_pos { }
	If solid is set: allow for movement of the solid. More...

unsigned char	flag { 0 }
	The access to the field will be optimized. Remember properties. More...

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...

Detailed Description

Implementation object of a field with constant strength.

Generic constant uniform field

Author: M.Frank

Version: 1.0

Definition at line 34 of file FieldTypes.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
FIELD_LOCAL
FIELD_TRANSLATED
FIELD_ROTATED

Definition at line 36 of file FieldTypes.h.

Constructor & Destructor Documentation

◆ ConstantField()

dd4hep::ConstantField::ConstantField ( )

default

Initializing constructor.

Member Function Documentation

◆ fieldComponents()

void ConstantField::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.

Coordinates not in volume: nothing to sum up.

Implements dd4hep::CartesianField::Object.

Definition at line 31 of file FieldTypes.cpp.

Member Data Documentation

◆ direction

Direction dd4hep::ConstantField::direction

Field direction.

Definition at line 38 of file FieldTypes.h.

◆ flag

unsigned char dd4hep::ConstantField::flag { 0 }

The access to the field will be optimized. Remember properties.

Definition at line 44 of file FieldTypes.h.

◆ inverse_pos

Transform3D dd4hep::ConstantField::inverse_pos { }

If solid is set: allow for movement of the solid.

Definition at line 42 of file FieldTypes.h.

◆ volume

Solid dd4hep::ConstantField::volume { }

Boundary volume (optional)

Definition at line 40 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 Types

Public Member Functions

Public Attributes