FieldValue< T > Class Template Reference

Magnetic flux density vector. More...

#include <KfFieldValue.h>

Inheritance diagram for FieldValue< T >:

Public Member Functions
	FieldValue ()=default
	Default constructor.
template<typename I>
	FieldValue (const I &bx, const I &by, const I &bz, const I &z)
	Constructor from components.
template<typename I>
	FieldValue (const FieldValue< I > &other)
	Copy constructor.
	~FieldValue ()=default
	Destructor.
FieldValue &	operator= (const FieldValue &other)=default
	Copy assignment operator.
template<typename I>
void	Set (const I &bx, const I &by, const I &bz, const I &z)
	Constructor from components.
void	SetSimdEntries (const FieldValue &other, const kf::utils::masktype< T > &mask)
	Combines the current magnetic field value with another one using a mask.
std::tuple< T, T, T >	Get () const
	Gets magnetic flux density x, y, z-components [kG].
T	GetAbsSq () const
	Gets squared absolute magnetic flux [kG2].
T	GetAbs () const
	Gets absolute magnetic flux [kG].
T	GetComponent (int iD) const
	Gets component by index.
T	GetBx () const
	Gets magnetic flux x-component [kG].
T	GetBy () const
	Gets magnetic flux density y-component [kG].
T	GetBz () const
	Gets magnetic flux density z-component [kG].
T	GetZ () const
	Gets z-coordinate of the spatial point [cm].
bool	IsZero () const
	Checks, if the field value is zero (negligible)
void	CheckConsistency () const
	Consistency checker.
void	SetSimdEntry (double bx, double by, double bz, double z, size_t i)
	Sets magnetic flux density components to the field function.
std::string	ToString (int indentLevel=0) const
	String representation of the field.

Private Member Functions
template<class Archive>
void	serialize (Archive &ar, const unsigned int)

Private Attributes
GeoVector_t< T >	fB
	Magnetic flux vector [kG].
T	fZ {}

Friends
template<typename>
class	FieldValue
class	boost::serialization::access
	Serialization function.

Detailed Description

template<typename T>
class FieldValue< T >

Magnetic flux density vector.

Template Parameters

T	Underlying data-type (float, double, fvec)

Definition at line 31 of file KfFieldValue.h.

Constructor & Destructor Documentation

FieldValue() [1/3]

template<typename T>

cbm::algo::kf::FieldValue< T >::FieldValue ( )

default

Default constructor.

Note

By default field is zero

FieldValue() [2/3]

template<typename T>

template<typename I>

cbm::algo::kf::FieldValue< T >::FieldValue ( const I & bx, const I & by, const I & bz, const I & z )

inline

Constructor from components.

Template Parameters

I	Data type of the input parameters

Parameters

bx	x-component of magnetic field vector [kG]
by	y-component of magnetic field vector [kG]
bz	z-component of magnetic field vector [kG]
z	z-component of the spatial point [cm]

Definition at line 47 of file KfFieldValue.h.

FieldValue() [3/3]

template<typename T>

template<typename I>

cbm::algo::kf::FieldValue< T >::FieldValue ( const FieldValue< I > & other )

inline

Copy constructor.

Template Parameters

I	Underlying data-type of the other object

Definition at line 56 of file KfFieldValue.h.

~FieldValue()

template<typename T>

cbm::algo::kf::FieldValue< T >::~FieldValue ( )

default

Destructor.

Member Function Documentation

CheckConsistency()

template<typename T>

void cbm::algo::kf::FieldValue< T >::CheckConsistency

(

)

const

Consistency checker.

Definition at line 20 of file KfFieldValue.cxx.

Get()

template<typename T>

std::tuple< T, T, T > cbm::algo::kf::FieldValue< T >::Get ( ) const

inline

Gets magnetic flux density x, y, z-components [kG].

Returns

tuple (Bx, By, Bz)

Definition at line 96 of file KfFieldValue.h.

GetAbs()

template<typename T>

T cbm::algo::kf::FieldValue< T >::GetAbs ( ) const

inline

Gets absolute magnetic flux [kG].

Definition at line 102 of file KfFieldValue.h.

GetAbsSq()

template<typename T>

T cbm::algo::kf::FieldValue< T >::GetAbsSq ( ) const

inline

Gets squared absolute magnetic flux [kG2].

