CbmFieldConst Class Reference

#include <CbmFieldConst.h>

Inheritance diagram for CbmFieldConst:

Collaboration diagram for CbmFieldConst:

Public Member Functions
	CbmFieldConst ()
	CbmFieldConst (const char *name, Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax, Double_t zMin, Double_t zMax, Double_t bX, Double_t bY, Double_t bZ)
	CbmFieldConst (CbmFieldPar *fieldPar)
virtual	~CbmFieldConst ()
void	SetFieldRegion (Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax, Double_t zMin, Double_t zMax)
void	SetField (Double_t bX, Double_t bY, Double_t bZ)
virtual Double_t	GetBx (Double_t x, Double_t y, Double_t z) override
virtual Double_t	GetBy (Double_t x, Double_t y, Double_t z) override
virtual Double_t	GetBz (Double_t x, Double_t y, Double_t z) override
virtual void	GetFieldValue (const Double_t point[3], Double_t *bField) override
Double_t	GetXmin () const
Double_t	GetXmax () const
Double_t	GetYmin () const
Double_t	GetYmax () const
Double_t	GetZmin () const
Double_t	GetZmax () const
Double_t	GetBx () const
Double_t	GetBy () const
Double_t	GetBz () const
virtual void	Print (Option_t *="") const override

Private Member Functions
	ClassDefOverride (CbmFieldConst, 1)

Private Attributes
Double_t	fXmin
Double_t	fXmax
Double_t	fYmin
Double_t	fYmax
Double_t	fZmin
Double_t	fZmax
Double_t	fBx
Double_t	fBy
Double_t	fBz

Detailed Description

Definition at line 32 of file CbmFieldConst.h.

Constructor & Destructor Documentation

CbmFieldConst() [1/3]

CbmFieldConst::CbmFieldConst

(

)

Default constructor

Definition at line 28 of file CbmFieldConst.cxx.

References fBx, fBy, fBz, fXmax, fXmin, fYmax, fYmin, fZmax, and fZmin.

Referenced by ClassDefOverride().

CbmFieldConst() [2/3]

CbmFieldConst::CbmFieldConst	(	const char *	name,
		Double_t	xMin,
		Double_t	xMax,
		Double_t	yMin,
		Double_t	yMax,
		Double_t	zMin,
		Double_t	zMax,
		Double_t	bX,
		Double_t	bY,
		Double_t	bZ )

Standard constructor

Parameters

name	Object name
xMin,xMax	x region of field (global coordinates)
yMin,yMax	y region of field (global coordinates)
zMin,zMax	z region of field (global coordinates)
bX,bY,bZ	Field values [kG]

Definition at line 46 of file CbmFieldConst.cxx.

References fBx, fBy, fBz, fXmax, fXmin, fYmax, fYmin, fZmax, and fZmin.

CbmFieldConst() [3/3]

CbmFieldConst::CbmFieldConst

(

CbmFieldPar *

fieldPar

)

Constructor from CbmFieldPar

Definition at line 65 of file CbmFieldConst.cxx.

References fBx, fBy, fBz, fXmax, fXmin, fYmax, fYmin, fZmax, fZmin, CbmFieldPar::GetBx(), CbmFieldPar::GetBy(), CbmFieldPar::GetBz(), CbmFieldPar::GetType(), CbmFieldPar::GetXmax(), CbmFieldPar::GetXmin(), CbmFieldPar::GetYmax(), CbmFieldPar::GetYmin(), CbmFieldPar::GetZmax(), and CbmFieldPar::GetZmin().

~CbmFieldConst()

CbmFieldConst::~CbmFieldConst ( )

virtual

Destructor

Definition at line 98 of file CbmFieldConst.cxx.

Member Function Documentation

ClassDefOverride()

CbmFieldConst::ClassDefOverride ( CbmFieldConst , 1  )

private

References CbmFieldConst().

GetBx() [1/2]

Double_t CbmFieldConst::GetBx ( ) const

inline

Accessors to field values

Definition at line 96 of file CbmFieldConst.h.

References fBx.

GetBx() [2/2]

Double_t CbmFieldConst::GetBx ( Double_t x, Double_t y, Double_t z )

overridevirtual

Get components of field at a given point

Parameters

x,y,z

Point coordinates [cm]

Definition at line 127 of file CbmFieldConst.cxx.

References fBx, fXmax, fYmax, fZmax, x, and y.

Referenced by CbmFieldPar::SetParameters().

GetBy() [1/2]

Double_t CbmFieldConst::GetBy ( ) const

inline

Definition at line 97 of file CbmFieldConst.h.

References fBy.

GetBy() [2/2]

Double_t CbmFieldConst::GetBy ( Double_t x, Double_t y, Double_t z )

overridevirtual

Definition at line 136 of file CbmFieldConst.cxx.

References fBy, fXmax, fYmax, fZmax, x, and y.

Referenced by CbmFieldPar::SetParameters().

GetBz() [1/2]

Double_t CbmFieldConst::GetBz ( ) const

inline

Definition at line 98 of file CbmFieldConst.h.

References fBz.

GetBz() [2/2]

Double_t CbmFieldConst::GetBz ( Double_t x, Double_t y, Double_t z )

overridevirtual

Definition at line 145 of file CbmFieldConst.cxx.

References fBz, fXmax, fYmax, fZmax, x, and y.

Referenced by CbmFieldPar::SetParameters().

GetFieldValue()

void CbmFieldConst::GetFieldValue ( const Double_t point[3], Double_t * bField )

overridevirtual

Get the field value at a point

Parameters

point	Point coordinates (global) [cm]
bField	Array with field components [kG]

