#include </dev/shm/kenichi/update-github-e1039-doc/e1039-core/packages/PHField/PHFieldRegionalConst.h>

Inheritance diagram for PHFieldRegionalConst:

Collaboration diagram for PHFieldRegionalConst:

Public Member Functions
	PHFieldRegionalConst (const double field=5.0, const double magfield_rescale=1.0, const int verb=0)

virtual	~PHFieldRegionalConst ()

void	GetFieldValue (const double Point[4], double *Bfield) const

void	identify (std::ostream &os=std::cout) const

double	get_field_val () const

void	set_field_val (double fieldVal)

double	get_maxr () const

void	set_maxr (double maxr)

double	get_maxy () const

void	set_maxy (double maxy)

double	get_mean_x () const

void	set_mean_x (double meanX)

double	get_mean_y () const

void	set_mean_y (double meanY)

double	get_mean_z () const

void	set_mean_z (double meanZ)

double	get_minr () const

void	set_minr (double minr)

double	get_miny () const

void	set_miny (double miny)

Public Member Functions inherited from PHField
	PHField (const int verb=0)
	constructor More...

virtual	~PHField ()

void	Verbosity (const int i)

Public Member Functions inherited from PHObject
	PHObject ()
	ctor More...

virtual	~PHObject ()
	dtor More...

virtual PHObject *	clone () const
	Virtual copy constructor. More...

virtual void	Reset ()
	Clear Event. More...

virtual int	isValid () const
	isValid returns non zero if object contains vailid data More...

virtual int	isValid (const float) const

virtual int	isValid (const double) const

virtual int	isValid (const int) const

virtual int	isValid (const unsigned int) const

virtual int	isImplemented (const float f) const

virtual int	isImplemented (const double f) const

virtual int	isImplemented (const int i) const

virtual int	isImplemented (const unsigned int i) const

void	SplitLevel (const int i)

int	SplitLevel () const

void	BufferSize (const int i)

int	BufferSize () const

Protected Attributes
double	_mean_x

double	_mean_y

double	_mean_z

double	_maxy

double	_miny

double	_maxr

double	_minr

double	_field_val

Protected Attributes inherited from PHField
unsigned	verb_

Detailed Description

Definition at line 14 of file PHFieldRegionalConst.h.

Constructor & Destructor Documentation

◆ PHFieldRegionalConst()

PHFieldRegionalConst::PHFieldRegionalConst	(	const double	field = `5.0`,
		const double	magfield_rescale = `1.0`,
		const int	verb = `0`
	)

Definition at line 14 of file PHFieldRegionalConst.cc.

References identify().

Here is the call graph for this function:

◆ ~PHFieldRegionalConst()

virtual PHFieldRegionalConst::~PHFieldRegionalConst ( )

inlinevirtual

Definition at line 20 of file PHFieldRegionalConst.h.

Member Function Documentation

◆ get_field_val()

double PHFieldRegionalConst::get_field_val ( ) const

inline

Definition at line 29 of file PHFieldRegionalConst.h.

References _field_val.

◆ get_maxr()

double PHFieldRegionalConst::get_maxr ( ) const

inline

Definition at line 37 of file PHFieldRegionalConst.h.

References _maxr.

◆ get_maxy()

double PHFieldRegionalConst::get_maxy ( ) const

inline

Definition at line 45 of file PHFieldRegionalConst.h.

References _maxy.

◆ get_mean_x()

double PHFieldRegionalConst::get_mean_x ( ) const

inline

Definition at line 53 of file PHFieldRegionalConst.h.

References _mean_x.

◆ get_mean_y()

double PHFieldRegionalConst::get_mean_y ( ) const

inline

Definition at line 61 of file PHFieldRegionalConst.h.

References _mean_y.

◆ get_mean_z()

double PHFieldRegionalConst::get_mean_z ( ) const

inline

Definition at line 69 of file PHFieldRegionalConst.h.

References _mean_z.

◆ get_minr()

double PHFieldRegionalConst::get_minr ( ) const

inline

Definition at line 77 of file PHFieldRegionalConst.h.

References _minr.

◆ get_miny()

double PHFieldRegionalConst::get_miny ( ) const

inline

Definition at line 85 of file PHFieldRegionalConst.h.

References _miny.

◆ GetFieldValue()

void PHFieldRegionalConst::GetFieldValue	(	const double	Point[4],
		double *	Bfield
	)		const

virtual

access field value Follow the convention of G4ElectroMagneticField

Parameters

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

Implements PHField.

Definition at line 24 of file PHFieldRegionalConst.cc.

References _field_val, _maxr, _maxy, _mean_x, _mean_y, _mean_z, _minr, and _miny.

Referenced by PHFieldSeaQuest::GetFieldValue().

Here is the caller graph for this function:

◆ identify()

void PHFieldRegionalConst::identify ( std::ostream & os = std::cout ) const

