Trk::BinnedLayerMaterial Class Reference

It extends the LayerMaterialProperties base class. More...

#include <BinnedLayerMaterial.h>

Inheritance diagram for Trk::BinnedLayerMaterial:

Collaboration diagram for Trk::BinnedLayerMaterial:

Public Member Functions
	BinnedLayerMaterial ()
	Default Constructor - needed by POOL.
	BinnedLayerMaterial (BinUtility &binutility)
	Default Constructor for emptly material.
	BinnedLayerMaterial (const Trk::BinUtility &binutility, const MaterialPropertiesVector &fullProperties, double splitFactor=0.)
	Explizit constructor with only full MaterialProperties, and split factors:
	BinnedLayerMaterial (const Trk::BinUtility &binutility, const MaterialPropertiesMatrix &fullProperties, double splitFactor=0.)
	Explicit constructor with only full MaterialProperties, and split factors:
	BinnedLayerMaterial (const BinnedLayerMaterial &mprop)
	Copy Constructor.
virtual	~BinnedLayerMaterial () override
	Destructor.
virtual BinnedLayerMaterial *	clone () const override
	Pseudo-Constructor clone().
BinnedLayerMaterial &	operator= (const BinnedLayerMaterial &lmp)
	Assignment operator.
BinnedLayerMaterial &	operator= (BinnedLayerMaterial &&lmp) noexcept
virtual BinnedLayerMaterial &	operator*= (double scale) override
	Scale operator.
virtual const BinUtility *	binUtility () const override
	Return the BinUtility.
virtual void	updateBinning (BinUtility *bu) override
	Update the BinUtility if necessary - passing ownership of the utility class.
const MaterialPropertiesMatrix &	fullMaterial () const
	Return method for full material description of the Layer - for all bins.
virtual const MaterialProperties *	fullMaterial (const Amg::Vector3D &gp) const override
	Return method for full material description of the Layer.
virtual const MaterialProperties *	material (size_t bin0, size_t bin1) const override
	Access the single bin.
virtual MsgStream &	dump (MsgStream &sl) const override
	Output Method for MsgStream, to be overloaded by child classes.
virtual std::ostream &	dump (std::ostream &sl) const override
	Output Method for std::ostream, to be overloaded by child classes.
void	updateElementTable (const std::shared_ptr< const ElementTable > &) const
	Update the ElementTable.
const ElementTable *	elementTable () const
	Get the ElementTable.
double	factor (PropDirection pDir, MaterialUpdateStage mStage) const
	Update pre factor.
double	alongPreFactor () const
	Return method for pre update material description of the Layer along normalvector.
double	alongPostFactor () const
	Return method for post update material description of the Layer along normalvector.
double	oppositePreFactor () const
	Return method for pre update material description of the Layer along normalvector.
double	oppositePostFactor () const
	Return method for post update material description of the Layer along normalvector.

Protected Attributes
double	m_splitFactor {1.}
	the split factor in favour of oppositePre

Private Member Functions
void	clearMaterial ()
	helper method - to clear the material
void	fillMaterial (const MaterialPropertiesMatrix &matMatrix)
	helper method - to refill the material

Private Attributes
BinUtility *	m_binUtility {}
	the helper for the bin finding
MaterialPropertiesMatrix	m_fullMaterial
	The five different MaterialProperties.

Friends
class	::BinnedLayerMaterialCnv_p1

Detailed Description

It extends the LayerMaterialProperties base class.

Author

Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Definition at line 34 of file BinnedLayerMaterial.h.

Constructor & Destructor Documentation

BinnedLayerMaterial() [1/5]

Trk::BinnedLayerMaterial::BinnedLayerMaterial

(

)

Default Constructor - needed by POOL.

Definition at line 16 of file BinnedLayerMaterial.cxx.

    : Trk::LayerMaterialProperties(), m_binUtility(nullptr) {}

BinnedLayerMaterial() [2/5]

Trk::BinnedLayerMaterial::BinnedLayerMaterial

(

Trk::BinUtility &

binutility

)

Default Constructor for emptly material.

Definition at line 19 of file BinnedLayerMaterial.cxx.

    : Trk::LayerMaterialProperties(), m_binUtility(binutility.clone()) {
  // reserve
  m_fullMaterial.reserve(binutility.max(1) + 1);
  for (unsigned int ibin2 = 0; ibin2 < (unsigned int)binutility.max(1) + 1;
       ++ibin2) {
    // create the vector for the push_back
    Trk::MaterialPropertiesVector matVec;
    matVec.reserve(binutility.max(0) + 1);
    for (unsigned int ibin = 0; ibin < (unsigned int)binutility.max(0) + 1;
         ++ibin)
      matVec.push_back(nullptr);
    m_fullMaterial.push_back(std::move(matVec));
  }
}

