EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::MaterialComposition Class Reference

#include <acts/blob/sPHENIX/Core/include/Acts/Material/MaterialComposition.hpp>

+ Collaboration diagram for Acts::MaterialComposition:

Public Member Functions

 MaterialComposition ()=default
 Construct an empty composition corresponding to vacuum.
 
 MaterialComposition (std::vector< ElementFraction > elements)
 
 MaterialComposition (MaterialComposition &&)=default
 
 MaterialComposition (const MaterialComposition &)=default
 
 ~MaterialComposition ()=default
 
MaterialCompositionoperator= (MaterialComposition &&)=default
 
MaterialCompositionoperator= (const MaterialComposition &)=default
 
auto begin () const
 
auto end () const
 
 operator bool () const
 Check if the composed material is valid, i.e. it is not vacuum.
 
size_t size () const
 Return the number of elements.
 

Private Attributes

std::vector< ElementFractionm_elements
 

Friends

bool operator== (const MaterialComposition &lhs, const MaterialComposition &rhs)
 

Detailed Description

Material composed from multiple elements with varying factions.

See Also
ElementFraction for details.

Definition at line 91 of file MaterialComposition.hpp.

View newest version in sPHENIX GitHub at line 91 of file MaterialComposition.hpp

Constructor & Destructor Documentation

Acts::MaterialComposition::MaterialComposition ( )
default

Construct an empty composition corresponding to vacuum.

Acts::MaterialComposition::MaterialComposition ( std::vector< ElementFraction elements)
inline

Constructor from element fractions.

Rescales the fractions so they all add up to unity within the accuracy.

Definition at line 98 of file MaterialComposition.hpp.

View newest version in sPHENIX GitHub at line 98 of file MaterialComposition.hpp

References m_elements, and Acts::UnitConstants::u.

Acts::MaterialComposition::MaterialComposition ( MaterialComposition &&  )
default
Acts::MaterialComposition::MaterialComposition ( const MaterialComposition )
default
Acts::MaterialComposition::~MaterialComposition ( )
default

Member Function Documentation

auto Acts::MaterialComposition::begin ( ) const
inline

Definition at line 120 of file MaterialComposition.hpp.

View newest version in sPHENIX GitHub at line 120 of file MaterialComposition.hpp

References m_elements.

auto Acts::MaterialComposition::end ( ) const
inline

Definition at line 121 of file MaterialComposition.hpp.

View newest version in sPHENIX GitHub at line 121 of file MaterialComposition.hpp

References m_elements.

Acts::MaterialComposition::operator bool ( ) const
inline

Check if the composed material is valid, i.e. it is not vacuum.

Definition at line 124 of file MaterialComposition.hpp.

View newest version in sPHENIX GitHub at line 124 of file MaterialComposition.hpp

References m_elements.

MaterialComposition& Acts::MaterialComposition::operator= ( MaterialComposition &&  )
default
MaterialComposition& Acts::MaterialComposition::operator= ( const MaterialComposition )
default
size_t Acts::MaterialComposition::size ( ) const
inline

Return the number of elements.

Definition at line 126 of file MaterialComposition.hpp.

View newest version in sPHENIX GitHub at line 126 of file MaterialComposition.hpp

References m_elements.

Friends And Related Function Documentation

bool operator== ( const MaterialComposition lhs,
const MaterialComposition rhs 
)
friend

Definition at line 131 of file MaterialComposition.hpp.

View newest version in sPHENIX GitHub at line 131 of file MaterialComposition.hpp

Member Data Documentation

std::vector<ElementFraction> Acts::MaterialComposition::m_elements
private

Definition at line 129 of file MaterialComposition.hpp.

View newest version in sPHENIX GitHub at line 129 of file MaterialComposition.hpp

Referenced by begin(), end(), MaterialComposition(), operator bool(), and size().


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