GRINS::CanteraThermodynamics Class Reference

Wrapper class for evaluating thermo properties using Cantera. More...

#include <cantera_thermo.h>

Collaboration diagram for GRINS::CanteraThermodynamics:

Public Member Functions
	CanteraThermodynamics (CanteraMixture &mixture)
	~CanteraThermodynamics ()
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 (const libMesh::Real &T, unsigned int species)

Protected Attributes
CanteraMixture &	_cantera_mixture
Cantera::IdealGasMix &	_cantera_gas

Private Member Functions
	CanteraThermodynamics ()

Detailed Description

Wrapper class for evaluating thermo 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 61 of file cantera_thermo.h.

Constructor & Destructor Documentation

GRINS::CanteraThermodynamics::CanteraThermodynamics

(

CanteraMixture &

mixture

)

Definition at line 43 of file cantera_thermo.C.

    : _cantera_mixture(mixture),
      _cantera_gas(mixture.get_chemistry())
  {}

GRINS::CanteraThermodynamics::~CanteraThermodynamics ( )

inline

Definition at line 66 of file cantera_thermo.h.

{};

GRINS::CanteraThermodynamics::CanteraThermodynamics ( )

private

Member Function Documentation

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

Todo:

Need to make sure this will work in a threaded environment. Not sure if we will get thread lock here or not.

Definition at line 48 of file cantera_thermo.C.

References _cantera_gas.

Referenced by GRINS::CanteraEvaluator::cp().

  {
    libmesh_assert_equal_to( Y.size(), _cantera_gas.nSpecies() );

    libMesh::Real cp = 0.0;

    {
      libMesh::Threads::spin_mutex::scoped_lock lock(cantera_mutex);

      try
        {
          _cantera_gas.setState_TPY( T, P, &Y[0] );

          cp = _cantera_gas.cp_mass();
        }
      catch(Cantera::CanteraError)
        {
          Cantera::showErrors(std::cerr);
          libmesh_error();
        }

    }

    return cp;
  }

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

Todo:

Need to make sure this will work in a threaded environment. Not sure if we will get thread lock here or not.

Definition at line 78 of file cantera_thermo.C.

References _cantera_gas.

Referenced by GRINS::CanteraEvaluator::cv().

  {
    libmesh_assert_equal_to( Y.size(), _cantera_gas.nSpecies() );

    libMesh::Real cv = 0.0;

    {
      libMesh::Threads::spin_mutex::scoped_lock lock(cantera_mutex);

      try
        {
          _cantera_gas.setState_TPY( T, P, &Y[0] );

          cv = _cantera_gas.cv_mass();
        }
      catch(Cantera::CanteraError)
        {
          Cantera::showErrors(std::cerr);
          libmesh_error();
        }

    }

    return cv;
  }

libMesh::Real GRINS::CanteraThermodynamics::h	(	const libMesh::Real &	T,
		unsigned int	species
	)

Definition at line 108 of file cantera_thermo.C.

References _cantera_gas, _cantera_mixture, and GRINS::CanteraMixture::R().

Referenced by GRINS::CanteraEvaluator::h_s().

  {
    std::vector<libMesh::Real> h_RT( _cantera_gas.nSpecies(), 0.0 );

    try
      {
        _cantera_gas.setTemperature( T );

        _cantera_gas.getEnthalpy_RT( &h_RT[0] );
      }
    catch(Cantera::CanteraError)
      {
        Cantera::showErrors(std::cerr);
        libmesh_error();
      }

    return h_RT[species]*_cantera_mixture.R(species)*T;
  }

Member Data Documentation

Cantera::IdealGasMix& GRINS::CanteraThermodynamics::_cantera_gas

protected

Definition at line 78 of file cantera_thermo.h.

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

CanteraMixture& GRINS::CanteraThermodynamics::_cantera_mixture

protected

Definition at line 76 of file cantera_thermo.h.

Referenced by h().

---

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

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