GRINS::CanteraEvaluator Class Reference

Wrapper class for evaluating thermochemistry and transport properties using Cantera. More...

#include <cantera_evaluator.h>

Collaboration diagram for GRINS::CanteraEvaluator:

Public Member Functions
	CanteraEvaluator (CanteraMixture &mixture)
	~CanteraEvaluator ()
libMesh::Real	M (unsigned int species) const
libMesh::Real	M_mix (const std::vector< libMesh::Real > &mass_fractions) const
libMesh::Real	R (unsigned int species) const
libMesh::Real	R_mix (const std::vector< libMesh::Real > &mass_fractions) const
libMesh::Real	X (unsigned int species, libMesh::Real M, libMesh::Real mass_fraction) const
void	X (libMesh::Real M, const std::vector< libMesh::Real > &mass_fractions, std::vector< libMesh::Real > &mole_fractions) const
unsigned int	species_index (const std::string &species_name) const
std::string	species_name (unsigned int species_index) const
libMesh::Real	cp (const libMesh::Real &T, const libMesh::Real P, const std::vector< libMesh::Real > &Y)
libMesh::Real	cv (const libMesh::Real &T, const libMesh::Real P, const std::vector< libMesh::Real > &Y)
libMesh::Real	h_s (const libMesh::Real &T, unsigned int species)
libMesh::Real	mu (const libMesh::Real &T, const libMesh::Real P, const std::vector< libMesh::Real > &Y)
libMesh::Real	k (const libMesh::Real &T, const libMesh::Real P, const std::vector< libMesh::Real > &Y)
void	mu_and_k (const libMesh::Real &T, const libMesh::Real P, const std::vector< libMesh::Real > &Y, libMesh::Real &mu, libMesh::Real &k)
void	mu_and_k_and_D (const libMesh::Real T, const libMesh::Real rho, const libMesh::Real cp, const std::vector< libMesh::Real > &Y, libMesh::Real &mu, libMesh::Real &k, std::vector< libMesh::Real > &D)
void	omega_dot (const libMesh::Real &T, libMesh::Real rho, const std::vector< libMesh::Real > mass_fractions, std::vector< libMesh::Real > &omega_dot)

Protected Attributes
CanteraMixture &	_chem
CanteraThermodynamics	_thermo
CanteraTransport	_transport
CanteraKinetics	_kinetics

Private Member Functions
	CanteraEvaluator ()

Detailed Description

Wrapper class for evaluating thermochemistry and transport properties using Cantera.

This class is expected to be constructed after threads have been forked and will only live during the lifetime of the thread. Note that this documentation will always be built regardless if Cantera is included in the GRINS build or not. Check configure output to confirm that Cantera was included in the build if you wish to use it.

Definition at line 48 of file cantera_evaluator.h.

Constructor & Destructor Documentation

GRINS::CanteraEvaluator::CanteraEvaluator

(

CanteraMixture &

mixture

)

Definition at line 39 of file cantera_evaluator.C.

    : _chem( mixture ),
      _thermo( CanteraThermodynamics(mixture) ),
      _transport( CanteraTransport(mixture) ),
      _kinetics( CanteraKinetics(mixture) )
  {
    return;
  }

GRINS::CanteraEvaluator::~CanteraEvaluator ( )

inline

Definition at line 53 of file cantera_evaluator.h.

{};

GRINS::CanteraEvaluator::CanteraEvaluator ( )

private

Member Function Documentation

libMesh::Real GRINS::CanteraEvaluator::cp ( const libMesh::Real &  T, const libMesh::Real  P, const std::vector< libMesh::Real > &  Y  )

inline

Definition at line 168 of file cantera_evaluator.h.

References _thermo, and GRINS::CanteraThermodynamics::cp().

  {
    return _thermo.cp(T,P,Y);
  }

libMesh::Real GRINS::CanteraEvaluator::cv ( const libMesh::Real &  T, const libMesh::Real  P, const std::vector< libMesh::Real > &  Y  )

inline

Definition at line 176 of file cantera_evaluator.h.

References _thermo, and GRINS::CanteraThermodynamics::cv().

  {
    return _thermo.cv(T,P,Y);
  }

libMesh::Real GRINS::CanteraEvaluator::h_s ( const libMesh::Real &  T, unsigned int  species  )

inline

Definition at line 184 of file cantera_evaluator.h.

References _thermo, and GRINS::CanteraThermodynamics::h().

  {
    return _thermo.h(T,species);
  }

libMesh::Real GRINS::CanteraEvaluator::k ( const libMesh::Real &  T, const libMesh::Real  P, const std::vector< libMesh::Real > &  Y  )

inline

Definition at line 198 of file cantera_evaluator.h.

References _transport, and GRINS::CanteraTransport::k().

  {
    return _transport.k(T,P,Y);
  }

libMesh::Real GRINS::CanteraEvaluator::M ( unsigned int  species ) const

inline

Definition at line 118 of file cantera_evaluator.h.

References _chem, and GRINS::CanteraMixture::M().

  {
    return _chem.M(species);
  }

