CellOriginBuilder Class Reference

#include <phononBuilder.h>

Inheritance diagram for CellOriginBuilder:

Collaboration diagram for CellOriginBuilder:

Public Member Functions
	CellOriginBuilder ()=default
Phonon	operator() (double t_eq) noexcept override
bool	hasPhonons () const noexcept override
void	addCellPhonons (Cell *cell, std::size_t num_phonons) noexcept
Public Member Functions inherited from PhononBuilder
constexpr	PhononBuilder () noexcept=default
virtual	~PhononBuilder ()=default
constexpr	PhononBuilder (const PhononBuilder &)=default
constexpr	PhononBuilder (PhononBuilder &&) noexcept=default
PhononBuilder &	operator= (const PhononBuilder &)=default
PhononBuilder &	operator= (PhononBuilder &&)=default
std::size_t	totalPhonons () const noexcept

Additional Inherited Members
Protected Attributes inherited from PhononBuilder
std::size_t	total_phonons_ { 0 }

Constructor & Destructor Documentation

CellOriginBuilder()

CellOriginBuilder::CellOriginBuilder ( )

default

Member Function Documentation

addCellPhonons()

void CellOriginBuilder::addCellPhonons ( Cell *  cell, std::size_t  num_phonons  )

noexcept

Here is the caller graph for this function:

hasPhonons()

bool CellOriginBuilder::hasPhonons ( ) const

inlineoverridevirtualnoexcept

Implements PhononBuilder.

operator()()

Phonon CellOriginBuilder::operator() ( double  t_eq )

overridevirtualnoexcept

Caller must verify the phonon builder has phonons to build by using the hasPhonons() function before calling this function.

Parameters

t_eq	- Equilibrium temperature of the system

Returns

A phonon that is created according to the builder specifications

Implements PhononBuilder.

Here is the call graph for this function:

---

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

• psim/include/psim/phononBuilder.h
• psim/src/phononBuilder.cpp