Definition at line 99 of file KfFieldValue.h.

GetBx()

template<typename T>

T cbm::algo::kf::FieldValue< T >::GetBx ( ) const

inline

Gets magnetic flux x-component [kG].

Definition at line 109 of file KfFieldValue.h.

GetBy()

template<typename T>

T cbm::algo::kf::FieldValue< T >::GetBy ( ) const

inline

Gets magnetic flux density y-component [kG].

Definition at line 112 of file KfFieldValue.h.

GetBz()

template<typename T>

T cbm::algo::kf::FieldValue< T >::GetBz ( ) const

inline

Gets magnetic flux density z-component [kG].

Definition at line 115 of file KfFieldValue.h.

GetComponent()

template<typename T>

T cbm::algo::kf::FieldValue< T >::GetComponent ( int iD ) const

inline

Gets component by index.

Parameters

iD	index of the component (i = 0: x, 1: y, 2: z)

Definition at line 106 of file KfFieldValue.h.

GetZ()

template<typename T>

T cbm::algo::kf::FieldValue< T >::GetZ ( ) const

inline

Gets z-coordinate of the spatial point [cm].

Definition at line 118 of file KfFieldValue.h.

IsZero()

template<typename T>

bool cbm::algo::kf::FieldValue< T >::IsZero ( ) const

inline

Checks, if the field value is zero (negligible)

Definition at line 121 of file KfFieldValue.h.

operator=()

template<typename T>

FieldValue & cbm::algo::kf::FieldValue< T >::operator= ( const FieldValue< T > & other )

default

Copy assignment operator.

serialize()

template<typename T>

template<class Archive>

void cbm::algo::kf::FieldValue< T >::serialize ( Archive & ar, const unsigned int  )

inlineprivate

Definition at line 158 of file KfFieldValue.h.

Set()

template<typename T>

template<typename I>

void cbm::algo::kf::FieldValue< T >::Set ( const I & bx, const I & by, const I & bz, const I & z )

inline

Constructor from components.

Template Parameters

I	Data type of the input parameters

Parameters

bx	x-component of magnetic field vector [kG]
by	y-component of magnetic field vector [kG]
bz	z-component of magnetic field vector [kG]
z	z-component of the spatial point [cm]

Definition at line 75 of file KfFieldValue.h.

SetSimdEntries()

template<typename T>

void cbm::algo::kf::FieldValue< T >::SetSimdEntries ( const FieldValue< T > & other, const kf::utils::masktype< T > & mask )

inline

Combines the current magnetic field value with another one using a mask.

Parameters

other	Other flux value
mask	Mask to perform a combination

Definition at line 86 of file KfFieldValue.h.

SetSimdEntry()

template<typename T>

void cbm::algo::kf::FieldValue< T >::SetSimdEntry ( double bx, double by, double bz, double z, size_t i )

inline

Sets magnetic flux density components to the field function.

Parameters

bx	x-component of the magnetic flux density [kG]
by	y-component of the magnetic flux density [kG]
bz	z-component of the magnetic flux density [kG]
z	z-component of the spatial point [cm]
i	index of the SIMD entry (ignored, if T is not a SIMD vector)

Definition at line 143 of file KfFieldValue.h.

ToString()

template<typename T>

std::string cbm::algo::kf::FieldValue< T >::ToString

(

int

indentLevel = 0

)

const

String representation of the field.

Definition at line 33 of file KfFieldValue.cxx.

Friends And Related Symbol Documentation

boost::serialization::access

template<typename T>

friend class boost::serialization::access

friend

Serialization function.

Definition at line 156 of file KfFieldValue.h.

FieldValue

template<typename T>

template<typename>

friend class FieldValue

friend

Definition at line 33 of file KfFieldValue.h.

Member Data Documentation

fB

template<typename T>

GeoVector_t<T> cbm::algo::kf::FieldValue< T >::fB

private

Initial value:

{
      {utils::simd::Cast<float, T>(0.F), utils::simd::Cast<float, T>(0.F), utils::simd::Cast<float, T>(0.F)}}

Magnetic flux vector [kG].

Definition at line 165 of file KfFieldValue.h.

fZ

template<typename T>

T cbm::algo::kf::FieldValue< T >::fZ {}

private

Definition at line 167 of file KfFieldValue.h.

---

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

• KfFieldValue.h
• KfFieldValue.cxx