BinnedLayerMaterial() [3/5]

Trk::BinnedLayerMaterial::BinnedLayerMaterial	(	const Trk::BinUtility &	binutility,
		const MaterialPropertiesVector &	fullProperties,
		double	splitFactor = 0. )

Explizit constructor with only full MaterialProperties, and split factors:

• 1. : oppositePre
• 0. : alongPre

===> 1 Dimensional array

ATTENTION: Ownership of MaterialProperties objects is given!

Definition at line 35 of file BinnedLayerMaterial.cxx.

    : Trk::LayerMaterialProperties(splitFactor),
      m_binUtility(binutility.clone()) {
  // constructor from a single vector
  clearMaterial();
  // fill the material with deep copy
  m_fullMaterial.push_back(fullProperties);
}

BinnedLayerMaterial() [4/5]

Trk::BinnedLayerMaterial::BinnedLayerMaterial	(	const Trk::BinUtility &	binutility,
		const MaterialPropertiesMatrix &	fullProperties,
		double	splitFactor = 0. )

Explicit constructor with only full MaterialProperties, and split factors:

• 1. : oppositePre
• 0. : alongPre

===> 2 Dimensional array

ATTENTION: Ownership of MaterialProperties objects is given!

Definition at line 46 of file BinnedLayerMaterial.cxx.

    : Trk::LayerMaterialProperties(splitFactor),
      m_binUtility(binutility.clone()),
      m_fullMaterial(fullProperties) {}

BinnedLayerMaterial() [5/5]

Trk::BinnedLayerMaterial::BinnedLayerMaterial

(

const BinnedLayerMaterial &

mprop

)

Copy Constructor.

Definition at line 58 of file BinnedLayerMaterial.cxx.

    : Trk::LayerMaterialProperties(lmp),
      m_binUtility(lmp.m_binUtility->clone()) {
  // clear the material
  clearMaterial();
  // and fill the material
  fillMaterial(lmp.m_fullMaterial);
}

~BinnedLayerMaterial()

Trk::BinnedLayerMaterial::~BinnedLayerMaterial ( )

overridevirtual

Destructor.

Definition at line 53 of file BinnedLayerMaterial.cxx.

                                             {
  delete m_binUtility;
  clearMaterial();
}

Member Function Documentation

alongPostFactor()

double Trk::LayerMaterialProperties::alongPostFactor ( ) const

inlineinherited

Return method for post update material description of the Layer along normalvector.

Definition at line 150 of file LayerMaterialProperties.h.

                                                             {
  return m_splitFactor;
}

alongPreFactor()

double Trk::LayerMaterialProperties::alongPreFactor ( ) const

inlineinherited

Return method for pre update material description of the Layer along normalvector.

inline return methods for the pre/post factors

Definition at line 146 of file LayerMaterialProperties.h.

                                                            {
  return (1. - m_splitFactor);
}

binUtility()

const BinUtility * Trk::BinnedLayerMaterial::binUtility ( ) const

inlineoverridevirtual

Return the BinUtility.

Implements Trk::LayerMaterialProperties.

Definition at line 123 of file BinnedLayerMaterial.h.

  { return m_binUtility; }

clearMaterial()

void Trk::BinnedLayerMaterial::clearMaterial ( )

private

helper method - to clear the material

Definition at line 102 of file BinnedLayerMaterial.cxx.

                                           {
  // clear the full material
  for (auto& matMatrixIter : m_fullMaterial) {
    for (auto& matIter : matMatrixIter) delete matIter;
  }
 
  m_fullMaterial.clear();
}

clone()

Trk::BinnedLayerMaterial * Trk::BinnedLayerMaterial::clone ( ) const

overridevirtual

Pseudo-Constructor clone().

Implements Trk::LayerMaterialProperties.

Definition at line 98 of file BinnedLayerMaterial.cxx.

                                                            {
  return new Trk::BinnedLayerMaterial(*this);
}

dump() [1/2]

MsgStream & Trk::BinnedLayerMaterial::dump ( MsgStream & sl ) const

overridevirtual

Output Method for MsgStream, to be overloaded by child classes.

Implements Trk::LayerMaterialProperties.

