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

Inheritance diagram for SQField3DCartesian:

Collaboration diagram for SQField3DCartesian:

Classes
class	FieldPoint

Public Member Functions
	SQField3DCartesian (const std::string &fname, const float magfield_rescale=1.0)

virtual	~SQField3DCartesian ()

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

double	GetZMin () const
	return the min and max in z More...

double	GetZMax () const

int	GetGlobalIndex (int xIdx, int yIdx, int zIdx) const
	return the index of the global index based on the local index More...

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

virtual	~PHField ()

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

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
std::string	filename

std::set< double >	xvals

std::set< double >	yvals

std::set< double >	zvals

std::vector< FieldPoint >	fpoints

int	xsteps

int	ysteps

int	zsteps

double	xmin

double	xmax

double	ymin

double	ymax

double	zmin

double	zmax

double	xstepsize

double	ystepsize

double	zstepsize

double	fieldstr

Protected Attributes inherited from PHField
unsigned	verb_

Detailed Description

Definition at line 12 of file SQField3DCartesian.h.

Constructor & Destructor Documentation

◆ SQField3DCartesian()

SQField3DCartesian::SQField3DCartesian	(	const std::string &	fname,
		const float	magfield_rescale = `1.0`
	)

Definition at line 10 of file SQField3DCartesian.cc.

References SQField3DCartesian::FieldPoint::B, fieldstr, filename, fpoints, SQField3DCartesian::FieldPoint::x, xmax, xmin, xsteps, xstepsize, xvals, SQField3DCartesian::FieldPoint::y, ymax, ymin, ysteps, ystepsize, yvals, SQField3DCartesian::FieldPoint::z, zmax, zmin, zsteps, zstepsize, and zvals.

◆ ~SQField3DCartesian()

SQField3DCartesian::~SQField3DCartesian ( )

virtual

Definition at line 134 of file SQField3DCartesian.cc.

Member Function Documentation

◆ GetFieldValue()

void SQField3DCartesian::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 142 of file SQField3DCartesian.cc.

References fpoints, GetGlobalIndex(), xmax, xmin, xsteps, xstepsize, ymax, ymin, ysteps, ystepsize, zmax, zmin, zsteps, and zstepsize.

Referenced by PHFieldSeaQuest::GetFieldValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetGlobalIndex()

int SQField3DCartesian::GetGlobalIndex	(	int	xIdx,
		int	yIdx,
		int	zIdx
	)		const

return the index of the global index based on the local index

Definition at line 137 of file SQField3DCartesian.cc.

References ysteps, and zsteps.

Referenced by GetFieldValue().

Here is the caller graph for this function:

◆ GetZMax()

double SQField3DCartesian::GetZMax ( ) const

inline

Definition at line 26 of file SQField3DCartesian.h.

References zmax.

Referenced by PHFieldSeaQuest::PHFieldSeaQuest().

Here is the caller graph for this function:

◆ GetZMin()

double SQField3DCartesian::GetZMin ( ) const

inline

return the min and max in z

Definition at line 25 of file SQField3DCartesian.h.

References zmin.

Referenced by PHFieldSeaQuest::PHFieldSeaQuest().

Here is the caller graph for this function:

Member Data Documentation

◆ fieldstr

double SQField3DCartesian::fieldstr

protected

Definition at line 60 of file SQField3DCartesian.h.

Referenced by SQField3DCartesian().

◆ filename

std::string SQField3DCartesian::filename

protected

Definition at line 41 of file SQField3DCartesian.h.

Referenced by SQField3DCartesian().

◆ fpoints

std::vector<FieldPoint> SQField3DCartesian::fpoints

protected

Definition at line 45 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), and SQField3DCartesian().

◆ xmax

double SQField3DCartesian::xmax

protected

Definition at line 51 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), and SQField3DCartesian().

◆ xmin

double SQField3DCartesian::xmin

protected

Definition at line 50 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), and SQField3DCartesian().

◆ xsteps

int SQField3DCartesian::xsteps

protected

Definition at line 47 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), and SQField3DCartesian().

◆ xstepsize

double SQField3DCartesian::xstepsize

protected

Definition at line 56 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), and SQField3DCartesian().

◆ xvals

std::set<double> SQField3DCartesian::xvals

protected

Definition at line 42 of file SQField3DCartesian.h.

Referenced by SQField3DCartesian().

◆ ymax

double SQField3DCartesian::ymax

protected

Definition at line 53 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), and SQField3DCartesian().

◆ ymin

double SQField3DCartesian::ymin

protected

Definition at line 52 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), and SQField3DCartesian().

◆ ysteps

int SQField3DCartesian::ysteps

protected

Definition at line 48 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), GetGlobalIndex(), and SQField3DCartesian().

◆ ystepsize

double SQField3DCartesian::ystepsize

protected

Definition at line 57 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), and SQField3DCartesian().

◆ yvals

std::set<double> SQField3DCartesian::yvals

protected

Definition at line 43 of file SQField3DCartesian.h.

Referenced by SQField3DCartesian().

◆ zmax

double SQField3DCartesian::zmax

protected

Definition at line 55 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), GetZMax(), and SQField3DCartesian().

◆ zmin

double SQField3DCartesian::zmin

protected

Definition at line 54 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), GetZMin(), and SQField3DCartesian().

◆ zsteps

int SQField3DCartesian::zsteps

protected

Definition at line 49 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), GetGlobalIndex(), and SQField3DCartesian().

◆ zstepsize

double SQField3DCartesian::zstepsize

protected

Definition at line 58 of file SQField3DCartesian.h.

Referenced by GetFieldValue(), and SQField3DCartesian().

◆ zvals

std::set<double> SQField3DCartesian::zvals

protected

Definition at line 44 of file SQField3DCartesian.h.

Referenced by SQField3DCartesian().

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

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

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SQField3DCartesian()

◆ ~SQField3DCartesian()

Member Function Documentation

◆ GetFieldValue()

◆ GetGlobalIndex()

◆ GetZMax()

◆ GetZMin()

Member Data Documentation

◆ fieldstr

◆ filename

◆ fpoints

◆ xmax

◆ xmin

◆ xsteps

◆ xstepsize

◆ xvals

◆ ymax

◆ ymin

◆ ysteps

◆ ystepsize

◆ yvals

◆ zmax

◆ zmin

◆ zsteps

◆ zstepsize

◆ zvals