Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PHFieldUniform Class Reference

#include <coresoftware/blob/master/offline/packages/PHField/PHFieldUniform.h>

+ Inheritance diagram for PHFieldUniform:
+ Collaboration diagram for PHFieldUniform:

Public Member Functions

 PHFieldUniform (double field_mag_x, double field_mag_y, double field_mag_z)
 construct field map in constant in units of Tesla
 
 ~PHFieldUniform () override
 
void GetFieldValue (const double Point[4], double *Bfield) const override
 
double get_field_mag_x () const
 
void set_field_mag_x (double fieldMagX)
 
double get_field_mag_y () const
 
void set_field_mag_y (double fieldMagY)
 
double get_field_mag_z () const
 
void set_field_mag_z (double fieldMagZ)
 
- Public Member Functions inherited from PHField
 PHField (const int verb=0)
 constructor
 
virtual ~PHField ()
 
void Verbosity (const int i)
 
int Verbosity () const
 

Protected Attributes

double field_mag_x_
 
double field_mag_y_
 
double field_mag_z_
 
- Protected Attributes inherited from PHField
int m_Verbosity
 

Detailed Description

Definition at line 6 of file PHFieldUniform.h.

View newest version in sPHENIX GitHub at line 6 of file PHFieldUniform.h

Constructor & Destructor Documentation

PHFieldUniform::PHFieldUniform ( double  field_mag_x,
double  field_mag_y,
double  field_mag_z 
)

construct field map in constant in units of Tesla

Definition at line 5 of file PHFieldUniform.cc.

View newest version in sPHENIX GitHub at line 5 of file PHFieldUniform.cc

PHFieldUniform::~PHFieldUniform ( )
inlineoverride

Definition at line 14 of file PHFieldUniform.h.

View newest version in sPHENIX GitHub at line 14 of file PHFieldUniform.h

Member Function Documentation

double PHFieldUniform::get_field_mag_x ( ) const
inline

Definition at line 21 of file PHFieldUniform.h.

View newest version in sPHENIX GitHub at line 21 of file PHFieldUniform.h

References field_mag_x_.

double PHFieldUniform::get_field_mag_y ( ) const
inline

Definition at line 31 of file PHFieldUniform.h.

View newest version in sPHENIX GitHub at line 31 of file PHFieldUniform.h

References field_mag_y_.

double PHFieldUniform::get_field_mag_z ( ) const
inline

Definition at line 41 of file PHFieldUniform.h.

View newest version in sPHENIX GitHub at line 41 of file PHFieldUniform.h

References field_mag_z_.

void PHFieldUniform::GetFieldValue ( const double  Point[4],
double Bfield 
) const
overridevirtual

access field value Follow the convention of G4ElectroMagneticField

Parameters
[in]Pointspace time coordinate. x, y, z, t in Geant4/CLHEP units
[out]Bfieldfield value. In the case of magnetic field, the order is Bx, By, Bz in in Geant4/CLHEP units

Implements PHField.

Definition at line 15 of file PHFieldUniform.cc.

View newest version in sPHENIX GitHub at line 15 of file PHFieldUniform.cc

References field_mag_x_, field_mag_y_, and field_mag_z_.

void PHFieldUniform::set_field_mag_x ( double  fieldMagX)
inline

Definition at line 26 of file PHFieldUniform.h.

View newest version in sPHENIX GitHub at line 26 of file PHFieldUniform.h

References field_mag_x_.

void PHFieldUniform::set_field_mag_y ( double  fieldMagY)
inline

Definition at line 36 of file PHFieldUniform.h.

View newest version in sPHENIX GitHub at line 36 of file PHFieldUniform.h

References field_mag_y_.

void PHFieldUniform::set_field_mag_z ( double  fieldMagZ)
inline

Definition at line 46 of file PHFieldUniform.h.

View newest version in sPHENIX GitHub at line 46 of file PHFieldUniform.h

References field_mag_z_.

Member Data Documentation

double PHFieldUniform::field_mag_x_
protected

Definition at line 52 of file PHFieldUniform.h.

View newest version in sPHENIX GitHub at line 52 of file PHFieldUniform.h

Referenced by get_field_mag_x(), GetFieldValue(), and set_field_mag_x().

double PHFieldUniform::field_mag_y_
protected

Definition at line 53 of file PHFieldUniform.h.

View newest version in sPHENIX GitHub at line 53 of file PHFieldUniform.h

Referenced by get_field_mag_y(), GetFieldValue(), and set_field_mag_y().

double PHFieldUniform::field_mag_z_
protected

Definition at line 54 of file PHFieldUniform.h.

View newest version in sPHENIX GitHub at line 54 of file PHFieldUniform.h

Referenced by get_field_mag_z(), GetFieldValue(), and set_field_mag_z().


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