libMesh::Real GRINS::CanteraEvaluator::M_mix ( const std::vector< libMesh::Real > &  mass_fractions ) const

inline

Definition at line 124 of file cantera_evaluator.h.

References _chem, and GRINS::CanteraMixture::M_mix().

  {
    return _chem.M_mix(mass_fractions);
  }

libMesh::Real GRINS::CanteraEvaluator::mu ( const libMesh::Real &  T, const libMesh::Real  P, const std::vector< libMesh::Real > &  Y  )

inline

Definition at line 190 of file cantera_evaluator.h.

References _transport, and GRINS::CanteraTransport::mu().

  {
    return _transport.mu(T,P,Y);
  }

void GRINS::CanteraEvaluator::mu_and_k ( const libMesh::Real &  T, const libMesh::Real  P, const std::vector< libMesh::Real > &  Y, libMesh::Real &  mu, libMesh::Real &  k  )

inline

Definition at line 206 of file cantera_evaluator.h.

References _transport, GRINS::CanteraTransport::k(), and GRINS::CanteraTransport::mu().

  {
    mu = _transport.mu(T,P,Y);
    k = _transport.k(T,P,Y);
  }

void GRINS::CanteraEvaluator::mu_and_k_and_D ( const libMesh::Real  T, const libMesh::Real  rho, const libMesh::Real  cp, const std::vector< libMesh::Real > &  Y, libMesh::Real &  mu, libMesh::Real &  k, std::vector< libMesh::Real > &  D  )

inline

Definition at line 216 of file cantera_evaluator.h.

References _transport, and GRINS::CanteraTransport::mu_and_k_and_D().

  {
    _transport.mu_and_k_and_D( T, rho, cp, Y, mu, k, D );
  }

void GRINS::CanteraEvaluator::omega_dot ( const libMesh::Real &  T, libMesh::Real  rho, const std::vector< libMesh::Real >  mass_fractions, std::vector< libMesh::Real > &  omega_dot  )

inline

Definition at line 227 of file cantera_evaluator.h.

References _kinetics, and GRINS::CanteraKinetics::omega_dot().

  {
    _kinetics.omega_dot(T,rho,mass_fractions,omega_dot);
  }

libMesh::Real GRINS::CanteraEvaluator::R ( unsigned int  species ) const

inline

Definition at line 130 of file cantera_evaluator.h.

References _chem, and GRINS::CanteraMixture::R().

  {
    return _chem.R(species);
  }

libMesh::Real GRINS::CanteraEvaluator::R_mix ( const std::vector< libMesh::Real > &  mass_fractions ) const

inline

Definition at line 136 of file cantera_evaluator.h.

References _chem, and GRINS::CanteraMixture::R_mix().

  {
    return _chem.R_mix(mass_fractions);
  }

unsigned int GRINS::CanteraEvaluator::species_index ( const std::string &  species_name ) const

inline

Definition at line 156 of file cantera_evaluator.h.

References _chem, and GRINS::CanteraMixture::species_index().

  {
    return _chem.species_index(species_name);
  }

std::string GRINS::CanteraEvaluator::species_name ( unsigned int  species_index ) const

inline

Definition at line 162 of file cantera_evaluator.h.

References _chem, and GRINS::CanteraMixture::species_name().

  {
    return _chem.species_name(species_index);
  }

libMesh::Real GRINS::CanteraEvaluator::X ( unsigned int  species, libMesh::Real  M, libMesh::Real  mass_fraction  ) const

inline

Definition at line 142 of file cantera_evaluator.h.

References _chem, and GRINS::CanteraMixture::X().

  {
    return _chem.X(species,M,mass_fraction);
  }

void GRINS::CanteraEvaluator::X ( libMesh::Real  M, const std::vector< libMesh::Real > &  mass_fractions, std::vector< libMesh::Real > &  mole_fractions  ) const

inline

Definition at line 148 of file cantera_evaluator.h.

References _chem, and GRINS::CanteraMixture::X().

  {
    _chem.X(M,mass_fractions,mole_fractions);
    return;
  }

Member Data Documentation

CanteraMixture& GRINS::CanteraEvaluator::_chem

protected

Definition at line 102 of file cantera_evaluator.h.

Referenced by M(), M_mix(), R(), R_mix(), species_index(), species_name(), and X().

CanteraKinetics GRINS::CanteraEvaluator::_kinetics

protected

Definition at line 108 of file cantera_evaluator.h.

Referenced by omega_dot().

CanteraThermodynamics GRINS::CanteraEvaluator::_thermo

protected

Definition at line 104 of file cantera_evaluator.h.

Referenced by cp(), cv(), and h_s().

CanteraTransport GRINS::CanteraEvaluator::_transport

protected

Definition at line 106 of file cantera_evaluator.h.

Referenced by k(), mu(), mu_and_k(), and mu_and_k_and_D().

---

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

• src/properties/include/grins/cantera_evaluator.h
• src/properties/src/cantera_evaluator.C