BmnFieldConst Class Reference

#include <BmnFieldConst.h>

Inheritance diagram for BmnFieldConst:

Collaboration diagram for BmnFieldConst:

Public Member Functions
	BmnFieldConst ()
	Default constructor.
	BmnFieldConst (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.
	BmnFieldConst (BmnFieldPar *fieldPar)
	Constructor from BmnFieldPar.
virtual	~BmnFieldConst ()
	Destructor.
void	FillParContainer ()
void	SetFieldRegion (Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax, Double_t zMin, Double_t zMax)
	Set the field region.
void	SetField (Double_t bX, Double_t bY, Double_t bZ)
	Set the field values.
void	SetFieldOff (Bool_t is_off=kTRUE)
	Turn magnetic field off.
virtual Double_t	GetBx (Double_t x, Double_t y, Double_t z)
	Get components of field at a given point.
virtual Double_t	GetBy (Double_t x, Double_t y, Double_t z)
virtual Double_t	GetBz (Double_t x, Double_t y, Double_t z)
Double_t	GetXmin () const
	Accessors to field region.
Double_t	GetXmax () const
Double_t	GetYmin () const
Double_t	GetYmax () const
Double_t	GetZmin () const
Double_t	GetZmax () const
Double_t	GetBx () const
	Accessors to field values.
Double_t	GetBy () const
Double_t	GetBz () const
Bool_t	IsFieldOff () const
	Whether magnetic field is off.
virtual void	Print (Option_t *) const
	Screen output.
	BmnFieldConst ()
	Default constructor.
	BmnFieldConst (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.
	BmnFieldConst (BmnFieldPar *fieldPar)
	Constructor from BmnFieldPar.
virtual	~BmnFieldConst ()
	Destructor.
void	FillParContainer ()
void	SetFieldRegion (Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax, Double_t zMin, Double_t zMax)
	Set the field region.
void	SetField (Double_t bX, Double_t bY, Double_t bZ)
	Set the field values.
void	SetFieldOff (Bool_t is_off=kTRUE)
	Turn magnetic field off.
virtual Double_t	GetBx (Double_t x, Double_t y, Double_t z)
	Get components of field at a given point.
virtual Double_t	GetBy (Double_t x, Double_t y, Double_t z)
virtual Double_t	GetBz (Double_t x, Double_t y, Double_t z)
Double_t	GetXmin () const
	Accessors to field region.
Double_t	GetXmax () const
Double_t	GetYmin () const
Double_t	GetYmax () const
Double_t	GetZmin () const
Double_t	GetZmax () const
Double_t	GetBx () const
	Accessors to field values.
Double_t	GetBy () const
Double_t	GetBz () const
Bool_t	IsFieldOff () const
	Whether magnetic field is off.
virtual void	Print (Option_t *) const
	Screen output.

Private Attributes
Double_t	fXmin
	Limits of the field region.
Double_t	fXmax
Double_t	fYmin
Double_t	fYmax
Double_t	fZmin
Double_t	fZmax
Double_t	fBx
	Field components inside the field region.
Double_t	fBy
Double_t	fBz
Bool_t	fIsOff
	Whether magnetic field is off.

Detailed Description

Definition at line 16 of file BmnFieldConst.h.

Constructor & Destructor Documentation

BmnFieldConst() [1/6]

BmnFieldConst::BmnFieldConst

(

)

Definition at line 25 of file BmnFieldConst.cxx.

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

Referenced by Print().

Here is the caller graph for this function:

BmnFieldConst() [2/6]

BmnFieldConst::BmnFieldConst	(	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 )

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 41 of file BmnFieldConst.cxx.

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

BmnFieldConst() [3/6]

BmnFieldConst::BmnFieldConst

(

BmnFieldPar *

fieldPar

)

Definition at line 67 of file BmnFieldConst.cxx.

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

Here is the call graph for this function:

~BmnFieldConst() [1/2]

BmnFieldConst::~BmnFieldConst ( )

virtual

Definition at line 98 of file BmnFieldConst.cxx.

BmnFieldConst() [4/6]

BmnFieldConst::BmnFieldConst

(

)

BmnFieldConst() [5/6]

BmnFieldConst::BmnFieldConst	(	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 )

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]

References zMax, and zMin.

BmnFieldConst() [6/6]

BmnFieldConst::BmnFieldConst

(

BmnFieldPar *

fieldPar

)

~BmnFieldConst() [2/2]

virtual BmnFieldConst::~BmnFieldConst ( )

virtual

Member Function Documentation

FillParContainer() [1/2]

void BmnFieldConst::FillParContainer

(

)

Definition at line 167 of file BmnFieldConst.cxx.

References BmnFieldPar::SetParameters().

Here is the call graph for this function:

FillParContainer() [2/2]

void BmnFieldConst::FillParContainer

(

)

GetBx() [1/4]

Double_t BmnFieldConst::GetBx ( ) const

inline

Definition at line 79 of file BmnFieldConst.h.

References fBx.

GetBx() [2/4]

Double_t BmnFieldConst::GetBx ( ) const

inline

Definition at line 79 of file BmnFieldConst.h.

References fBx.

GetBx() [3/4]

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

virtual

Parameters

x,y,z

Point coordinates [cm]

Definition at line 126 of file BmnFieldConst.cxx.

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

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

Here is the caller graph for this function:

GetBx() [4/4]

virtual Double_t BmnFieldConst::GetBx ( Double_t x, Double_t y, Double_t z )

virtual

Parameters

x,y,z

Point coordinates [cm]

References x, y, and z.

GetBy() [1/4]

Double_t BmnFieldConst::GetBy ( ) const

inline

Definition at line 80 of file BmnFieldConst.h.

References fBy.

GetBy() [2/4]

Double_t BmnFieldConst::GetBy ( ) const

inline

Definition at line 80 of file BmnFieldConst.h.

References fBy.

GetBy() [3/4]

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

virtual

Definition at line 134 of file BmnFieldConst.cxx.

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

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

Here is the caller graph for this function:

GetBy() [4/4]

virtual Double_t BmnFieldConst::GetBy ( Double_t x, Double_t y, Double_t z )

virtual

References x, y, and z.

GetBz() [1/4]

Double_t BmnFieldConst::GetBz ( ) const

inline

Definition at line 81 of file BmnFieldConst.h.

References fBz.

GetBz() [2/4]

Double_t BmnFieldConst::GetBz ( ) const

inline

Definition at line 81 of file BmnFieldConst.h.

References fBz.

GetBz() [3/4]

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

virtual

Definition at line 142 of file BmnFieldConst.cxx.

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

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

Here is the caller graph for this function:

GetBz() [4/4]

virtual Double_t BmnFieldConst::GetBz ( Double_t x, Double_t y, Double_t z )

virtual

References x, y, and z.

GetXmax() [1/2]

Double_t BmnFieldConst::GetXmax ( ) const

inline

Definition at line 72 of file BmnFieldConst.h.

References fXmax.

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

Here is the caller graph for this function:

GetXmax() [2/2]

Double_t BmnFieldConst::GetXmax ( ) const

inline

Definition at line 72 of file BmnFieldConst.h.

References fXmax.

GetXmin() [1/2]

Double_t BmnFieldConst::GetXmin ( ) const

inline

Definition at line 71 of file BmnFieldConst.h.

References fXmin.

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

Here is the caller graph for this function:

GetXmin() [2/2]

Double_t BmnFieldConst::GetXmin ( ) const

inline

Definition at line 71 of file BmnFieldConst.h.

References fXmin.

GetYmax() [1/2]

Double_t BmnFieldConst::GetYmax ( ) const

inline

Definition at line 74 of file BmnFieldConst.h.

References fYmax.

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

Here is the caller graph for this function:

GetYmax() [2/2]

Double_t BmnFieldConst::GetYmax ( ) const

inline

Definition at line 74 of file BmnFieldConst.h.

References fYmax.

GetYmin() [1/2]

Double_t BmnFieldConst::GetYmin ( ) const

inline

Definition at line 73 of file BmnFieldConst.h.

References fYmin.

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

Here is the caller graph for this function:

GetYmin() [2/2]

Double_t BmnFieldConst::GetYmin ( ) const

inline

Definition at line 73 of file BmnFieldConst.h.

References fYmin.

GetZmax() [1/2]

Double_t BmnFieldConst::GetZmax ( ) const

inline

Definition at line 76 of file BmnFieldConst.h.

References fZmax.

Referenced by BmnFillDstTask::Init(), BmnMultiField::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

Here is the caller graph for this function:

GetZmax() [2/2]

Double_t BmnFieldConst::GetZmax ( ) const

inline

Definition at line 76 of file BmnFieldConst.h.

References fZmax.

GetZmin() [1/2]

Double_t BmnFieldConst::GetZmin ( ) const

inline

Definition at line 75 of file BmnFieldConst.h.

References fZmin.

Referenced by BmnFillDstTask::Init(), BmnMultiField::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

Here is the caller graph for this function:

GetZmin() [2/2]

Double_t BmnFieldConst::GetZmin ( ) const

inline

Definition at line 75 of file BmnFieldConst.h.

References fZmin.

IsFieldOff() [1/2]

Bool_t BmnFieldConst::IsFieldOff ( ) const

inline

Definition at line 84 of file BmnFieldConst.h.

References fIsOff.

Referenced by BmnFieldPar::SetParameters().

Here is the caller graph for this function:

IsFieldOff() [2/2]

Bool_t BmnFieldConst::IsFieldOff ( ) const

inline

Definition at line 84 of file BmnFieldConst.h.

References fIsOff.

Print() [1/2]

void BmnFieldConst::Print ( Option_t * ) const

virtual

Definition at line 150 of file BmnFieldConst.cxx.

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

Print() [2/2]

virtual void BmnFieldConst::Print ( Option_t * ) const

virtual

References BmnFieldConst(), fBx, fBy, fBz, fIsOff, fXmax, fXmin, fYmax, fYmin, fZmax, and fZmin.

Here is the call graph for this function:

SetField() [1/2]

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

Parameters

bX,bY,bZ

Field values [kG]

Definition at line 115 of file BmnFieldConst.cxx.

References fBx, fBy, fBz, and fIsOff.

Referenced by run_sim_bmn(), run_sim_bmn_ecal(), and run_sim_bmn_zdc().

Here is the caller graph for this function:

SetField() [2/2]

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

Parameters

bX,bY,bZ

Field values [kG]

SetFieldOff() [1/2]

void BmnFieldConst::SetFieldOff ( Bool_t is_off = kTRUE )

inline

Definition at line 61 of file BmnFieldConst.h.

References fIsOff.

SetFieldOff() [2/2]

void BmnFieldConst::SetFieldOff ( Bool_t is_off = kTRUE )

inline

Definition at line 61 of file BmnFieldConst.h.

References fIsOff.

SetFieldRegion() [1/2]

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

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 100 of file BmnFieldConst.cxx.

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

Referenced by run_sim_bmn(), run_sim_bmn_ecal(), and run_sim_bmn_zdc().

Here is the caller graph for this function:

SetFieldRegion() [2/2]

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

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)

