olb::ExpOn1stSpecieRate< T > Class Template Reference

Class implementing exponentially-decreasing reaction rate on the 1st reacting species, that is: nu = [A]/t0, with t0 being the time constant in lattice units. More...

#include <rate.h>

Inheritance diagram for olb::ExpOn1stSpecieRate< T >:

Collaboration diagram for olb::ExpOn1stSpecieRate< T >:

Public Member Functions
	ExpOn1stSpecieRate (int t0)
T	compute (std::vector< T > localFieldValues) override
Public Member Functions inherited from olb::Rate< T >
	Rate (std::vector< T > params)

Additional Inherited Members
Protected Attributes inherited from olb::Rate< T >
std::vector< T >	_params

Detailed Description

template<typename T>
class olb::ExpOn1stSpecieRate< T >

Class implementing exponentially-decreasing reaction rate on the 1st reacting species, that is: nu = [A]/t0, with t0 being the time constant in lattice units.

Definition at line 57 of file rate.h.

Constructor & Destructor Documentation

ExpOn1stSpecieRate()

template<typename T >

olb::ExpOn1stSpecieRate< T >::ExpOn1stSpecieRate

(

int

t0

)

Definition at line 55 of file rate.hh.

  : Rate<T>(std::vector<T>{(T)(t0)})
{}

Member Function Documentation

compute()

template<typename T >

T olb::ExpOn1stSpecieRate< T >::compute ( std::vector< T > localFieldValues )

overridevirtual

Implements olb::Rate< T >.

Definition at line 60 of file rate.hh.

{
  return localFieldValues[0] / this->_params[0];
}

---

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

• src/reaction/rate.h
• src/reaction/rate.hh