virtual

identify Function from PHObject

Parameters

os	Output Stream

Reimplemented from PHField.

Definition at line 45 of file PHFieldRegionalConst.cc.

References _field_val, _mean_x, _mean_y, and _mean_z.

Referenced by PHFieldRegionalConst().

Here is the caller graph for this function:

◆ set_field_val()

void PHFieldRegionalConst::set_field_val ( double fieldVal )

inline

Definition at line 33 of file PHFieldRegionalConst.h.

References _field_val.

◆ set_maxr()

void PHFieldRegionalConst::set_maxr ( double maxr )

inline

Definition at line 41 of file PHFieldRegionalConst.h.

References _maxr.

◆ set_maxy()

void PHFieldRegionalConst::set_maxy ( double maxy )

inline

Definition at line 49 of file PHFieldRegionalConst.h.

References _maxy.

◆ set_mean_x()

void PHFieldRegionalConst::set_mean_x ( double meanX )

inline

Definition at line 57 of file PHFieldRegionalConst.h.

References _mean_x.

Referenced by PHFieldSeaQuest::PHFieldSeaQuest().

Here is the caller graph for this function:

◆ set_mean_y()

void PHFieldRegionalConst::set_mean_y ( double meanY )

inline

Definition at line 65 of file PHFieldRegionalConst.h.

References _mean_y.

Referenced by PHFieldSeaQuest::PHFieldSeaQuest().

Here is the caller graph for this function:

◆ set_mean_z()

void PHFieldRegionalConst::set_mean_z ( double meanZ )

inline

Definition at line 73 of file PHFieldRegionalConst.h.

References _mean_z.

Referenced by PHFieldSeaQuest::PHFieldSeaQuest().

Here is the caller graph for this function:

◆ set_minr()

void PHFieldRegionalConst::set_minr ( double minr )

inline

Definition at line 81 of file PHFieldRegionalConst.h.

References _minr.

◆ set_miny()

void PHFieldRegionalConst::set_miny ( double miny )

inline

Definition at line 89 of file PHFieldRegionalConst.h.

References _miny.

Member Data Documentation

◆ _field_val

double PHFieldRegionalConst::_field_val

protected

Definition at line 98 of file PHFieldRegionalConst.h.

Referenced by get_field_val(), GetFieldValue(), identify(), and set_field_val().

◆ _maxr

double PHFieldRegionalConst::_maxr

protected

Definition at line 97 of file PHFieldRegionalConst.h.

Referenced by get_maxr(), GetFieldValue(), and set_maxr().

◆ _maxy

double PHFieldRegionalConst::_maxy

protected

Definition at line 96 of file PHFieldRegionalConst.h.

Referenced by get_maxy(), GetFieldValue(), and set_maxy().

◆ _mean_x

double PHFieldRegionalConst::_mean_x

protected

Definition at line 95 of file PHFieldRegionalConst.h.

Referenced by get_mean_x(), GetFieldValue(), identify(), and set_mean_x().

◆ _mean_y

double PHFieldRegionalConst::_mean_y

protected

Definition at line 95 of file PHFieldRegionalConst.h.

Referenced by get_mean_y(), GetFieldValue(), identify(), and set_mean_y().

◆ _mean_z

double PHFieldRegionalConst::_mean_z

protected

Definition at line 95 of file PHFieldRegionalConst.h.

Referenced by get_mean_z(), GetFieldValue(), identify(), and set_mean_z().

◆ _minr

double PHFieldRegionalConst::_minr

protected

Definition at line 97 of file PHFieldRegionalConst.h.

Referenced by get_minr(), GetFieldValue(), and set_minr().

◆ _miny

double PHFieldRegionalConst::_miny

protected

Definition at line 96 of file PHFieldRegionalConst.h.

Referenced by get_miny(), GetFieldValue(), and set_miny().

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

/dev/shm/kenichi/update-github-e1039-doc/e1039-core/packages/PHField/PHFieldRegionalConst.h
/dev/shm/kenichi/update-github-e1039-doc/e1039-core/packages/PHField/PHFieldRegionalConst.cc

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PHFieldRegionalConst()

◆ ~PHFieldRegionalConst()

Member Function Documentation

◆ get_field_val()

◆ get_maxr()

◆ get_maxy()

◆ get_mean_x()

◆ get_mean_y()

◆ get_mean_z()

◆ get_minr()

◆ get_miny()

◆ GetFieldValue()

◆ identify()

◆ set_field_val()

◆ set_maxr()

◆ set_maxy()

◆ set_mean_x()

◆ set_mean_y()

◆ set_mean_z()

◆ set_minr()

◆ set_miny()

Member Data Documentation

◆ _field_val

◆ _maxr

◆ _maxy

◆ _mean_x

◆ _mean_y

◆ _mean_z

◆ _minr

◆ _miny