References zMax, and zMin.

Member Data Documentation

fBx

Double_t BmnFieldConst::fBx

private

Definition at line 101 of file BmnFieldConst.h.

Referenced by BmnFieldConst(), BmnFieldConst(), BmnFieldConst(), GetBx(), GetBx(), Print(), and SetField().

fBy

Double_t BmnFieldConst::fBy

private

Definition at line 102 of file BmnFieldConst.h.

Referenced by BmnFieldConst(), BmnFieldConst(), BmnFieldConst(), GetBy(), GetBy(), Print(), and SetField().

fBz

Double_t BmnFieldConst::fBz

private

Definition at line 103 of file BmnFieldConst.h.

Referenced by BmnFieldConst(), BmnFieldConst(), BmnFieldConst(), GetBz(), GetBz(), Print(), and SetField().

fIsOff

Bool_t BmnFieldConst::fIsOff

private

Definition at line 106 of file BmnFieldConst.h.

Referenced by BmnFieldConst(), BmnFieldConst(), BmnFieldConst(), IsFieldOff(), Print(), SetField(), and SetFieldOff().

fXmax

Double_t BmnFieldConst::fXmax

private

Definition at line 94 of file BmnFieldConst.h.

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

fXmin

Double_t BmnFieldConst::fXmin

private

Definition at line 93 of file BmnFieldConst.h.

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

fYmax

Double_t BmnFieldConst::fYmax

private

Definition at line 96 of file BmnFieldConst.h.

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

fYmin

Double_t BmnFieldConst::fYmin

private

Definition at line 95 of file BmnFieldConst.h.

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

fZmax

Double_t BmnFieldConst::fZmax

private

Definition at line 98 of file BmnFieldConst.h.

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

fZmin

Double_t BmnFieldConst::fZmin

private

Definition at line 97 of file BmnFieldConst.h.

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

---

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

• field/BmnFieldConst.h
• install/include/BmnFieldConst.h
• field/BmnFieldConst.cxx