BmnRoot 26.10.0-18-g4e3414f9
Software framework of the BM@N experiment
Loading...
Searching...
No Matches
BmnFieldPar Class Reference

#include <BmnFieldPar.h>

Inheritance diagram for BmnFieldPar:
Collaboration diagram for BmnFieldPar:

Public Member Functions

 BmnFieldPar (const char *name, const char *title, const char *context)
 Standard constructor.
 BmnFieldPar ()
 default constructor
 ~BmnFieldPar ()
 Destructor.
virtual void putParams (FairParamList *list)
 Put parameters.
virtual Bool_t getParams (FairParamList *list)
 Get parameters.
void SetParameters (FairField *field)
 Set parameters from BmnField.
Int_t GetType () const
 Accessors.
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
void MapName (TString &name)
Double_t GetPositionX () const
Double_t GetPositionY () const
Double_t GetPositionZ () const
Double_t GetScale () const
Bool_t IsFieldOff () const
void GetDistortionFilename (TString &filename)
void GetParentName (TString &parentname)
Int_t GetTypeOfParent () const
 BmnFieldPar (const char *name, const char *title, const char *context)
 Standard constructor.
 BmnFieldPar ()
 default constructor
 ~BmnFieldPar ()
 Destructor.
virtual void putParams (FairParamList *list)
 Put parameters.
virtual Bool_t getParams (FairParamList *list)
 Get parameters.
void SetParameters (FairField *field)
 Set parameters from BmnField.
Int_t GetType () const
 Accessors.
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
void MapName (TString &name)
Double_t GetPositionX () const
Double_t GetPositionY () const
Double_t GetPositionZ () const
Double_t GetScale () const
Bool_t IsFieldOff () const
void GetDistortionFilename (TString &filename)
void GetParentName (TString &parentname)
Int_t GetTypeOfParent () const

Private Member Functions

 BmnFieldPar (const BmnFieldPar &)=delete
BmnFieldPar & operator= (const BmnFieldPar &)=delete
 BmnFieldPar (const BmnFieldPar &)=delete
BmnFieldPar & operator= (const BmnFieldPar &)=delete

Private Attributes

Int_t fType
 Field type 0 = constant field 1 = field map 2 = field map sym2 (symmetries in x and y) 3 = field map sym3 (symmetries in x, y and z) kTypeDistorted = distorted field map (its parent field can be field map or constant field).
Double_t fXmin
 Field limits in case of constant field.
Double_t fXmax
Double_t fYmin
Double_t fYmax
Double_t fZmin
Double_t fZmax
Double_t fBx
 Field values in case of constant field [kG].
Double_t fBy
Double_t fBz
TString fMapName
 Field map name in case of field map.
Double_t fPosX
 Field centre position for field map.
Double_t fPosY
Double_t fPosZ
Double_t fScale
 Scaling factor for field map.
Bool_t fIsOff
 Whether magnetic field is off.
TString fDistortionFilename
 Field map distortion filename (in case of distorted field map).
TString fParentName
 Field name of parent field (in case of distorted field map).
Int_t fTypeOfParent
 Field type of parent field (in case of distorted field map).

Detailed Description

Definition at line 25 of file BmnFieldPar.h.

Constructor & Destructor Documentation

◆ BmnFieldPar() [1/6]

BmnFieldPar::BmnFieldPar ( const char * name,
const char * title,
const char * context )

Definition at line 20 of file BmnFieldPar.cxx.

References fBx, fBy, fBz, fDistortionFilename, fIsOff, fMapName, fParentName, fPosX, fPosY, fPosZ, fScale, fType, fTypeOfParent, fXmax, fXmin, fYmax, fYmin, fZmax, and fZmin.

Referenced by BmnFieldPar(), and operator=().

Here is the caller graph for this function:

◆ BmnFieldPar() [2/6]

BmnFieldPar::BmnFieldPar ( )

Definition at line 44 of file BmnFieldPar.cxx.

