cttrans.h

Go to the documentation of this file.

/**
 *  CTTRANS - Generated CLib %Cantera interface library.
 *
 *  @file cttrans.h
 *
 *  Generated CLib API for %Cantera's Transport class.
 *
 *  This library of functions is designed to encapsulate %Cantera functionality
 *  and make it available for use in languages and applications other than C++.
 *  A set of library functions is provided that are declared "extern C". All
 *  %Cantera objects are stored and referenced by integers - no pointers are
 *  passed to or from the calling application.
 *
 *  This file was generated by sourcegen. It will be re-generated by the
 *  %Cantera build process. Do not manually edit.
 *
 *  @warning  This library is an experimental part of the %Cantera API and
 *      may be changed without notice.
 */
 
// This file is part of Cantera. See License.txt in the top-level directory or
// at https://cantera.org/license.txt for license and copyright information.
 
#ifndef CTTRANS_H
#define CTTRANS_H
 
#include <stdint.h>  // for 32-bit int32_t / 64-bit int64_t
 
#ifdef __cplusplus
extern "C" {
#endif
 
    /**
     *  @defgroup CAPIcttrans cttrans Library
     *  Generated CLib API for %Cantera's Transport class.
     *
     *  @warning  This library is an experimental part of the %Cantera API and
     *      may be changed or removed without notice.
     *
     *  @ingroup CAPIindex
     */
 
    /**
     *  @addtogroup CAPIcttrans
     *  @{
     */
 
    /**
     *  Identifies the model represented by this Transport object.
     *
     *  Wraps C++ getter: `virtual string Transport::transportModel()`
     *
     *  @param handle       Handle to queried Transport object.
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned string value.
     *  @returns            Actual length of string including string-terminating null byte, \0, or -1 for exception handling.
     */
    int32_t trans_transportModel(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Get the dynamic viscosity [Pa·s].
     *
     *  Wraps C++ getter: `virtual double Transport::viscosity()`
     *
     *  @param handle       Handle to queried Transport object.
     */
    double trans_viscosity(int32_t handle);
 
    /**
     *  Get the mixture thermal conductivity [W/m/K].
     *
     *  Wraps C++ getter: `virtual double Transport::thermalConductivity()`
     *
     *  @param handle       Handle to queried Transport object.
     */
    double trans_thermalConductivity(int32_t handle);
 
    /**
     *  Get the electrical conductivity [siemens/m].
     *
     *  Wraps C++ getter: `virtual double Transport::electricalConductivity()`
     *
     *  @param handle       Handle to queried Transport object.
     */
    double trans_electricalConductivity(int32_t handle);
 
    /**
     *  Return a vector of thermal diffusion coefficients [kg/m/s].
     *
     *  Wraps C++ getter: `virtual void Transport::getThermalDiffCoeffs(double* const)`
     *
     *  @param handle       Handle to queried Transport object.
     *  @param[in] dtLen    Length of array reserved for dt.
     *  @param dt           On return, dt will contain the species thermal diffusion coefficients. Dimension dt at least as large as the number of species.
     */
    int32_t trans_getThermalDiffCoeffs(int32_t handle, int32_t dtLen, double* dt);
 
    /**
     *  Return a vector of mixture averaged diffusion coefficients [m²/s].
     *
     *  Wraps C++ getter: `virtual void Transport::getMixDiffCoeffs(double* const)`
     *
     *  @param handle       Handle to queried Transport object.
     *  @param[in] dLen     Length of array reserved for d.
     *  @param d            Return vector of mixture averaged diffusion coefficients; length is the number of species.
     */
    int32_t trans_getMixDiffCoeffs(int32_t handle, int32_t dLen, double* d);
 
    /**
     *  Returns the matrix of binary diffusion coefficients [m²/s].
     *
     *  Wraps C++ method: `virtual void Transport::getBinaryDiffCoeffs(const size_t, double* const)`
     *
     *  @param handle       Handle to queried Transport object.
     *  @param[in] ld       Leading dimension of the flattened array `d` used to store the diffusion coefficient matrix; usually equal to the number of species.
     *  @param[in] dLen     Length of array reserved for d.
     *  @param[out] d       Diffusion coefficient matrix stored in column-major (Fortran) order, such that
     */
    int32_t trans_getBinaryDiffCoeffs(int32_t handle, const int32_t ld, int32_t dLen, double* d);
 
    /**
     *  Return the multicomponent diffusion coefficients [m²/s].
     *
     *  Wraps C++ method: `virtual void Transport::getMultiDiffCoeffs(const size_t, double* const)`
     *
     *  @param handle       Handle to queried Transport object.
     *  @param[in] ld       Leading dimension of the flattened array `d` used to store the diffusion coefficient matrix; usually equal to the number of species.
     *  @param[in] dLen     Length of array reserved for d.
     *  @param[out] d       Diffusion coefficient matrix stored in column-major (Fortran) order, such that
     */
    int32_t trans_getMultiDiffCoeffs(int32_t handle, const int32_t ld, int32_t dLen, double* d);
 
    /**
     *  Get the molar fluxes [kmol/m²/s], given the thermodynamic state at two nearby points.
     *
     *  Wraps C++ method: `virtual void Transport::getMolarFluxes(const double* const, const double* const, const double, double* const)`
     *
     *  @param handle       Handle to queried Transport object.
     *  @param[in] state1Len Length of array reserved for state1.
     *  @param[in] state1   Array of temperature, density, and mass fractions for state 1.
     *  @param[in] state2Len Length of array reserved for state2.
     *  @param[in] state2   Array of temperature, density, and mass fractions for state 2.
     *  @param[in] delta    Distance [m] from state 1 to state 2.
     *  @param[in] cfluxesLen Length of array reserved for cfluxes.
     *  @param[out] cfluxes Array containing the diffusive molar fluxes of species from `state1` to `state2`; Length is number of species.
     */
    int32_t trans_getMolarFluxes(int32_t handle, int32_t state1Len, const double* state1, int32_t state2Len, const double* state2, const double delta, int32_t cfluxesLen, double* cfluxes);
 
    /**
     *  Get the mass fluxes [kg/m²/s], given the thermodynamic state at two nearby points.
     *
     *  Wraps C++ method: `virtual void Transport::getMassFluxes(const double*, const double*, double, double*)`
     *
     *  @param handle       Handle to queried Transport object.
     *  @param[in] state1Len Length of array reserved for state1.
     *  @param[in] state1   Array of temperature, density, and mass fractions for state 1.
     *  @param[in] state2Len Length of array reserved for state2.
     *  @param[in] state2   Array of temperature, density, and mass fractions for state 2.
     *  @param[in] delta    Distance [m] from state 1 to state 2.
     *  @param[in] mfluxesLen Length of array reserved for mfluxes.
     *  @param[out] mfluxes Array containing the diffusive mass fluxes of species from `state1` to `state2`; length is number of species.
     */
    int32_t trans_getMassFluxes(int32_t handle, int32_t state1Len, const double* state1, int32_t state2Len, const double* state2, double delta, int32_t mfluxesLen, double* mfluxes);
 
    /**
     *  Delete Transport object.
     *
     *  Wraps C++ destructor: `undefined`
     *
     *  @param handle       Handle to Transport object.
     *  @returns            Zero for success and -1 for exception handling.
     */
    int32_t trans_del(int32_t handle);
 
    /**
     *  Return size of Transport storage.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @returns            Size or -1 for exception handling.
     */
    int32_t trans_cabinetSize();
 
    /**
     *  @}
     */
 
#ifdef __cplusplus
}
#endif
 
#endif // CTTRANS_H