antioch-0.4.0
List of all members | Public Member Functions | Private Attributes
Antioch::LindemannFalloff< CoeffType > Class Template Reference

Simplest falloff model ( $F = 1$) More...

#include <lindemann_falloff.h>

Public Member Functions

 LindemannFalloff (const unsigned int nspec)
 
 ~LindemannFalloff ()
 
template<typename StateType >
StateType value (const StateType &T, const StateType &M, const StateType &k0, const StateType &kinf) const
 
template<typename StateType >
StateType operator() (const StateType &T, const StateType &M, const StateType &k0, const StateType &kinf) const
 
template<typename StateType , typename VectorStateType >
void F_and_derivatives (const StateType &T, const StateType &M, const StateType &k0, const StateType &dk0_dT, const StateType &kinf, const StateType &dkinf_dT, StateType &F, StateType &dF_dT, VectorStateType &dF_dX) const
 

Private Attributes

unsigned int n_spec
 

Detailed Description

template<typename CoeffType = double>
class Antioch::LindemannFalloff< CoeffType >

Simplest falloff model ( $F = 1$)

The Lindemann model is the simplest falloff model:

\[ F = 1 \]

From which we derive:

\[ \begin{split} \frac{\partial F}{\partial T} & = 0\\[10pt] \frac{\partial F}{\partial c_i} & = 0 \end{split} \]

Definition at line 52 of file lindemann_falloff.h.

Constructor & Destructor Documentation

template<typename CoeffType >
Antioch::LindemannFalloff< CoeffType >::LindemannFalloff ( const unsigned int  nspec)
inline

Definition at line 135 of file lindemann_falloff.h.

135  :n_spec(nspec)
136  {
137  return;
138  }
template<typename CoeffType >
Antioch::LindemannFalloff< CoeffType >::~LindemannFalloff ( )
inline

Definition at line 142 of file lindemann_falloff.h.

143  {
144  return;
145  }

Member Function Documentation

template<typename CoeffType >
template<typename StateType , typename VectorStateType >
void Antioch::LindemannFalloff< CoeffType >::F_and_derivatives ( const StateType &  T,
const StateType &  M,
const StateType &  k0,
const StateType &  dk0_dT,
const StateType &  kinf,
const StateType &  dkinf_dT,
StateType &  F,
StateType &  dF_dT,
VectorStateType &  dF_dX 
) const
inline

Definition at line 113 of file lindemann_falloff.h.

References antioch_assert_equal_to, Antioch::constant_clone(), and Antioch::set_zero().

122  {
123  //all derived are 0
124  Antioch::set_zero(dF_dT);
125  antioch_assert_equal_to(dF_dX.size(),n_spec);
126  Antioch::set_zero(dF_dX);
127  // F = 1
128  F = Antioch::constant_clone(T,1);
129 
130  return;
131  }
#define antioch_assert_equal_to(expr1, expr2)
Scalar F(const Scalar &x)
_Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > constant_clone(const _Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &ex, const Scalar &value)
Definition: eigen_utils.h:181
void set_zero(_Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &a)
Definition: eigen_utils.h:217
template<typename CoeffType >
template<typename StateType >
StateType Antioch::LindemannFalloff< CoeffType >::operator() ( const StateType &  T,
const StateType &  M,
const StateType &  k0,
const StateType &  kinf 
) const
inline

Definition at line 89 of file lindemann_falloff.h.

References Antioch::constant_clone().

93  {
94  return Antioch::constant_clone(T, 1);
95  }
_Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > constant_clone(const _Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &ex, const Scalar &value)
Definition: eigen_utils.h:181
template<typename CoeffType >
template<typename StateType >
StateType Antioch::LindemannFalloff< CoeffType >::value ( const StateType &  T,
const StateType &  M,
const StateType &  k0,
const StateType &  kinf 
) const
inline

Definition at line 101 of file lindemann_falloff.h.

References Antioch::constant_clone().

105  {
106  return Antioch::constant_clone(T, 1);
107  }
_Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > constant_clone(const _Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &ex, const Scalar &value)
Definition: eigen_utils.h:181

Member Data Documentation

template<typename CoeffType = double>
unsigned int Antioch::LindemannFalloff< CoeffType >::n_spec
private

Definition at line 81 of file lindemann_falloff.h.


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

Generated on Thu Jul 7 2016 11:09:49 for antioch-0.4.0 by  doxygen 1.8.8