References fBx, fBy, fBz, fDistortionFilename, fIsOff, fMapName, fParentName, fPosX, fPosY, fPosZ, fScale, fType, fTypeOfParent, fXmax, fXmin, fYmax, fYmin, fZmax, and fZmin.

◆ ~BmnFieldPar() [1/2]

BmnFieldPar::~BmnFieldPar ( )

Definition at line 70 of file BmnFieldPar.cxx.

◆ BmnFieldPar() [3/6]

BmnFieldPar::BmnFieldPar ( const BmnFieldPar & )
privatedelete

References BmnFieldPar().

Here is the call graph for this function:

◆ BmnFieldPar() [4/6]

BmnFieldPar::BmnFieldPar ( const char * name,
const char * title,
const char * context )

◆ BmnFieldPar() [5/6]

BmnFieldPar::BmnFieldPar ( )

◆ ~BmnFieldPar() [2/2]

BmnFieldPar::~BmnFieldPar ( )

◆ BmnFieldPar() [6/6]

BmnFieldPar::BmnFieldPar ( const BmnFieldPar & )
privatedelete

References BmnFieldPar().

Here is the call graph for this function:

Member Function Documentation

◆ GetBx() [1/2]

Double_t BmnFieldPar::GetBx ( ) const
inline

Definition at line 55 of file BmnFieldPar.h.

References fBx.

Referenced by BmnFieldConst::BmnFieldConst().

Here is the caller graph for this function:

◆ GetBx() [2/2]

Double_t BmnFieldPar::GetBx ( ) const
inline

Definition at line 55 of file BmnFieldPar.h.

References fBx.

◆ GetBy() [1/2]

Double_t BmnFieldPar::GetBy ( ) const
inline

Definition at line 56 of file BmnFieldPar.h.

References fBy.

Referenced by BmnFieldConst::BmnFieldConst().

Here is the caller graph for this function:

◆ GetBy() [2/2]

Double_t BmnFieldPar::GetBy ( ) const
inline

Definition at line 56 of file BmnFieldPar.h.

References fBy.

◆ GetBz() [1/2]

Double_t BmnFieldPar::GetBz ( ) const
inline

Definition at line 57 of file BmnFieldPar.h.

References fBz.

Referenced by BmnFieldConst::BmnFieldConst().

Here is the caller graph for this function:

◆ GetBz() [2/2]

Double_t BmnFieldPar::GetBz ( ) const
inline

Definition at line 57 of file BmnFieldPar.h.

References fBz.

◆ GetDistortionFilename() [1/2]

void BmnFieldPar::GetDistortionFilename ( TString & filename)
inline

Definition at line 65 of file BmnFieldPar.h.

References fDistortionFilename.

◆ GetDistortionFilename() [2/2]

void BmnFieldPar::GetDistortionFilename ( TString & filename)
inline

Definition at line 65 of file BmnFieldPar.h.

References fDistortionFilename.

◆ getParams() [1/2]

Bool_t BmnFieldPar::getParams ( FairParamList * list)
virtual

Definition at line 113 of file BmnFieldPar.cxx.

References fBx, fBy, fBz, fDistortionFilename, fIsOff, fMapName, fParentName, fPosX, fPosY, fPosZ, fScale, fType, fTypeOfParent, fXmax, fXmin, fYmax, fYmin, fZmax, fZmin, kMaxFieldMapType, kMaxLen, and kTypeDistorted.

◆ getParams() [2/2]

virtual Bool_t BmnFieldPar::getParams ( FairParamList * list)
virtual

◆ GetParentName() [1/2]

void BmnFieldPar::GetParentName ( TString & parentname)
inline

Definition at line 66 of file BmnFieldPar.h.

References fParentName.

◆ GetParentName() [2/2]

void BmnFieldPar::GetParentName ( TString & parentname)
inline

Definition at line 66 of file BmnFieldPar.h.

References fParentName.

