#include <HomogeneousLayerMaterial.h>

Inheritance diagram for Trk::HomogeneousLayerMaterial:

Collaboration diagram for Trk::HomogeneousLayerMaterial:

Public Member Functions
	HomogeneousLayerMaterial ()
	Default Constructor - creates empty HomogeneousLayerMaterial. More...

	HomogeneousLayerMaterial (const MaterialProperties &full, double splitFactor)
	Explicit constructor with only full MaterialProperties. More...

	HomogeneousLayerMaterial (const HomogeneousLayerMaterial &mprop)
	Copy Constructor. More...

virtual	~HomogeneousLayerMaterial () override
	Destructor. More...

virtual HomogeneousLayerMaterial *	clone () const override
	Pseudo-Constructor clone() More...

HomogeneousLayerMaterial &	operator= (const HomogeneousLayerMaterial &lmp)
	Assignment operator. More...

	HomogeneousLayerMaterial (Trk::HomogeneousLayerMaterial &&lmp)=default
	Default move constructor. More...

HomogeneousLayerMaterial &	operator= (Trk::HomogeneousLayerMaterial &&lmp)=default
	Default move assignment operator. More...

virtual HomogeneousLayerMaterial &	operator*= (double scale) override
	Scale operator. More...

virtual const MaterialProperties *	fullMaterial (const Amg::Vector3D &gp) const override
	Return method for full material description of the Layer. More...

virtual const MaterialProperties *	material (size_t ib0, size_t ib1) const override
	Direct access via bins to the MaterialProperties. More...

virtual const BinUtility *	binUtility () const override
	Return the BinUtility. More...

virtual void	updateBinning (BinUtility *) override
	Update the BinUtility if necessary - passing ownership of the utility class. More...

virtual MsgStream &	dump (MsgStream &sl) const override
	Output Method for MsgStream, to be overloaded by child classes. More...

virtual std::ostream &	dump (std::ostream &sl) const override
	Output Method for std::ostream, to be overloaded by child classes. More...

void	updateElementTable (const SharedObject< const ElementTable > &) const
	Update the ElementTable. More...

const ElementTable *	elementTable () const
	Get the ElementTable. More...

double	factor (PropDirection pDir, MaterialUpdateStage mStage) const
	Update pre factor. More...

double	alongPreFactor () const
	Return method for pre update material description of the Layer along normalvector. More...

double	alongPostFactor () const
	Return method for post update material description of the Layer along normalvector. More...

double	oppositePreFactor () const
	Return method for pre update material description of the Layer along normalvector. More...

double	oppositePostFactor () const
	Return method for post update material description of the Layer along normalvector. More...

Protected Attributes
double	m_splitFactor
	the split factor in favour of oppositePre More...

Private Attributes
std::unique_ptr< MaterialProperties >	m_fullMaterial
	The five different MaterialProperties. More...

Friends
class	::HomogeneousLayerMaterialCnv_p1

Detailed Description

It extends the LayerMaterialProperties base class.

This class encapsulates the logic to build pre/post/full update material for Layer structures, it hosts 5 different MaterialProperties in the following order:

fullUpdate (crossing full Layer in both directions)
alongPreUpdate (passing material to sensitive part in the direction of the normal vector)
alongPostUpdate (passing material after sensitive part in the direction of the normal vector)
oppositePreUpdate (passing material to sensitive part in the opposite direction to the normal vector)
oppositePostUpdate (passing material after sensitive part in the opposite direction to the normal vector)

This is handled by a full Layer information and a split factor.

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

Definition at line 53 of file HomogeneousLayerMaterial.h.

Constructor & Destructor Documentation

◆ HomogeneousLayerMaterial() [1/4]

Trk::HomogeneousLayerMaterial::HomogeneousLayerMaterial ( )

Default Constructor - creates empty HomogeneousLayerMaterial.

Definition at line 13 of file HomogeneousLayerMaterial.cxx.

14 : Trk::LayerMaterialProperties(), m_fullMaterial(nullptr) {}

◆ HomogeneousLayerMaterial() [2/4]

Trk::HomogeneousLayerMaterial::HomogeneousLayerMaterial	(	const MaterialProperties &	full,
		double	splitFactor
	)

Explicit constructor with only full MaterialProperties.

alongPre and oppositePre, alongPre and oppositePost are obviously swapped

Definition at line 16 of file HomogeneousLayerMaterial.cxx.

18 : Trk::LayerMaterialProperties(splitFactor), m_fullMaterial(full.clone()) {}

◆ HomogeneousLayerMaterial() [3/4]

Trk::HomogeneousLayerMaterial::HomogeneousLayerMaterial ( const HomogeneousLayerMaterial & mprop )

Copy Constructor.

Definition at line 20 of file HomogeneousLayerMaterial.cxx.

     : LayerMaterialProperties(lmp.m_splitFactor),
       m_fullMaterial(lmp.m_fullMaterial ? lmp.m_fullMaterial->clone()
                                         : nullptr) {}

◆ ~HomogeneousLayerMaterial()

Trk::HomogeneousLayerMaterial::~HomogeneousLayerMaterial ( )

overridevirtualdefault

Destructor.

◆ HomogeneousLayerMaterial() [4/4]

Trk::HomogeneousLayerMaterial::HomogeneousLayerMaterial ( Trk::HomogeneousLayerMaterial && lmp )

default

Default move constructor.

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 142 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 138 of file LayerMaterialProperties.h.

                                                             {
   return (1. - m_splitFactor);
 }

◆ binUtility()

virtual const BinUtility* Trk::HomogeneousLayerMaterial::binUtility ( ) const

