speciesThermoTypes.h

Go to the documentation of this file.

/**
 *  @file speciesThermoTypes.h
 *       Contains const definitions for types of species 
 *       reference-state thermodynamics managers (see \ref spthermo)
 */
/*
 * $Author: hkmoffa $
 * $Revision: 306 $
 * $Date: 2009-12-09 12:29:23 -0500 (Wed, 09 Dec 2009) $
 */

// Copyright 2001  California Institute of Technology


#ifndef SPECIES_THERMO_TYPES_H
#define SPECIES_THERMO_TYPES_H

//! Constant Cp
#define CONSTANT_CP 1

//! Polynomial
#define POLYNOMIAL_4 2

//! Two regions of 7 coefficient NASA Polynomials
//! This is implemented in the class NasaPoly2 in NasaPoly2.h
#define NASA 4

//! Two regions of 7 coefficient NASA Polynomials
//! This is implemented in the class NasaPoly2 in NasaPoly2.h
#define NASA2 4

//! Two regions of Shomate Polynomials.
#define SHOMATE 8

//! Two regions of Shomate Polynomials.
#define SHOMATE2 8

//! Tiger Polynomials. Not implemented here.
#define TIGER 16

//! Constant Cp thermo.
//! This is implemented in ConstCpPoly in constCpPoly.h for one species.
//! If the whole phase is constcp, SimpleThermo in SimpleThermo.h 
//! implements this for the whole phase.
#define SIMPLE 32

//! piecewise interpolation of mu0. 
//! This is implemented in Mu0Poly in Mu0Poly.h
#define MU0_INTERP 64

//! one region of Shomate Polynomials used in NIST database
//! This is implemented in the NIST database.
//! This is implemented in ShomatePoly in ShomatePoly.h
#define SHOMATE1 128

//! 7 coefficient NASA Polynomials
//! This is implemented in the class NasaPoly1 in NasaPoly1.h
#define NASA1  256

//! 9 coefficient NASA Polynomials
//! This is implemented in the class Nasa9Poly1 in Nasa9Poly1.h
#define NASA9  512

//! 9 coefficient NASA Polynomials in multiple temperature regions
//! This is implemented in the class Nasa9PolyMultiTempRegion in Nasa9Poly1MultiTempRegion
#define NASA9MULTITEMP  513

//! Surface Adsorbate Model for a species on a surface. 
//! This is implemented in the class Adsorbate.
#define ADSORBATE 1024

//! Type of reference state thermo which is a wrapper around a pressure dependent
//! standard state object. Basically, the reference state pressure isn't special.
//! A general object is called with the pressure set at the reference state.
#define PDSS_TYPE 37

#include "ct_defs.h"

#include "stringUtils.h"
#include "global.h"

namespace Cantera {

  //! Error for unknown thermo parameterization
  struct UnknownThermoParam {
    //! Constructor
    /*!
     * @param thermotype  Integer specifying the thermo parameterization
     *
     * @todo Is this used?
     */
    UnknownThermoParam(int thermotype) {
      writelog(std::string("\n ### ERROR ### \n") + 
               "Unknown species thermo parameterization ("
               + int2str(thermotype) + ")\n\n");
    }
  };


  //! holds parameterization-dependent index information
  /*!
   * These are all integers.
   * @todo Is this used?
   */
  struct ThermoIndexData {
    //! param
    int param;
    //! number of coefficients
    int nCoefficients;
    //! coefficient for Tmin
    int Tmin_coeff;
    //! coefficient for Tmax
    int Tmax_coeff;
    //! reference pressure coefficient
    int Pref_coeff;
  };

}

#endif