ShipConstField Class Reference

#include <ShipConstField.h>

Inheritance diagram for ShipConstField:

Collaboration diagram for ShipConstField:

Public Member Functions
	ShipConstField ()
	ShipConstField (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)
	ShipConstField (ShipFieldPar *fieldPar)
virtual	~ShipConstField ()
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)
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
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 ()

Private Member Functions
	ClassDef (ShipConstField, 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 26 of file ShipConstField.h.

Constructor & Destructor Documentation

ShipConstField() [1/3]

ShipConstField::ShipConstField

(

)

Default constructor

Definition at line 20 of file ShipConstField.cxx.

  : FairField(),
    fXmin(0.),   
    fXmax(0.),
    fYmin(0.),
    fYmax(0.),
    fZmin(0.),
    fZmax(0.),
    fBx(0.),
    fBy(0.),
    fBz(0.)
{
  fType = 0;
}

ShipConstField() [2/3]

ShipConstField::ShipConstField	(	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 39 of file ShipConstField.cxx.

  : FairField(name),
    fXmin(xMin),   
    fXmax(xMax),
    fYmin(yMin),
    fYmax(yMax),
    fZmin(zMin),
    fZmax(zMax),
    fBx(bX),
    fBy(bY),
    fBz(bZ)
{
  fType=0;
}

ShipConstField() [3/3]

ShipConstField::ShipConstField

(

ShipFieldPar *

fieldPar

)

Constructor from ShipFieldPar

Definition at line 62 of file ShipConstField.cxx.

  : FairField(),
    fXmin(0.),   
    fXmax(0.),
    fYmin(0.),
    fYmax(0.),
    fZmin(0.),
    fZmax(0.),
    fBx(0.),
    fBy(0.),
    fBz(0.)
{
  if ( ! fieldPar ) {
    cerr << "-W- ShipConstField::ShipConstField: empty parameter container!"
     << endl;
    fType=0;
  }
  else {
    fXmin = fieldPar->GetXmin();
    fXmax = fieldPar->GetXmax();
    fYmin = fieldPar->GetYmin();
    fYmax = fieldPar->GetYmax();
    fZmin = fieldPar->GetZmin();
    fZmax = fieldPar->GetZmax();
    fBx   = fieldPar->GetBx();
    fBy   = fieldPar->GetBy();
    fBz   = fieldPar->GetBz();
    fType = fieldPar->GetType();
  }
}

~ShipConstField()

ShipConstField::~ShipConstField ( )

virtual

Destructor

Definition at line 97 of file ShipConstField.cxx.

{ }

Member Function Documentation

ClassDef()

ShipConstField::ClassDef ( ShipConstField  , 1    )

private

GetBx() [1/2]

Double_t ShipConstField::GetBx ( ) const

inline

Accessors to field values

Definition at line 88 of file ShipConstField.h.

{ return fBx; }

GetBx() [2/2]

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

virtual

Get components of field at a given point

Parameters

x,y,z

Point coordinates [cm]

Definition at line 128 of file ShipConstField.cxx.

                                                                 {
  if ( x < fXmin  ||  x > fXmax  ||
       y < fYmin  ||  y > fYmax  ||
       z < fZmin  ||  z > fZmax ) return 0.;
  return fBx;
}

GetBy() [1/2]

Double_t ShipConstField::GetBy ( ) const

inline

Definition at line 89 of file ShipConstField.h.

{ return fBy; }

GetBy() [2/2]

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

virtual

Definition at line 139 of file ShipConstField.cxx.

                                                                 {
  if ( x < fXmin  ||  x > fXmax  ||
       y < fYmin  ||  y > fYmax  ||
       z < fZmin  ||  z > fZmax ) return 0.;
  return fBy;
}

GetBz() [1/2]

Double_t ShipConstField::GetBz ( ) const

inline

Definition at line 90 of file ShipConstField.h.

{ return fBz; }

GetBz() [2/2]

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

virtual

Definition at line 150 of file ShipConstField.cxx.

                                                                 {
  if ( x < fXmin  ||  x > fXmax  ||
       y < fYmin  ||  y > fYmax  ||
       z < fZmin  ||  z > fZmax ) return 0.;
  return fBz;
}

GetXmax()

Double_t ShipConstField::GetXmax ( ) const

inline

Definition at line 80 of file ShipConstField.h.

{ return fXmax; }

GetXmin()

Double_t ShipConstField::GetXmin ( ) const

inline

Accessors to field region

Definition at line 79 of file ShipConstField.h.

{ return fXmin; }

GetYmax()

Double_t ShipConstField::GetYmax ( ) const

inline

Definition at line 82 of file ShipConstField.h.

{ return fYmax; }

GetYmin()

Double_t ShipConstField::GetYmin ( ) const

inline

Definition at line 81 of file ShipConstField.h.

{ return fYmin; }

GetZmax()

Double_t ShipConstField::GetZmax ( ) const

inline

Definition at line 84 of file ShipConstField.h.

{ return fZmax; }

GetZmin()

Double_t ShipConstField::GetZmin ( ) const

inline

Definition at line 83 of file ShipConstField.h.

{ return fZmin; }

Print()

void ShipConstField::Print ( )

virtual

Screen output

Definition at line 161 of file ShipConstField.cxx.

                           {
  cout << "======================================================" << endl;
  cout << "----  " << fTitle << " : " << fName << endl;
  cout << "----" << endl;
  cout << "----  Field type    : constant" << endl;
  cout << "----" << endl;
  cout << "----  Field regions : " << endl;
  cout << "----        x = " << setw(4) << fXmin << " to " << setw(4) 
       << fXmax << " cm" << endl;
  cout << "----        y = " << setw(4) << fYmin << " to " << setw(4) 
       << fYmax << " cm" << endl;
  cout << "----        z = " << setw(4) << fZmin << " to " << setw(4)
       << fZmax << " cm" << endl;
  cout.precision(4);
  cout << "----  B = ( " << fBx << ", " << fBy << ", " << fBz << " ) kG"
       << endl;
  cout << "======================================================" << endl;
}

SetField()

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

Set the field values

Parameters

bX,bY,bZ

Field values [kG]

Definition at line 118 of file ShipConstField.cxx.

                                                                   {
  fBx   = bX;
  fBy   = bY;
  fBz   = bZ;
}

SetFieldRegion()

void ShipConstField::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 ShipConstField.cxx.

                                                 {
  fXmin = xMin;
  fXmax = xMax;
  fYmin = yMin;
  fYmax = yMax;
  fZmin = zMin;
  fZmax = zMax;
}

Member Data Documentation

fBx

Double_t ShipConstField::fBx

private

Field components inside the field region

Definition at line 108 of file ShipConstField.h.

fBy

Double_t ShipConstField::fBy

private

Definition at line 109 of file ShipConstField.h.

fBz

Double_t ShipConstField::fBz

private

Definition at line 110 of file ShipConstField.h.

fXmax

Double_t ShipConstField::fXmax

private

Definition at line 101 of file ShipConstField.h.

fXmin

Double_t ShipConstField::fXmin

private

Limits of the field region

Definition at line 100 of file ShipConstField.h.

fYmax

Double_t ShipConstField::fYmax

private

Definition at line 103 of file ShipConstField.h.

fYmin

Double_t ShipConstField::fYmin

private

Definition at line 102 of file ShipConstField.h.

fZmax

Double_t ShipConstField::fZmax

private

Definition at line 105 of file ShipConstField.h.

fZmin

Double_t ShipConstField::fZmin

private

Definition at line 104 of file ShipConstField.h.

---

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

• field/ShipConstField.h
• field/ShipConstField.cxx