ViennaSHE 1.3.0
Free open-source semiconductor device simulator using spherical harmonics expansions techniques.
viennashe::models::const_rate Struct Reference

A simple constant rate. More...

#include <reaction_rates.hpp>

Inheritance diagram for viennashe::models::const_rate:
viennashe::models::rate_base

Public Types

typedef rate_base::value_type value_type
 
- Public Types inherited from viennashe::models::rate_base
typedef double value_type
 

Public Member Functions

 const_rate (value_type rate)
 
 ~const_rate ()
 
virtual value_type value () const
 
virtual rate_baseclone () const
 
- Public Member Functions inherited from viennashe::models::rate_base
virtual ~rate_base ()
 
virtual value_type value () const =0
 
virtual rate_baseclone () const =0
 
virtual value_type operator() () const
 

Detailed Description

A simple constant rate.

Definition at line 54 of file reaction_rates.hpp.

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ const_rate()

viennashe::models::const_rate::const_rate ( value_type  rate)
inline

Definition at line 58 of file reaction_rates.hpp.

◆ ~const_rate()

viennashe::models::const_rate::~const_rate ( )
inline

Definition at line 59 of file reaction_rates.hpp.

Member Function Documentation

◆ clone()

virtual rate_base * viennashe::models::const_rate::clone ( ) const
inlinevirtual

Generates a clone of itself (deep copy; uses new). The caller takes ownership

Returns
A pointer to a deep copy of itself

Implements viennashe::models::rate_base.

Definition at line 63 of file reaction_rates.hpp.

◆ value()

virtual value_type viennashe::models::const_rate::value ( ) const
inlinevirtual

The main functor interface

Returns
The rate in 1/s

Implements viennashe::models::rate_base.

Definition at line 61 of file reaction_rates.hpp.


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