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

Compute species diffusivity based on constant Lewis number. More...

#include <constant_lewis_diffusivity.h>

Inheritance diagram for Antioch::ConstantLewisDiffusivity< CoeffType >:
Antioch::SpeciesDiffusionBase< ConstantLewisDiffusivity< CoeffType >, CoeffType >

Public Member Functions

 ConstantLewisDiffusivity (const CoeffType Le)
 
 ConstantLewisDiffusivity (const std::vector< CoeffType > &coeffs)
 
virtual ~ConstantLewisDiffusivity ()
 
void reset_coeffs (std::vector< CoeffType > &coeffs)
 Reset model coefficients. More...
 
 D (const StateType &rho, const StateType &cp, const StateType &k) const ANTIOCH_AUTOFUNC(StateType
 Compute species diffusivity. More...
 

Protected Member Functions

void reset_coeffs_impl (const std::vector< CoeffType > &coeffs)
 

Protected Attributes

CoeffType _Le
 

Friends

class SpeciesDiffusionBase< ConstantLewisDiffusivity< CoeffType >, CoeffType >
 Friend the base class so we can make the implementation protected. More...
 

Detailed Description

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

Compute species diffusivity based on constant Lewis number.

$Le = \frac{k}{\rho c_p D}$

Definition at line 47 of file constant_lewis_diffusivity.h.

Constructor & Destructor Documentation

template<typename CoeffType >
Antioch::ConstantLewisDiffusivity< CoeffType >::ConstantLewisDiffusivity ( const CoeffType  Le)

Definition at line 72 of file constant_lewis_diffusivity.h.

73  : SpeciesDiffusionBase<ConstantLewisDiffusivity<CoeffType>,CoeffType>(),
74  _Le(Le)
75  {}
template<typename CoeffType >
Antioch::ConstantLewisDiffusivity< CoeffType >::ConstantLewisDiffusivity ( const std::vector< CoeffType > &  coeffs)

Definition at line 78 of file constant_lewis_diffusivity.h.

References antioch_assert_equal_to.

79  : SpeciesDiffusionBase<ConstantLewisDiffusivity<CoeffType>,CoeffType>(),
80  _Le(coeffs[0])
81  { antioch_assert_equal_to( coeffs.size(), 1 ); }
#define antioch_assert_equal_to(expr1, expr2)
template<typename CoeffType = double>
virtual Antioch::ConstantLewisDiffusivity< CoeffType >::~ConstantLewisDiffusivity ( )
inlinevirtual

Definition at line 55 of file constant_lewis_diffusivity.h.

55 {}

Member Function Documentation

Antioch::SpeciesDiffusionBase< ConstantLewisDiffusivity< CoeffType > , CoeffType >::D ( const StateType &  rho,
const StateType &  cp,
const StateType &  k 
) const
inherited

Compute species diffusivity.

Referenced by tester().

void Antioch::SpeciesDiffusionBase< ConstantLewisDiffusivity< CoeffType > , CoeffType >::reset_coeffs ( std::vector< CoeffType > &  coeffs)
inherited

Reset model coefficients.

template<typename CoeffType >
void Antioch::ConstantLewisDiffusivity< CoeffType >::reset_coeffs_impl ( const std::vector< CoeffType > &  coeffs)
protected

Definition at line 84 of file constant_lewis_diffusivity.h.

References antioch_assert_equal_to.

85  {
86  antioch_assert_equal_to( coeffs.size(), 1 );
87  _Le = coeffs[0];
88  }
#define antioch_assert_equal_to(expr1, expr2)

Friends And Related Function Documentation

template<typename CoeffType = double>
friend class SpeciesDiffusionBase< ConstantLewisDiffusivity< CoeffType >, CoeffType >
friend

Friend the base class so we can make the implementation protected.

Definition at line 58 of file constant_lewis_diffusivity.h.

Member Data Documentation

template<typename CoeffType = double>
CoeffType Antioch::ConstantLewisDiffusivity< CoeffType >::_Le
protected

Definition at line 61 of file constant_lewis_diffusivity.h.


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

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