PAPRECA hybrid off-lattice kMC/MD simulator  2.0.0 (17 September 2024)
PAPRECA::MonoatomicDesorption Class Reference

child of PAPRECA::Event dedicated to monoatomic desorption events (i.e., where a single atom is ejected from the system). More...

#include <event.h>

Inheritance diagram for PAPRECA::MonoatomicDesorption:
Collaboration diagram for PAPRECA::MonoatomicDesorption:

Public Member Functions

 MonoatomicDesorption (const double &rate_in, const LAMMPS_NS::tagint &parent_id_in, const int &parent_type_in, PredefinedMonoatomicDesorption *des_template_in)
 
 ~MonoatomicDesorption ()
 
const LAMMPS_NS::tagint & getParentId () const
 
const int & getParentType () const
 
PredefinedMonoatomicDesorptiongetMonoDesTemplate ()
 
- Public Member Functions inherited from PAPRECA::Event
 Event ()
 
 Event (const double &rate_in, const std::string &type_in)
 
virtual ~Event ()
 
void assignRate (const double &rate_in)
 
void assignType (const std::string &type_in)
 
const double & getRate () const
 
void setRate (const double &rate_in)
 
const std::string & getType () const
 

Protected Attributes

LAMMPS_NS::tagint parent_id = -1
 
int parent_type = -2
 
- Protected Attributes inherited from PAPRECA::Event
double rate
 
std::string type
 

Private Attributes

PredefinedMonoatomicDesorptionmonodes_template = NULL
 

Additional Inherited Members

- Static Public Member Functions inherited from PAPRECA::Event
static void fillRatesArr (double *event_rates, const std::vector< Event * > &events)
 
static void fillRatesVec (std::vector< double > &event_rates, const std::vector< Event * > &events)
 
static std::vector< double > getRatesVec (const std::vector< Event * > &events)
 
static double getSumOfRates (const std::vector< Event * > &events)
 
static void deleteAndClearLocalEvents (LAMMPS_NS::LAMMPS *lmp, std::vector< Event * > &events_local)
 

Detailed Description

child of PAPRECA::Event dedicated to monoatomic desorption events (i.e., where a single atom is ejected from the system).

Constructor & Destructor Documentation

◆ MonoatomicDesorption()

PAPRECA::MonoatomicDesorption::MonoatomicDesorption ( const double &  rate_in,
const LAMMPS_NS::tagint &  parent_id_in,
const int &  parent_type_in,
PredefinedMonoatomicDesorption des_template_in 
)

◆ ~MonoatomicDesorption()

PAPRECA::MonoatomicDesorption::~MonoatomicDesorption ( )

Member Function Documentation

◆ getMonoDesTemplate()

PredefinedMonoatomicDesorption * PAPRECA::MonoatomicDesorption::getMonoDesTemplate ( )

◆ getParentId()

const int & PAPRECA::MonoatomicDesorption::getParentId ( ) const

◆ getParentType()

const int & PAPRECA::MonoatomicDesorption::getParentType ( ) const

Member Data Documentation

◆ monodes_template

PredefinedMonoatomicDesorption* PAPRECA::MonoatomicDesorption::monodes_template = NULL
private

◆ parent_id

LAMMPS_NS::tagint PAPRECA::MonoatomicDesorption::parent_id = -1
protected

◆ parent_type

int PAPRECA::MonoatomicDesorption::parent_type = -2
protected

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