Definition at line 154 of file BinnedLayerMaterial.cxx.

                                                           {
  sl << "Trk::BinnedLayerMaterial : " << std::endl;
  sl << "   - Number of Material bins (1/2) : " << m_binUtility->max(0) + 1
     << " / " << m_binUtility->max(1) + 1 << std::endl;
  sl << "   - Parse full update material    : " << std::endl;
  // output  the full material
  unsigned int imat2 = 0;
  for (const auto& matMatrixIter : m_fullMaterial) {
    unsigned int imat1 = 0;
    // the vector iterator
    for (const auto& matIter : matMatrixIter) {
      if (matIter)
        sl << " Bin [" << imat2 << "][" << imat1 << "] - " << (*matIter)
           << std::endl;
      else
        sl << " Bin [" << imat2 << "][" << imat1 << "] -  empty " << std::endl;
      ++imat1;
    }
    ++imat2;
  }
  return sl;
}

dump() [2/2]

std::ostream & Trk::BinnedLayerMaterial::dump ( std::ostream & sl ) const

overridevirtual

Output Method for std::ostream, to be overloaded by child classes.

Implements Trk::LayerMaterialProperties.

Definition at line 177 of file BinnedLayerMaterial.cxx.

                                                             {
  sl << "Trk::BinnedLayerMaterial : " << std::endl;
  sl << "   - Number of Material bins (1/2) : " << m_binUtility->max(0) + 1
     << " / " << m_binUtility->max(1) + 1 << std::endl;
  sl << "   - Parse full update material    : " << std::endl;  //
  // output  the full material
  unsigned int imat2 = 0;
  for (const auto& matMatrixIter : m_fullMaterial) {
    unsigned int imat1 = 0;
    // the vector iterator
    for (const auto& matIter : matMatrixIter) {
      if (matIter)
        sl << " Bin [" << imat2 << "][" << imat1 << "] - " << (*matIter)
           << std::endl;
      else
        sl << " Bin [" << imat2 << "][" << imat1 << "] -  empty " << std::endl;
      ++imat1;
    }
    ++imat2;
  }
  return sl;
}

elementTable()

const ElementTable * Trk::LayerMaterialProperties::elementTable ( ) const

inlineinherited

Get the ElementTable.

Definition at line 98 of file LayerMaterialProperties.h.

{ return nullptr; }

factor()

double Trk::LayerMaterialProperties::factor ( PropDirection pDir, MaterialUpdateStage mStage ) const

inlineinherited

Update pre factor.

inline return methods for the pre/post factors

Definition at line 138 of file LayerMaterialProperties.h.

                                                          {
  if (mStage == Trk::fullUpdate) return 1.;
  return (static_cast<int>(pDir) * static_cast<int>(mStage) > 0 ?
          m_splitFactor : 1. - m_splitFactor);
}

fillMaterial()

void Trk::BinnedLayerMaterial::fillMaterial ( const MaterialPropertiesMatrix & matMatrix )

private

helper method - to refill the material

Definition at line 111 of file BinnedLayerMaterial.cxx.

                                                  {
  m_fullMaterial.reserve(m_binUtility->max(1) + 1);
  for (const auto& matMatrixIter : matMatrix) {
    // the vector to be copied
    Trk::MaterialPropertiesVector matVector;
    matVector.reserve(m_binUtility->max(0) + 1);
    // reassign
    for (const auto& matIter : matMatrixIter)
      matVector.push_back(matIter ? matIter->clone() : nullptr);
    m_fullMaterial.push_back(std::move(matVector));
  }
}

fullMaterial() [1/2]

const MaterialPropertiesMatrix & Trk::BinnedLayerMaterial::fullMaterial ( ) const

inline

Return method for full material description of the Layer - for all bins.

Definition at line 126 of file BinnedLayerMaterial.h.

  { return m_fullMaterial; }

fullMaterial() [2/2]

const Trk::MaterialProperties * Trk::BinnedLayerMaterial::fullMaterial ( const Amg::Vector3D & gp ) const

overridevirtual

Return method for full material description of the Layer.

Implements Trk::LayerMaterialProperties.

Definition at line 145 of file BinnedLayerMaterial.cxx.

                                 {
  if (m_fullMaterial.empty() || !m_binUtility) return nullptr;
  // the first bin
  size_t ibin1 = m_binUtility->bin(gp, 0);
  size_t ibin2 = m_binUtility->max(1) ? m_binUtility->bin(gp, 1) : 0;
  return m_fullMaterial[ibin2][ibin1];
}

material()

const MaterialProperties * Trk::BinnedLayerMaterial::material ( size_t bin0, size_t bin1 ) const

