ctrxn.h

Go to the documentation of this file.

/**
 *  CTRXN - Generated CLib %Cantera interface library.
 *
 *  @file ctrxn.h
 *
 *  Generated CLib API for %Cantera's Reaction 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 CTRXN_H
#define CTRXN_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
    /**
     *  @defgroup CAPIctrxn ctrxn Library
     *  Generated CLib API for %Cantera's Reaction class.
     *
     *  @warning  This library is an experimental part of the %Cantera API and
     *      may be changed or removed without notice.
     *
     *  @ingroup CAPIindex
     */
 
    /**
     *  @addtogroup CAPIctrxn
     *  @{
     */
 
    /**
     *  Instantiate Reaction object using default constructor.
     *
     *  Wraps C++ constructor: `undefined`
     *
     *  @returns            Object handle if successful and -1 for exception handling.
     */
    int32_t rxn_new();
 
    /**
     *  The chemical equation for this reaction.
     *
     *  Wraps C++ getter: `string Reaction::equation()`
     *
     *  @param handle       Handle to queried Reaction 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 rxn_equation(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  The type of reaction, including reaction rate information.
     *
     *  Wraps C++ getter: `string Reaction::type()`
     *
     *  @param handle       Handle to queried Reaction 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 rxn_type(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Check whether reaction involves third body collider.
     *
     *  Wraps C++ getter: `bool Reaction::usesThirdBody()`
     *
     *  @param handle       Handle to queried Reaction object.
     */
    int32_t rxn_usesThirdBody(int32_t handle);
 
    /**
     *  Get validity flag of reaction.
     *
     *  Wraps C++ getter: `bool Reaction::valid()`
     *
     *  @param handle       Handle to queried Reaction object.
     */
    int32_t rxn_valid(int32_t handle);
 
    /**
     *  An identification string for the reaction, used in some filtering operations.
     *
     *  Wraps C++ variable-getter: `string Reaction::id`
     *
     *  @param handle       Handle to queried Reaction 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 rxn_id(int handle, int32_t bufLen, char* buf);
 
    /**
     *  An identification string for the reaction, used in some filtering operations.
     *
     *  Wraps C++ variable-setter: `string Reaction::id`
     *
     *  @param handle       Handle to queried Reaction object.
     *  @param[in] id       An identification string for the reaction, used in some filtering operations.
     */
    int32_t rxn_setId(int32_t handle, const char* id);
 
    /**
     *  True if reaction orders can be specified for non-reactant species.
     *
     *  Wraps C++ variable-getter: `bool Reaction::allow_nonreactant_orders`
     *
     *  @param handle       Handle to queried Reaction object.
     */
    int32_t rxn_allowNonreactantOrders(int handle);
 
    /**
     *  True if reaction orders can be specified for non-reactant species.
     *
     *  Wraps C++ variable-setter: `bool Reaction::allow_nonreactant_orders`
     *
     *  @param handle       Handle to queried Reaction object.
     *  @param[in] allow_nonreactant_orders True if reaction orders can be specified for non-reactant species.
     */
    int32_t rxn_setAllowNonreactantOrders(int32_t handle, int32_t allow_nonreactant_orders);
 
    /**
     *  Delete Reaction object.
     *
     *  Wraps C++ destructor: `undefined`
     *
     *  @param handle       Handle to Reaction object.
     *  @returns            Zero for success and -1 for exception handling.
     */
    int32_t rxn_del(int32_t handle);
 
    /**
     *  Return size of Reaction storage.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @returns            Size or -1 for exception handling.
     */
    int32_t rxn_cabinetSize();
 
    /**
     *  Return handle to parent of Reaction object.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @param handle       Handle to queried Reaction object.
     *  @returns            Parent handle or -1 for exception handling.
     */
    int32_t rxn_parentHandle(int32_t handle);
 
    /**
     *  @}
     */
 
#ifdef __cplusplus
}
#endif
 
#endif // CTRXN_H