LTPspecies.cpp

Go to the documentation of this file.

/**
 *  @file LTPspecies.cpp
 *     Definitions for the LTPspecies objects and its children, which is the virtual base class
 *     for describing temperature dependence of submodels for transport parameters
 *    (see \ref tranprops and \link Cantera::LTPspecies LTPspecies \endlink) .
 */

// This file is part of Cantera. See License.txt in the top-level directory or
// at http://www.cantera.org/license.txt for license and copyright information.

#include "cantera/transport/LTPspecies.h"
#include "cantera/base/ctml.h"

using namespace std;

namespace Cantera
{
//! Exception thrown if an error is encountered while reading the transport database.
class LTPError : public CanteraError
{
public:
    //! Constructor is a wrapper around CanteraError
    /*!
     *  @param msg    Informative message
     */
    explicit LTPError(const std::string& msg) :
        CanteraError("LTPspecies", "error parsing transport data: " + msg + "\n") {
    }
};

//! Parses the XML element called Arrhenius.
/*!
 * The Arrhenius expression is
 *    \f[
 *         k =  A T^(b) exp (-E_a / RT)
 *    \f]
 *
 * @param node  XML_Node to be read
 * @param A     Output pre-exponential factor. The units are variable.
 * @param b     output temperature power
 * @param E     Output activation energy in units of Kelvin
 */
static void getArrhenius(const XML_Node& node,
                         doublereal& A, doublereal& b, doublereal& E)
{
    // parse the children for the A, b, and E components.
    A = getFloat(node, "A", "toSI");
    b = getFloat(node, "b");
    E = getFloat(node, "E", "actEnergy") / GasConstant;
}

LTPspecies::LTPspecies() :
    m_speciesName("-"),
    m_model(LTP_TD_NOTSET),
    m_property(TP_UNKNOWN),
    m_thermo(0),
    m_mixWeight(1.0)
{
    warn_deprecated("class LTPspecies", "To be removed after Cantera 2.4");
}

LTPspecies* LTPspecies::duplMyselfAsLTPspecies() const
{
    return new LTPspecies(*this);
}

doublereal LTPspecies::getSpeciesTransProp()
{
    return 0.0;
}

bool LTPspecies::checkPositive() const
{
    return (m_coeffs[0] > 0);
}

doublereal LTPspecies::getMixWeight() const
{
    return m_mixWeight;
}

void LTPspecies::adjustCoeffsForComposition()
{
}

LTPspecies_Const::LTPspecies_Const()
{
    m_model = LTP_TD_CONSTANT;
}

void LTPspecies_Const::setupFromXML(const XML_Node& propNode)
{
    double A_k = getFloatCurrent(propNode, "toSI");
    if (A_k > 0.0) {
        setCoeff(A_k);
    } else {
        throw LTPError("negative or zero " + propNode.name());
    }
}

void LTPspecies_Const::setCoeff(double C)
{
    m_coeffs = {C};
}

LTPspecies* LTPspecies_Const::duplMyselfAsLTPspecies() const
{
    return new LTPspecies_Const(*this);
}

doublereal LTPspecies_Const::getSpeciesTransProp()
{
    return m_coeffs[0];
}

LTPspecies_Arrhenius::LTPspecies_Arrhenius()
{
    m_model = LTP_TD_ARRHENIUS;
    m_temp = 0.0;
    m_prop = 0.0;
}

LTPspecies* LTPspecies_Arrhenius::duplMyselfAsLTPspecies() const
{
    return new LTPspecies_Arrhenius(*this);
}

void LTPspecies_Arrhenius::setupFromXML(const XML_Node& propNode)
{
    doublereal A_k, n_k, Tact_k;
    getArrhenius(propNode, A_k, n_k, Tact_k);
    if (A_k <= 0.0) {
        throw LTPError("negative or zero " + propNode.name());
    }
    setCoeffs(A_k, n_k, Tact_k);
}

void LTPspecies_Arrhenius::setCoeffs(double A, double n, double Tact)
{
    m_coeffs = {A, n, Tact, log(A)};
}

doublereal LTPspecies_Arrhenius::getSpeciesTransProp()
{
    doublereal t = m_thermo->temperature();
    //m_coeffs[0] holds A
    //m_coeffs[1] holds n
    //m_coeffs[2] holds Tact
    //m_coeffs[3] holds log(A)
    if (t != m_temp) {
        m_prop = 0;
        m_logProp = 0;
        m_temp = t;
        m_logt = log(m_temp);
        //For viscosity the sign convention on positive activation energy is swithced
        if (m_property == TP_VISCOSITY) {
            m_logProp = m_coeffs[3] + m_coeffs[1] * m_logt + m_coeffs[2] / m_temp;
        } else {
            m_logProp = m_coeffs[3] + m_coeffs[1] * m_logt - m_coeffs[2] / m_temp;
        }
        m_prop = exp(m_logProp);
    }
    return m_prop;
}

LTPspecies_Poly::LTPspecies_Poly() :
    m_temp(-1.0),
    m_prop(0.0)
{
    m_model = LTP_TD_POLY;
}

LTPspecies* LTPspecies_Poly::duplMyselfAsLTPspecies() const
{
    return new LTPspecies_Poly(*this);
}

void LTPspecies_Poly::setupFromXML(const XML_Node& propNode)
{
    vector_fp coeffs;
    getFloatArray(propNode, coeffs, "true", "toSI");
    setCoeffs(coeffs.size(), coeffs.data());
}

void LTPspecies_Poly::setCoeffs(size_t N, const double* coeffs)
{
    m_coeffs.assign(coeffs, coeffs+N);
}

doublereal LTPspecies_Poly::getSpeciesTransProp()
{
    doublereal t = m_thermo->temperature();
    if (t != m_temp) {
        m_prop = 0.0;
        m_temp = t;
        double tempN = 1.0;
        for (int i = 0; i < (int) m_coeffs.size() ; i++) {
            m_prop += m_coeffs[i] * tempN;
            tempN *= m_temp;
        }
    }
    return m_prop;
}

LTPspecies_ExpT::LTPspecies_ExpT() :
    m_temp(-1.0),
    m_prop(0.0)
{
    m_model = LTP_TD_EXPT;
}

LTPspecies* LTPspecies_ExpT::duplMyselfAsLTPspecies() const
{
    return new LTPspecies_ExpT(*this);
}

void LTPspecies_ExpT::setupFromXML(const XML_Node& propNode)
{
    vector_fp coeffs;
    getFloatArray(propNode, coeffs, "true", "toSI");
    setCoeffs(coeffs.size(), coeffs.data());
}

void LTPspecies_ExpT::setCoeffs(size_t N, const double* coeffs)
{
    m_coeffs.assign(coeffs, coeffs+N);
}

doublereal LTPspecies_ExpT::getSpeciesTransProp()
{
    doublereal t = m_thermo->temperature();
    if (t != m_temp) {
        m_temp=t;
        m_prop = m_coeffs[0];
        doublereal tempN = 1.0;
        doublereal tmp = 0.0;
        for (int i = 1; i < (int) m_coeffs.size() ; i++) {
            tempN *= m_temp;
            tmp += m_coeffs[i] * tempN;
        }
        m_prop *= exp(tmp);
    }
    return m_prop;
}

}