◆ GetPositionX() [1/2]

Double_t BmnFieldPar::GetPositionX ( ) const
inline

Definition at line 59 of file BmnFieldPar.h.

References fPosX.

Referenced by BmnFieldMap::BmnFieldMap().

Here is the caller graph for this function:

◆ GetPositionX() [2/2]

Double_t BmnFieldPar::GetPositionX ( ) const
inline

Definition at line 59 of file BmnFieldPar.h.

References fPosX.

◆ GetPositionY() [1/2]

Double_t BmnFieldPar::GetPositionY ( ) const
inline

Definition at line 60 of file BmnFieldPar.h.

References fPosY.

Referenced by BmnFieldMap::BmnFieldMap().

Here is the caller graph for this function:

◆ GetPositionY() [2/2]

Double_t BmnFieldPar::GetPositionY ( ) const
inline

Definition at line 60 of file BmnFieldPar.h.

References fPosY.

◆ GetPositionZ() [1/2]

Double_t BmnFieldPar::GetPositionZ ( ) const
inline

Definition at line 61 of file BmnFieldPar.h.

References fPosZ.

Referenced by BmnFieldMap::BmnFieldMap().

Here is the caller graph for this function:

◆ GetPositionZ() [2/2]

Double_t BmnFieldPar::GetPositionZ ( ) const
inline

Definition at line 61 of file BmnFieldPar.h.

References fPosZ.

◆ GetScale() [1/2]

Double_t BmnFieldPar::GetScale ( ) const
inline

Definition at line 62 of file BmnFieldPar.h.

References fScale.

Referenced by BmnFieldMap::BmnFieldMap().

Here is the caller graph for this function:

◆ GetScale() [2/2]

Double_t BmnFieldPar::GetScale ( ) const
inline

Definition at line 62 of file BmnFieldPar.h.

References fScale.

◆ GetType() [1/2]

Int_t BmnFieldPar::GetType ( ) const
inline

Definition at line 48 of file BmnFieldPar.h.

References fType.

Referenced by BmnFieldConst::BmnFieldConst(), and BmnFieldMap::BmnFieldMap().

Here is the caller graph for this function:

◆ GetType() [2/2]

Int_t BmnFieldPar::GetType ( ) const
inline

Definition at line 48 of file BmnFieldPar.h.

References fType.

◆ GetTypeOfParent() [1/2]

Int_t BmnFieldPar::GetTypeOfParent ( ) const
inline

Definition at line 67 of file BmnFieldPar.h.

References fTypeOfParent.

◆ GetTypeOfParent() [2/2]

Int_t BmnFieldPar::GetTypeOfParent ( ) const
inline

Definition at line 67 of file BmnFieldPar.h.

References fTypeOfParent.

◆ GetXmax() [1/2]

Double_t BmnFieldPar::GetXmax ( ) const
inline

Definition at line 50 of file BmnFieldPar.h.

References fXmax.

Referenced by BmnFieldConst::BmnFieldConst().

Here is the caller graph for this function:

◆ GetXmax() [2/2]

Double_t BmnFieldPar::GetXmax ( ) const
inline

Definition at line 50 of file BmnFieldPar.h.

References fXmax.

◆ GetXmin() [1/2]

Double_t BmnFieldPar::GetXmin ( ) const
inline

Definition at line 49 of file BmnFieldPar.h.

References fXmin.

Referenced by BmnFieldConst::BmnFieldConst().

Here is the caller graph for this function:

◆ GetXmin() [2/2]

Double_t BmnFieldPar::GetXmin ( ) const
inline

Definition at line 49 of file BmnFieldPar.h.

References fXmin.

◆ GetYmax() [1/2]

Double_t BmnFieldPar::GetYmax ( ) const
inline

Definition at line 52 of file BmnFieldPar.h.

References fYmax.

Referenced by BmnFieldConst::BmnFieldConst().

Here is the caller graph for this function:

◆ GetYmax() [2/2]

Double_t BmnFieldPar::GetYmax ( ) const
inline

Definition at line 52 of file BmnFieldPar.h.

References fYmax.

◆ GetYmin() [1/2]

Double_t BmnFieldPar::GetYmin ( ) const
inline

Definition at line 51 of file BmnFieldPar.h.

References fYmin.

Referenced by BmnFieldConst::BmnFieldConst().

Here is the caller graph for this function:

◆ GetYmin() [2/2]

Double_t BmnFieldPar::GetYmin ( ) const
inline

Definition at line 51 of file BmnFieldPar.h.

References fYmin.

◆ GetZmax() [1/2]

Double_t BmnFieldPar::GetZmax ( ) const
inline

Definition at line 54 of file BmnFieldPar.h.

References fZmax.

Referenced by BmnFieldConst::BmnFieldConst().

Here is the caller graph for this function:

◆ GetZmax() [2/2]

Double_t BmnFieldPar::GetZmax ( ) const
inline

Definition at line 54 of file BmnFieldPar.h.

References fZmax.

◆ GetZmin() [1/2]

Double_t BmnFieldPar::GetZmin ( ) const
inline

Definition at line 53 of file BmnFieldPar.h.

References fZmin.

Referenced by BmnFieldConst::BmnFieldConst().

Here is the caller graph for this function:

◆ GetZmin() [2/2]

Double_t BmnFieldPar::GetZmin ( ) const
inline

Definition at line 53 of file BmnFieldPar.h.

References fZmin.

◆ IsFieldOff() [1/2]

Bool_t BmnFieldPar::IsFieldOff ( ) const
inline

Definition at line 63 of file BmnFieldPar.h.

References fIsOff.

Referenced by BmnFieldConst::BmnFieldConst(), and BmnFieldMap::BmnFieldMap().

Here is the caller graph for this function:

◆ IsFieldOff() [2/2]

Bool_t BmnFieldPar::IsFieldOff ( ) const
inline

Definition at line 63 of file BmnFieldPar.h.

References fIsOff.

◆ MapName() [1/2]

void BmnFieldPar::MapName ( TString & name)
inline

Definition at line 58 of file BmnFieldPar.h.

References fMapName.

Referenced by BmnFieldMap::BmnFieldMap().

Here is the caller graph for this function:

◆ MapName() [2/2]

void BmnFieldPar::MapName ( TString & name)
inline

Definition at line 58 of file BmnFieldPar.h.

References fMapName.

◆ operator=() [1/2]

BmnFieldPar & BmnFieldPar::operator= ( const BmnFieldPar & )
privatedelete

References BmnFieldPar().

Here is the call graph for this function:

◆ operator=() [2/2]

BmnFieldPar & BmnFieldPar::operator= ( const BmnFieldPar & )
privatedelete

References BmnFieldPar().

Here is the call graph for this function:

◆ putParams() [1/2]

void BmnFieldPar::putParams ( FairParamList * list)
virtual

Definition at line 75 of file BmnFieldPar.cxx.

References fBx, fBy, fBz, fDistortionFilename, fIsOff, fMapName, fParentName, fPosX, fPosY, fPosZ, fScale, fType, fTypeOfParent, fXmax, fXmin, fYmax, fYmin, fZmax, fZmin, kMaxFieldMapType, and kTypeDistorted.

◆ putParams() [2/2]

virtual void BmnFieldPar::putParams ( FairParamList * list)
virtual

◆ SetParameters() [1/2]

void BmnFieldPar::SetParameters ( FairField * field)

Definition at line 180 of file BmnFieldPar.cxx.

