GRINS::CanteraTransport Class Reference

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

#include <cantera_transport.h>

Public Member Functions
	CanteraTransport (CanteraMixture &mixture)
	~CanteraTransport ()
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_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)

Protected Attributes
Cantera::IdealGasMix &	_cantera_gas
Cantera::Transport &	_cantera_transport

Private Member Functions
	CanteraTransport ()

Detailed Description

Wrapper class for evaluating 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 63 of file cantera_transport.h.

Constructor & Destructor Documentation

GRINS::CanteraTransport::CanteraTransport

(

CanteraMixture &

mixture

)

Definition at line 49 of file cantera_transport.C.

    : _cantera_gas( mixture.get_chemistry() ),
      _cantera_transport( mixture.get_transport() )
  {}

GRINS::CanteraTransport::~CanteraTransport ( )

inline

Definition at line 69 of file cantera_transport.h.

{};

GRINS::CanteraTransport::CanteraTransport ( )

private

Member Function Documentation

libMesh::Real GRINS::CanteraTransport::k	(	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 83 of file cantera_transport.C.

References _cantera_gas, and _cantera_transport.

Referenced by GRINS::CanteraEvaluator::k(), and GRINS::CanteraEvaluator::mu_and_k().

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

    libMesh::Real k = 0.0;

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

      try
        {
          _cantera_gas.setState_TPY(T, P, &Y[0]);
          k =  _cantera_transport.thermalConductivity();
        }
      catch(Cantera::CanteraError)
        {
          Cantera::showErrors(std::cerr);
          libmesh_error();
        }

    }

    return k;
  }

libMesh::Real GRINS::CanteraTransport::mu	(	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 54 of file cantera_transport.C.

References _cantera_gas, and _cantera_transport.

Referenced by GRINS::CanteraEvaluator::mu(), and GRINS::CanteraEvaluator::mu_and_k().

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

    libMesh::Real mu = 0.0;

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

      try
        {
          _cantera_gas.setState_TPY(T, P, &Y[0]);
          mu =  _cantera_transport.viscosity();
        }
      catch(Cantera::CanteraError)
        {
          Cantera::showErrors(std::cerr);
          libmesh_error();
        }

    }

    return mu;
  }

void GRINS::CanteraTransport::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
	)

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 112 of file cantera_transport.C.

References _cantera_gas, and _cantera_transport.

Referenced by main(), and GRINS::CanteraEvaluator::mu_and_k_and_D().

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

    try
      {
        _cantera_gas.setState_TRY(T, rho, &Y[0]);

        mu =  _cantera_transport.viscosity();
        k =  _cantera_transport.thermalConductivity();
        _cantera_transport.getMixDiffCoeffsMass(&D[0]);
      }
    catch(Cantera::CanteraError)
      {
        Cantera::showErrors(std::cerr);
        libmesh_error();
      }
  }

Member Data Documentation

Cantera::IdealGasMix& GRINS::CanteraTransport::_cantera_gas

protected

Definition at line 84 of file cantera_transport.h.

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

Cantera::Transport& GRINS::CanteraTransport::_cantera_transport

protected

Definition at line 86 of file cantera_transport.h.

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

---

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

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