CbmRoot
CbmFieldMapCreator Class Reference

#include <CbmFieldMapCreator.h>

Public Member Functions

 CbmFieldMapCreator ()
 
 CbmFieldMapCreator (const char *mapName)
 
virtual ~CbmFieldMapCreator ()
 
void SetGridParameters (Int_t nx, Double_t xmin, Double_t xmax, Int_t ny, Double_t ymin, Double_t ymax, Int_t nz, Double_t zmin, Double_t zmax)
 
void AddField (FairField *field)
 
Bool_t CreateMap (const char *fileName="")
 
TString GetMapName () const
 
Int_t GetNx () const
 
Int_t GetNy () const
 
Int_t GetNz () const
 
Double_t GetXmin () const
 
Double_t GetXmax () const
 
Double_t GetYmin () const
 
Double_t GetYmax () const
 
Double_t GetZmin () const
 
Double_t GetZmax () const
 
TArrayF * GetBx () const
 
TArrayF * GetBy () const
 
TArrayF * GetBz () const
 

Private Member Functions

 CbmFieldMapCreator (const CbmFieldMapCreator &)
 
CbmFieldMapCreatoroperator= (const CbmFieldMapCreator &)
 
 ClassDef (CbmFieldMapCreator, 1)
 

Private Attributes

TString fMapName
 
Int_t fNx
 
Int_t fNy
 
Int_t fNz
 
Double_t fXmin
 
Double_t fXmax
 
Double_t fYmin
 
Double_t fYmax
 
Double_t fZmin
 
Double_t fZmax
 
TArrayF * fBx
 
TArrayF * fBy
 
TArrayF * fBz
 
TList fFieldList
 
Bool_t fInit
 

Detailed Description

Definition at line 30 of file CbmFieldMapCreator.h.

Constructor & Destructor Documentation

◆ CbmFieldMapCreator() [1/3]

CbmFieldMapCreator::CbmFieldMapCreator ( )

Default constructor

Definition at line 21 of file CbmFieldMapCreator.cxx.

◆ CbmFieldMapCreator() [2/3]

CbmFieldMapCreator::CbmFieldMapCreator ( const char *  mapName)

Standard constructor

Parameters
mapNameName of field map. Defines also the output file name.

Definition at line 41 of file CbmFieldMapCreator.cxx.

◆ ~CbmFieldMapCreator()

CbmFieldMapCreator::~CbmFieldMapCreator ( )
virtual

Destructor

Definition at line 63 of file CbmFieldMapCreator.cxx.

References fBx, fBy, fBz, and fFieldList.

◆ CbmFieldMapCreator() [3/3]

CbmFieldMapCreator::CbmFieldMapCreator ( const CbmFieldMapCreator )
private

Member Function Documentation

◆ AddField()

void CbmFieldMapCreator::AddField ( FairField *  field)
inline

Add an input field

Definition at line 65 of file CbmFieldMapCreator.h.

References fFieldList.

◆ ClassDef()

CbmFieldMapCreator::ClassDef ( CbmFieldMapCreator  ,
 
)
private

◆ CreateMap()

Bool_t CbmFieldMapCreator::CreateMap ( const char *  fileName = "")

Create the field map By default, the output file name is defined by the map name plus the extension .root. Other file names can be choosen.

Parameters
fileNameName of output file @value Success of map creation

Definition at line 97 of file CbmFieldMapCreator.cxx.

References fBx, fBy, fBz, fFieldList, fInit, fMapName, fNx, fNy, fNz, fXmax, fXmin, fYmax, fYmin, fZmax, fZmin, CbmFieldMap::WriteRootFile(), x, and y.

◆ GetBx()

TArrayF* CbmFieldMapCreator::GetBx ( ) const
inline

Definition at line 88 of file CbmFieldMapCreator.h.

References fBx.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetBy()

TArrayF* CbmFieldMapCreator::GetBy ( ) const
inline

Definition at line 89 of file CbmFieldMapCreator.h.

References fBy.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetBz()

TArrayF* CbmFieldMapCreator::GetBz ( ) const
inline

Definition at line 90 of file CbmFieldMapCreator.h.

References fBz.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetMapName()

TString CbmFieldMapCreator::GetMapName ( ) const
inline

Accessors

Definition at line 78 of file CbmFieldMapCreator.h.

References fMapName.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetNx()

Int_t CbmFieldMapCreator::GetNx ( ) const
inline

Definition at line 79 of file CbmFieldMapCreator.h.

References fNx.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetNy()

Int_t CbmFieldMapCreator::GetNy ( ) const
inline