References fBx, fBy, fBz, fIsOff, fMapName, fPosX, fPosY, fPosZ, fScale, fType, fXmax, fXmin, fYmax, fYmin, fZmax, fZmin, BmnFieldConst::GetBx(), BmnFieldConst::GetBy(), BmnFieldConst::GetBz(), BmnFieldMap::GetPositionX(), BmnFieldMap::GetPositionY(), BmnFieldMap::GetPositionZ(), BmnFieldMap::GetScale(), BmnFieldConst::GetXmax(), BmnFieldConst::GetXmin(), BmnFieldConst::GetYmax(), BmnFieldConst::GetYmin(), BmnFieldConst::GetZmax(), BmnFieldConst::GetZmin(), BmnFieldConst::IsFieldOff(), BmnFieldMap::IsFieldOff(), and kMaxFieldMapType.

Referenced by BmnFieldConst::FillParContainer(), BmnFieldMapSym3::FillParContainer(), BmnNewFieldMap::FillParContainer(), run8_sim_bmn(), run_sim(), run_sim_bmn(), run_sim_bmn_ecal(), run_sim_bmn_zdc(), run_sim_filter(), run_sim_prefilter(), run_sim_src(), and BmnMultiFieldPar::SetParameters().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetParameters() [2/2]

void BmnFieldPar::SetParameters ( FairField * field)

Member Data Documentation

◆ fBx

Double_t BmnFieldPar::fBx
private

Definition at line 85 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), GetBx(), getParams(), putParams(), and SetParameters().

◆ fBy

Double_t BmnFieldPar::fBy
private

Definition at line 85 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), GetBy(), getParams(), putParams(), and SetParameters().

◆ fBz

Double_t BmnFieldPar::fBz
private

Definition at line 85 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), GetBz(), getParams(), putParams(), and SetParameters().

◆ fDistortionFilename

TString BmnFieldPar::fDistortionFilename
private

Definition at line 100 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), GetDistortionFilename(), getParams(), and putParams().

◆ fIsOff

Bool_t BmnFieldPar::fIsOff
private

Definition at line 97 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), IsFieldOff(), putParams(), and SetParameters().

◆ fMapName

TString BmnFieldPar::fMapName
private

Definition at line 88 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), MapName(), putParams(), and SetParameters().

◆ fParentName

TString BmnFieldPar::fParentName
private

Definition at line 103 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetParentName(), and putParams().

◆ fPosX

Double_t BmnFieldPar::fPosX
private

Definition at line 91 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetPositionX(), putParams(), and SetParameters().

◆ fPosY

Double_t BmnFieldPar::fPosY
private

Definition at line 91 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetPositionY(), putParams(), and SetParameters().

◆ fPosZ

Double_t BmnFieldPar::fPosZ
private

Definition at line 91 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetPositionZ(), putParams(), and SetParameters().

◆ fScale

Double_t BmnFieldPar::fScale
private

Definition at line 94 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetScale(), putParams(), and SetParameters().

◆ fType

Int_t BmnFieldPar::fType
private

Definition at line 77 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetType(), putParams(), and SetParameters().

◆ fTypeOfParent

Int_t BmnFieldPar::fTypeOfParent
private

Definition at line 106 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetTypeOfParent(), and putParams().

◆ fXmax

Double_t BmnFieldPar::fXmax
private

Definition at line 80 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetXmax(), putParams(), and SetParameters().

◆ fXmin

Double_t BmnFieldPar::fXmin
private

Definition at line 80 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetXmin(), putParams(), and SetParameters().

◆ fYmax

Double_t BmnFieldPar::fYmax
private

Definition at line 81 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetYmax(), putParams(), and SetParameters().

◆ fYmin

Double_t BmnFieldPar::fYmin
private

Definition at line 81 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetYmin(), putParams(), and SetParameters().

◆ fZmax

Double_t BmnFieldPar::fZmax
private

Definition at line 82 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetZmax(), putParams(), and SetParameters().

◆ fZmin

Double_t BmnFieldPar::fZmin
private

Definition at line 82 of file BmnFieldPar.h.

Referenced by BmnFieldPar(), BmnFieldPar(), getParams(), GetZmin(), putParams(), and SetParameters().

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