Definition at line 154 of file CbmFieldConst.cxx.

References fBx, fBy, fBz, fXmax, fYmax, fZmax, x, and y.

GetXmax()

Double_t CbmFieldConst::GetXmax ( ) const

inline

Definition at line 88 of file CbmFieldConst.h.

References fXmax.

Referenced by CbmFieldMapDistorted::SetFromParent(), and CbmFieldPar::SetParameters().

GetXmin()

Double_t CbmFieldConst::GetXmin ( ) const

inline

Accessors to field region

Definition at line 87 of file CbmFieldConst.h.

References fXmin.

Referenced by CbmFieldMapDistorted::SetFromParent(), and CbmFieldPar::SetParameters().

GetYmax()

Double_t CbmFieldConst::GetYmax ( ) const

inline

Definition at line 90 of file CbmFieldConst.h.

References fYmax.

Referenced by CbmFieldMapDistorted::SetFromParent(), and CbmFieldPar::SetParameters().

GetYmin()

Double_t CbmFieldConst::GetYmin ( ) const

inline

Definition at line 89 of file CbmFieldConst.h.

References fYmin.

Referenced by CbmFieldMapDistorted::SetFromParent(), and CbmFieldPar::SetParameters().

GetZmax()

Double_t CbmFieldConst::GetZmax ( ) const

inline

Definition at line 92 of file CbmFieldConst.h.

References fZmax.

Referenced by CbmFieldMapDistorted::SetFromParent(), and CbmFieldPar::SetParameters().

GetZmin()

Double_t CbmFieldConst::GetZmin ( ) const

inline

Definition at line 91 of file CbmFieldConst.h.

References fZmin.

Referenced by CbmFieldMapDistorted::SetFromParent(), and CbmFieldPar::SetParameters().

Print()

void CbmFieldConst::Print ( Option_t * = "" ) const

overridevirtual

Screen output

Definition at line 174 of file CbmFieldConst.cxx.

References fBx, fBy, fBz, fXmax, fXmin, fYmax, fYmin, fZmax, and fZmin.

SetField()

void CbmFieldConst::SetField	(	Double_t	bX,
		Double_t	bY,
		Double_t	bZ )

Set the field values

Parameters

bX,bY,bZ

Field values [kG]

Definition at line 117 of file CbmFieldConst.cxx.

References fBx, fBy, and fBz.

SetFieldRegion()

void CbmFieldConst::SetFieldRegion	(	Double_t	xMin,
		Double_t	xMax,
		Double_t	yMin,
		Double_t	yMax,
		Double_t	zMin,
		Double_t	zMax )

Set the field region

Parameters

xMin,xMax	x region of field (global coordinates)
yMin,yMax	y region of field (global coordinates)
zMin,zMax	z region of field (global coordinates)

Definition at line 103 of file CbmFieldConst.cxx.

References fXmax, fXmin, fYmax, fYmin, fZmax, and fZmin.

Member Data Documentation

fBx

Double_t CbmFieldConst::fBx

private

Field components inside the field region

Definition at line 115 of file CbmFieldConst.h.

Referenced by CbmFieldConst(), CbmFieldConst(), CbmFieldConst(), GetBx(), GetBx(), GetFieldValue(), Print(), and SetField().

fBy

Double_t CbmFieldConst::fBy

private

Definition at line 116 of file CbmFieldConst.h.

Referenced by CbmFieldConst(), CbmFieldConst(), CbmFieldConst(), GetBy(), GetBy(), GetFieldValue(), Print(), and SetField().

fBz

Double_t CbmFieldConst::fBz

private

Definition at line 117 of file CbmFieldConst.h.

Referenced by CbmFieldConst(), CbmFieldConst(), CbmFieldConst(), GetBz(), GetBz(), GetFieldValue(), Print(), and SetField().

fXmax

Double_t CbmFieldConst::fXmax

private

Definition at line 108 of file CbmFieldConst.h.

Referenced by CbmFieldConst(), CbmFieldConst(), CbmFieldConst(), GetBx(), GetBy(), GetBz(), GetFieldValue(), GetXmax(), Print(), and SetFieldRegion().

fXmin

Double_t CbmFieldConst::fXmin

private

Limits of the field region

Definition at line 107 of file CbmFieldConst.h.

Referenced by CbmFieldConst(), CbmFieldConst(), CbmFieldConst(), GetXmin(), Print(), and SetFieldRegion().

fYmax

Double_t CbmFieldConst::fYmax

private

Definition at line 110 of file CbmFieldConst.h.

Referenced by CbmFieldConst(), CbmFieldConst(), CbmFieldConst(), GetBx(), GetBy(), GetBz(), GetFieldValue(), GetYmax(), Print(), and SetFieldRegion().

fYmin

Double_t CbmFieldConst::fYmin

private

Definition at line 109 of file CbmFieldConst.h.

Referenced by CbmFieldConst(), CbmFieldConst(), CbmFieldConst(), GetYmin(), Print(), and SetFieldRegion().

fZmax

Double_t CbmFieldConst::fZmax

private

Definition at line 112 of file CbmFieldConst.h.

Referenced by CbmFieldConst(), CbmFieldConst(), CbmFieldConst(), GetBx(), GetBy(), GetBz(), GetFieldValue(), GetZmax(), Print(), and SetFieldRegion().

fZmin

Double_t CbmFieldConst::fZmin

private

Definition at line 111 of file CbmFieldConst.h.

Referenced by CbmFieldConst(), CbmFieldConst(), CbmFieldConst(), GetZmin(), Print(), and SetFieldRegion().

---

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

• CbmFieldConst.h
• CbmFieldConst.cxx