ctrdiag.h

Go to the documentation of this file.

/**
 *  CTRDIAG - Generated CLib %Cantera interface library.
 *
 *  @file ctrdiag.h
 *
 *  Generated CLib API for %Cantera's ReactionPathDiagram 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 CTRDIAG_H
#define CTRDIAG_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
    /**
     *  @defgroup CAPIctrdiag ctrdiag Library
     *  Generated CLib API for %Cantera's ReactionPathDiagram class.
     *
     *  @warning  This library is an experimental part of the %Cantera API and
     *      may be changed or removed without notice.
     *
     *  @ingroup CAPIindex
     */
 
    /**
     *  @addtogroup CAPIctrdiag
     *  @{
     */
 
    /**
     *  Create a new reaction path diagram.
     *
     *  Wraps C++ constructor: `shared_ptr<ReactionPathDiagram> newReactionPathDiagram(shared_ptr<Kinetics>, const string&)`
     *
     *  @param kin          Integer handle to Kinetics object. Shared pointer to Kinetics object.
     *  @param element      Element used for the calculation of net reaction rates.
     *  @returns            Handle to stored ReactionPathDiagram object or -1 for exception handling.
     */
    int32_t rdiag_newReactionPathDiagram(int32_t kin, const char* element);
 
    /**
     *  Boolean flag to show details.
     *
     *  Wraps C++ variable-getter: `bool ReactionPathDiagram::show_details`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     */
    int32_t rdiag_showDetails(int handle);
 
    /**
     *  Boolean flag to show details.
     *
     *  Wraps C++ variable-setter: `bool ReactionPathDiagram::show_details`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] show_details Boolean flag to show details.
     */
    int32_t rdiag_setShowDetails(int32_t handle, int32_t show_details);
 
    /**
     *  Threshold for the minimum flux relative value that will be plotted.
     *
     *  Wraps C++ variable-getter: `double ReactionPathDiagram::threshold`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     */
    double rdiag_threshold(int handle);
 
    /**
     *  Threshold for the minimum flux relative value that will be plotted.
     *
     *  Wraps C++ variable-setter: `double ReactionPathDiagram::threshold`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] threshold Threshold for the minimum flux relative value that will be plotted.
     */
    int32_t rdiag_setThreshold(int32_t handle, double threshold);
 
    /**
     *  Minimum relative flux for bold lines.
     *
     *  Wraps C++ variable-getter: `double ReactionPathDiagram::bold_min`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     */
    double rdiag_boldThreshold(int handle);
 
    /**
     *  Minimum relative flux for bold lines.
     *
     *  Wraps C++ variable-setter: `double ReactionPathDiagram::bold_min`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] bold_min Minimum relative flux for bold lines.
     */
    int32_t rdiag_setBoldThreshold(int32_t handle, double bold_min);
 
    /**
     *  Maximum relative flux for dashed lines.
     *
     *  Wraps C++ variable-getter: `double ReactionPathDiagram::dashed_max`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     */
    double rdiag_normalThreshold(int handle);
 
    /**
     *  Maximum relative flux for dashed lines.
     *
     *  Wraps C++ variable-setter: `double ReactionPathDiagram::dashed_max`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] dashed_max Maximum relative flux for dashed lines.
     */
    int32_t rdiag_setNormalThreshold(int32_t handle, double dashed_max);
 
    /**
     *  Minimum relative flux for labels.
     *
     *  Wraps C++ variable-getter: `double ReactionPathDiagram::label_min`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     */
    double rdiag_labelThreshold(int handle);
 
    /**
     *  Minimum relative flux for labels.
     *
     *  Wraps C++ variable-setter: `double ReactionPathDiagram::label_min`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] label_min Minimum relative flux for labels.
     */
    int32_t rdiag_setLabelThreshold(int32_t handle, double label_min);
 
    /**
     *  Color for bold lines.
     *
     *  Wraps C++ variable-getter: `string ReactionPathDiagram::bold_color`
     *
     *  @param handle       Handle to queried ReactionPathDiagram 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 rdiag_boldColor(int handle, int32_t bufLen, char* buf);
 
    /**
     *  Color for bold lines.
     *
     *  Wraps C++ variable-setter: `string ReactionPathDiagram::bold_color`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] bold_color Color for bold lines.
     */
    int32_t rdiag_setBoldColor(int32_t handle, const char* bold_color);
 
    /**
     *  Color for normal-weight lines.
     *
     *  Wraps C++ variable-getter: `string ReactionPathDiagram::normal_color`
     *
     *  @param handle       Handle to queried ReactionPathDiagram 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 rdiag_normalColor(int handle, int32_t bufLen, char* buf);
 
    /**
     *  Color for normal-weight lines.
     *
     *  Wraps C++ variable-setter: `string ReactionPathDiagram::normal_color`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] normal_color Color for normal-weight lines.
     */
    int32_t rdiag_setNormalColor(int32_t handle, const char* normal_color);
 
    /**
     *  Color for dashed lines.
     *
     *  Wraps C++ variable-getter: `string ReactionPathDiagram::dashed_color`
     *
     *  @param handle       Handle to queried ReactionPathDiagram 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 rdiag_dashedColor(int handle, int32_t bufLen, char* buf);
 
    /**
     *  Color for dashed lines.
     *
     *  Wraps C++ variable-setter: `string ReactionPathDiagram::dashed_color`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] dashed_color Color for dashed lines.
     */
    int32_t rdiag_setDashedColor(int32_t handle, const char* dashed_color);
 
    /**
     *  Options for the 'dot' program.
     *
     *  Wraps C++ variable-getter: `string ReactionPathDiagram::dot_options`
     *
     *  @param handle       Handle to queried ReactionPathDiagram 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 rdiag_dotOptions(int handle, int32_t bufLen, char* buf);
 
    /**
     *  Options for the 'dot' program.
     *
     *  Wraps C++ variable-setter: `string ReactionPathDiagram::dot_options`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] dot_options Options for the 'dot' program.
     */
    int32_t rdiag_setDotOptions(int32_t handle, const char* dot_options);
 
    /**
     *  Reaction path diagram font.
     *
     *  Wraps C++ variable-getter: `string ReactionPathDiagram::m_font`
     *
     *  @param handle       Handle to queried ReactionPathDiagram 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 rdiag_font(int handle, int32_t bufLen, char* buf);
 
    /**
     *  Set name of the font used.
     *
     *  Wraps C++ setter: `void ReactionPathDiagram::setFont(const string&)`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param font         Undocumented.
     */
    int32_t rdiag_setFont(int32_t handle, const char* font);
 
    /**
     *  The scaling factor for the fluxes.
     *
     *  Wraps C++ variable-getter: `double ReactionPathDiagram::scale`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     */
    double rdiag_scale(int handle);
 
    /**
     *  The scaling factor for the fluxes.
     *
     *  Wraps C++ variable-setter: `double ReactionPathDiagram::scale`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] scale    The scaling factor for the fluxes.
     */
    int32_t rdiag_setScale(int32_t handle, double scale);
 
    /**
     *  Get the way flows are drawn. Either 'NetFlow' or 'OneWayFlow'.
     *
     *  Wraps C++ getter: `const string ReactionPathDiagram::flowType()`
     *
     *  @param handle       Handle to queried ReactionPathDiagram 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 rdiag_flowType(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Get the way flows are drawn. Either 'NetFlow' or 'OneWayFlow'.
     *
     *  Wraps C++ setter: `void ReactionPathDiagram::setFlowType(const string&)`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param fType        Undocumented.
     */
    int32_t rdiag_setFlowType(int32_t handle, const char* fType);
 
    /**
     *  The arrow width. If < 0, then scale with flux value.
     *
     *  Wraps C++ variable-getter: `double ReactionPathDiagram::arrow_width`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     */
    double rdiag_arrowWidth(int handle);
 
    /**
     *  The arrow width. If < 0, then scale with flux value.
     *
     *  Wraps C++ variable-setter: `double ReactionPathDiagram::arrow_width`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] arrow_width The arrow width. If < 0, then scale with flux value.
     */
    int32_t rdiag_setArrowWidth(int32_t handle, double arrow_width);
 
    /**
     *  Reaction path diagram title.
     *
     *  Wraps C++ variable-getter: `string ReactionPathDiagram::title`
     *
     *  @param handle       Handle to queried ReactionPathDiagram 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 rdiag_title(int handle, int32_t bufLen, char* buf);
 
    /**
     *  Reaction path diagram title.
     *
     *  Wraps C++ variable-setter: `string ReactionPathDiagram::title`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param[in] title    Reaction path diagram title.
     */
    int32_t rdiag_setTitle(int32_t handle, const char* title);
 
    /**
     *  Add fluxes from other ReactionPathDiagram to this diagram.
     *
     *  Wraps C++ setter: `void ReactionPathDiagram::add(shared_ptr<ReactionPathDiagram>)`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param d            Integer handle to ReactionPathDiagram object. Undocumented.
     */
    int32_t rdiag_add(int32_t handle, int32_t d);
 
    /**
     *  Include only species and fluxes that are directly connected to a species.
     *
     *  Wraps C++ setter: `void ReactionPathDiagram::displayOnly(size_t)`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param k            Undocumented.
     */
    int32_t rdiag_displayOnly(int32_t handle, int32_t k);
 
    /**
     *  Export string in
     *
     *  Wraps C++ getter: `string ReactionPathDiagram::getDot()`
     *
     *  @param handle       Handle to queried ReactionPathDiagram 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 rdiag_getDot(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Get a (roughly) human-readable representation of the reaction path diagram.
     *
     *  Wraps C++ getter: `string ReactionPathDiagram::getData()`
     *
     *  @param handle       Handle to queried ReactionPathDiagram 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 rdiag_getData(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Build the reaction path diagram.
     *
     *  Wraps C++ method: `void ReactionPathDiagram::build()`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     */
    int32_t rdiag_build(int32_t handle);
 
    /**
     *  Get logging messages generated while building the reaction path diagram.
     *
     *  Wraps C++ getter: `string ReactionPathDiagram::getLog()`
     *
     *  @param handle       Handle to queried ReactionPathDiagram 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 rdiag_getLog(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Undocumented.
     *
     *  Wraps C++ method: `void ReactionPathDiagram::findMajorPaths(double, size_t, double*)`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @param threshold    Undocumented.
     *  @param lda          Undocumented.
     *  @param[in] aLen     Length of array reserved for a.
     *  @param a            Undocumented.
     */
    int32_t rdiag_findMajor(int32_t handle, double threshold, int32_t lda, int32_t aLen, double* a);
 
    /**
     *  Delete ReactionPathDiagram object.
     *
     *  Wraps C++ destructor: `undefined`
     *
     *  @param handle       Handle to ReactionPathDiagram object.
     *  @returns            Zero for success and -1 for exception handling.
     */
    int32_t rdiag_del(int32_t handle);
 
    /**
     *  Return size of ReactionPathDiagram storage.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @returns            Size or -1 for exception handling.
     */
    int32_t rdiag_cabinetSize();
 
    /**
     *  Return handle to parent of ReactionPathDiagram object.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @param handle       Handle to queried ReactionPathDiagram object.
     *  @returns            Parent handle or -1 for exception handling.
     */
    int32_t rdiag_parentHandle(int32_t handle);
 
    /**
     *  @}
     */
 
#ifdef __cplusplus
}
#endif
 
#endif // CTRDIAG_H