inlineoverridevirtual

Return the BinUtility.

Implements Trk::LayerMaterialProperties.

Definition at line 93 of file HomogeneousLayerMaterial.h.

93 { return nullptr; }

◆ clone()

HomogeneousLayerMaterial * Trk::HomogeneousLayerMaterial::clone ( ) const

inlineoverridevirtual

Pseudo-Constructor clone()

Implements Trk::LayerMaterialProperties.

Definition at line 111 of file HomogeneousLayerMaterial.h.

                                                                        {
   return new HomogeneousLayerMaterial(*this);
 }

◆ dump() [1/2]

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

overridevirtual

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

Implements Trk::LayerMaterialProperties.

Definition at line 47 of file HomogeneousLayerMaterial.cxx.

                                                                 {
   sl << "Trk::HomogeneousLayerMaterial : " << std::endl;
   if (m_fullMaterial) {
     sl << "   - fullMaterial         : " << *m_fullMaterial << std::endl;
   }
   sl << "   - split factor         : " << m_splitFactor << std::endl;
  
   return sl;
 }

◆ dump() [2/2]

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

overridevirtual

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

Implements Trk::LayerMaterialProperties.

Definition at line 57 of file HomogeneousLayerMaterial.cxx.

                                                                   {
   sl << "Trk::HomogeneousLayerMaterial : " << std::endl;
   if (m_fullMaterial) {
     sl << "   - fullMaterial         : " << *m_fullMaterial << std::endl;
   }
   sl << "   - split factor         : " << m_splitFactor << std::endl;
   return sl;
 }

◆ elementTable()

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

inlineinherited

Get the ElementTable.

Definition at line 90 of file LayerMaterialProperties.h.

90 { 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 130 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);
 }

◆ fullMaterial()

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

inlineoverridevirtual

Return method for full material description of the Layer.

Implements Trk::LayerMaterialProperties.

Definition at line 115 of file HomogeneousLayerMaterial.h.

                               {
   return m_fullMaterial.get();
 }

◆ material()

const MaterialProperties * Trk::HomogeneousLayerMaterial::material	(	size_t	ib0,
		size_t	ib1
	)		const

inlineoverridevirtual

Direct access via bins to the MaterialProperties.

Implements Trk::LayerMaterialProperties.

Definition at line 120 of file HomogeneousLayerMaterial.h.

                           {
   return m_fullMaterial.get();
 }

◆ operator*=()

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

overridevirtual

Scale operator.

Implements Trk::LayerMaterialProperties.

Definition at line 39 of file HomogeneousLayerMaterial.cxx.

                   {
   // scale the sub-properties
   if (m_fullMaterial) (*m_fullMaterial) *= scale;
  
   return (*this);
 }

◆ operator=() [1/2]

Trk::HomogeneousLayerMaterial & Trk::HomogeneousLayerMaterial::operator= ( const HomogeneousLayerMaterial & lmp )

Assignment operator.

Definition at line 28 of file HomogeneousLayerMaterial.cxx.

                                             {
   if (this != &lmp) {
     // now refill everything
     m_fullMaterial.reset(lmp.m_fullMaterial ? lmp.m_fullMaterial->clone()
                                             : nullptr);
     Trk::LayerMaterialProperties::m_splitFactor = lmp.m_splitFactor;
   }
   return (*this);
 }

◆ operator=() [2/2]

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

default

Default move assignment operator.

◆ oppositePostFactor()

double Trk::LayerMaterialProperties::oppositePostFactor ( ) const

inlineinherited

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

Definition at line 150 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 146 of file LayerMaterialProperties.h.

                                                                {
   return m_splitFactor;
 }

◆ updateBinning()

virtual void Trk::HomogeneousLayerMaterial::updateBinning ( BinUtility * )

inlineoverridevirtual

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

Implements Trk::LayerMaterialProperties.

Definition at line 97 of file HomogeneousLayerMaterial.h.

97 {}

◆ updateElementTable()

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

inlineinherited

Update the ElementTable.

Definition at line 87 of file LayerMaterialProperties.h.

87 {}

Friends And Related Function Documentation

◆ ::HomogeneousLayerMaterialCnv_p1

friend class ::HomogeneousLayerMaterialCnv_p1

friend

Definition at line 105 of file HomogeneousLayerMaterial.h.

Member Data Documentation

◆ m_fullMaterial

std::unique_ptr<MaterialProperties> Trk::HomogeneousLayerMaterial::m_fullMaterial

private

The five different MaterialProperties.

Definition at line 108 of file HomogeneousLayerMaterial.h.

◆ m_splitFactor

double Trk::LayerMaterialProperties::m_splitFactor

protectedinherited

the split factor in favour of oppositePre

Definition at line 126 of file LayerMaterialProperties.h.

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

Public Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ HomogeneousLayerMaterial() [1/4]

◆ HomogeneousLayerMaterial() [2/4]

◆ HomogeneousLayerMaterial() [3/4]

◆ ~HomogeneousLayerMaterial()

◆ HomogeneousLayerMaterial() [4/4]

Member Function Documentation

◆ alongPostFactor()

◆ alongPreFactor()

◆ binUtility()

◆ clone()

◆ dump() [1/2]

◆ dump() [2/2]

◆ elementTable()

◆ factor()

◆ fullMaterial()

◆ material()

◆ operator*=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ oppositePostFactor()

◆ oppositePreFactor()

◆ updateBinning()

◆ updateElementTable()

Friends And Related Function Documentation

◆ ::HomogeneousLayerMaterialCnv_p1

Member Data Documentation

◆ m_fullMaterial

◆ m_splitFactor