inlineoverridevirtual

Access the single bin.

Implements Trk::LayerMaterialProperties.

Definition at line 129 of file BinnedLayerMaterial.h.

  {
     return m_fullMaterial[bin1][bin0];
  }

operator*=()

Trk::BinnedLayerMaterial & Trk::BinnedLayerMaterial::operator*= ( double scale )

overridevirtual

Scale operator.

Implements Trk::LayerMaterialProperties.

Definition at line 125 of file BinnedLayerMaterial.cxx.

                                                                     {
  // scale the full material
  unsigned int imat2 = 0;
  for (auto& matMatrixIter : m_fullMaterial) {
    unsigned int imat1 = 0;
    // the vector iterator
    for (auto& matIter : matMatrixIter) {
      if (matIter) {
        Trk::MaterialProperties* mprop = matIter->clone();
        (*mprop) *= scale;
        delete matIter;
        m_fullMaterial[imat2][imat1] = mprop;
      }
      ++imat1;
    }
    ++imat2;
  }
  return (*this);
}

operator=() [1/2]

Trk::BinnedLayerMaterial & Trk::BinnedLayerMaterial::operator= ( Trk::BinnedLayerMaterial && lmp )

noexcept

Definition at line 84 of file BinnedLayerMaterial.cxx.

                                                                    {
  if (this != &lmp) {
    
    // first delete everything
    delete m_binUtility;
    clearMaterial();
    m_binUtility = std::exchange(lmp.m_binUtility, nullptr);
    // reassign the material
    m_fullMaterial = std::move(lmp.m_fullMaterial);
    Trk::LayerMaterialProperties::operator=(std::move(lmp));
  }
  return (*this);
}

operator=() [2/2]

Trk::BinnedLayerMaterial & Trk::BinnedLayerMaterial::operator=

(

const BinnedLayerMaterial &

lmp

)

Assignment operator.

Definition at line 68 of file BinnedLayerMaterial.cxx.

                                       {
  if (this != &lmp) {
    Trk::LayerMaterialProperties::operator=(lmp);
    // first delete everything
    delete m_binUtility;
    // reassign
    m_binUtility = lmp.binUtility()->clone();
    clearMaterial();
    // reassign the material
    fillMaterial(lmp.m_fullMaterial);
  }
  return (*this);
}

oppositePostFactor()

double Trk::LayerMaterialProperties::oppositePostFactor ( ) const

inlineinherited

Return method for post update material description of the Layer along normalvector.

Definition at line 158 of file LayerMaterialProperties.h.

                                                                {
  return (1. - m_splitFactor);
}

oppositePreFactor()

double Trk::LayerMaterialProperties::oppositePreFactor ( ) const

inlineinherited

Return method for pre update material description of the Layer along normalvector.

Definition at line 154 of file LayerMaterialProperties.h.

                                                               {
  return m_splitFactor;
}

updateBinning()

void Trk::BinnedLayerMaterial::updateBinning ( BinUtility * bu )

inlineoverridevirtual

Update the BinUtility if necessary - passing ownership of the utility class.

Implements Trk::LayerMaterialProperties.

Definition at line 134 of file BinnedLayerMaterial.h.

                                                              {
      if (bu){
          delete m_binUtility;
          m_binUtility = bu;
      }
  }

updateElementTable()

void Trk::LayerMaterialProperties::updateElementTable ( const std::shared_ptr< const ElementTable > & ) const

inlineinherited

Update the ElementTable.

Definition at line 95 of file LayerMaterialProperties.h.

{}

Friends And Related Symbol Documentation

::BinnedLayerMaterialCnv_p1

friend class ::BinnedLayerMaterialCnv_p1

friend

Definition at line 107 of file BinnedLayerMaterial.h.

Member Data Documentation

m_binUtility

BinUtility* Trk::BinnedLayerMaterial::m_binUtility {}

private

the helper for the bin finding

Definition at line 109 of file BinnedLayerMaterial.h.

{}; 

m_fullMaterial

MaterialPropertiesMatrix Trk::BinnedLayerMaterial::m_fullMaterial

private

The five different MaterialProperties.

Definition at line 112 of file BinnedLayerMaterial.h.

m_splitFactor

double Trk::LayerMaterialProperties::m_splitFactor {1.}

protectedinherited

the split factor in favour of oppositePre

Definition at line 134 of file LayerMaterialProperties.h.

{1.};  

---

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

• BinnedLayerMaterial.h
• BinnedLayerMaterial.cxx