Definition at line 80 of file CbmFieldMapCreator.h.

References fNy.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetNz()

Int_t CbmFieldMapCreator::GetNz ( ) const
inline

Definition at line 81 of file CbmFieldMapCreator.h.

References fNz.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetXmax()

Double_t CbmFieldMapCreator::GetXmax ( ) const
inline

Definition at line 83 of file CbmFieldMapCreator.h.

References fXmax.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetXmin()

Double_t CbmFieldMapCreator::GetXmin ( ) const
inline

Definition at line 82 of file CbmFieldMapCreator.h.

References fXmin.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetYmax()

Double_t CbmFieldMapCreator::GetYmax ( ) const
inline

Definition at line 85 of file CbmFieldMapCreator.h.

References fYmax.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetYmin()

Double_t CbmFieldMapCreator::GetYmin ( ) const
inline

Definition at line 84 of file CbmFieldMapCreator.h.

References fYmin.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetZmax()

Double_t CbmFieldMapCreator::GetZmax ( ) const
inline

Definition at line 87 of file CbmFieldMapCreator.h.

References fZmax.

Referenced by CbmFieldMap::CbmFieldMap().

◆ GetZmin()

Double_t CbmFieldMapCreator::GetZmin ( ) const
inline

Definition at line 86 of file CbmFieldMapCreator.h.

References fZmin.

Referenced by CbmFieldMap::CbmFieldMap().

◆ operator=()

CbmFieldMapCreator& CbmFieldMapCreator::operator= ( const CbmFieldMapCreator )
private

◆ SetGridParameters()

void CbmFieldMapCreator::SetGridParameters ( Int_t  nx,
Double_t  xmin,
Double_t  xmax,
Int_t  ny,
Double_t  ymin,
Double_t  ymax,
Int_t  nz,
Double_t  zmin,
Double_t  zmax 
)

Set parameters

Parameters
nx,ny,nzNumber of grid cells in x,y,z
xmin,xmaxExtension in x coordinate
ymin,ymaxExtension in y coordinate
zmin,zmaxExtension in z coordinate

Definition at line 73 of file CbmFieldMapCreator.cxx.

References fInit, fNx, fNy, fNz, fXmax, fXmin, fYmax, fYmin, fZmax, and fZmin.

Member Data Documentation

◆ fBx

TArrayF* CbmFieldMapCreator::fBx
private

Definition at line 99 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetBx(), and ~CbmFieldMapCreator().

◆ fBy

TArrayF* CbmFieldMapCreator::fBy
private

Definition at line 100 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetBy(), and ~CbmFieldMapCreator().

◆ fBz

TArrayF* CbmFieldMapCreator::fBz
private

Definition at line 101 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetBz(), and ~CbmFieldMapCreator().

◆ fFieldList

TList CbmFieldMapCreator::fFieldList
private

Definition at line 102 of file CbmFieldMapCreator.h.

Referenced by AddField(), CreateMap(), and ~CbmFieldMapCreator().

◆ fInit

Bool_t CbmFieldMapCreator::fInit
private

Definition at line 103 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), and SetGridParameters().

◆ fMapName

TString CbmFieldMapCreator::fMapName
private

Definition at line 94 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), and GetMapName().

◆ fNx

Int_t CbmFieldMapCreator::fNx
private

Definition at line 95 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetNx(), and SetGridParameters().

◆ fNy

Int_t CbmFieldMapCreator::fNy
private

Definition at line 95 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetNy(), and SetGridParameters().

◆ fNz

Int_t CbmFieldMapCreator::fNz
private

Definition at line 95 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetNz(), and SetGridParameters().

◆ fXmax

Double_t CbmFieldMapCreator::fXmax
private

Definition at line 96 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetXmax(), and SetGridParameters().

◆ fXmin

Double_t CbmFieldMapCreator::fXmin
private

Definition at line 96 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetXmin(), and SetGridParameters().

◆ fYmax

Double_t CbmFieldMapCreator::fYmax
private

Definition at line 97 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetYmax(), and SetGridParameters().

◆ fYmin

Double_t CbmFieldMapCreator::fYmin
private

Definition at line 97 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetYmin(), and SetGridParameters().

◆ fZmax

Double_t CbmFieldMapCreator::fZmax
private

Definition at line 98 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetZmax(), and SetGridParameters().

◆ fZmin

Double_t CbmFieldMapCreator::fZmin
private

Definition at line 98 of file CbmFieldMapCreator.h.

Referenced by CreateMap(), GetZmin(), and SetGridParameters().


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