smash::DecayBranch Class Reference

#include <processbranch.h>

DecayBranch is a derivative of ProcessBranch, which is used to represent decay channels.

It contains additional information like the angular momentum.

Definition at line 366 of file processbranch.h.

Inheritance diagram for smash::DecayBranch:

Public Member Functions
	DecayBranch (const DecayType &t, double w)
	Construct decay branch. More...
	DecayBranch (DecayBranch &&rhs)
	The move constructor efficiently moves the particle-type list member. More...
int	angular_momentum () const
const ParticleTypePtrList &	particle_types () const override
unsigned int	particle_number () const override
const DecayType &	type () const
ProcessType	get_type () const override
Public Member Functions inherited from smash::ProcessBranch
	ProcessBranch ()
	Create a ProcessBranch without final states and weight. More...
	ProcessBranch (double w)
	Create a ProcessBranch with with weight but without final states. More...
	ProcessBranch (const ProcessBranch &)=delete
	Copying is disabled. Use std::move or create a new object. More...
virtual	~ProcessBranch ()=default
	Virtual Destructor. More...
void	set_weight (double process_weight)
	Set the weight of the branch. More...
ParticleList	particle_list () const
double	weight () const
double	threshold () const

Private Attributes
const DecayType &	type_
	Decay type (including final-state particles and angular momentum) More...

Additional Inherited Members
Protected Attributes inherited from smash::ProcessBranch
double	branch_weight_
	Weight of the branch, typically a cross section or a branching ratio. More...
double	threshold_ = -1.
	Threshold of the branch. More...
Related Functions inherited from smash::ProcessBranch
template<typename Branch >
double	total_weight (const ProcessBranchList< Branch > &l)

Constructor & Destructor Documentation

DecayBranch() [1/2]

smash::DecayBranch::DecayBranch ( const DecayType &  t, double  w  )

inline

Construct decay branch.

Parameters

[in]	t	DecayType of branch.
[in]	w	Weight of created branch.

Definition at line 373 of file processbranch.h.

: ProcessBranch(w), type_(t) {}

DecayBranch() [2/2]

smash::DecayBranch::DecayBranch ( DecayBranch &&  rhs )

inline

The move constructor efficiently moves the particle-type list member.

Definition at line 375 of file processbranch.h.

      : ProcessBranch(rhs.branch_weight_), type_(rhs.type_) {}

Member Function Documentation

angular_momentum()

int smash::DecayBranch::angular_momentum ( ) const

inline

Returns

the quantized angular momentum of this branch.

Definition at line 378 of file processbranch.h.

{ return type_.angular_momentum(); }

particle_types()

const ParticleTypePtrList& smash::DecayBranch::particle_types ( ) const

inlineoverridevirtual

Returns

the particle types associated with this branch.

Implements smash::ProcessBranch.

Definition at line 379 of file processbranch.h.

                                                             {
    return type_.particle_types();
  }

particle_number()

unsigned int smash::DecayBranch::particle_number ( ) const

inlineoverridevirtual

Returns

the number of particles in the final state.

Implements smash::ProcessBranch.

Definition at line 382 of file processbranch.h.

                                                {
    return type_.particle_number();
  }

type()

const DecayType& smash::DecayBranch::type ( ) const

inline

Returns

the DecayType of the branch.

Definition at line 386 of file processbranch.h.

{ return type_; }

get_type()

ProcessType smash::DecayBranch::get_type ( ) const

inlineoverridevirtual

Returns

"Decay" to the process type.

Implements smash::ProcessBranch.

Definition at line 388 of file processbranch.h.

{ return ProcessType::Decay; }

Member Data Documentation

type_

const DecayType& smash::DecayBranch::type_

private

Decay type (including final-state particles and angular momentum)

Definition at line 392 of file processbranch.h.

---

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

• src/include/smash/processbranch.h