ctrdiag.h File Reference

CTRDIAG - Generated CLib Cantera interface library. More...

Detailed Description

CTRDIAG - Generated CLib Cantera interface library.

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.

Definition in file ctrdiag.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int32_t	rdiag_newReactionPathDiagram (int32_t kin, const char *element)
	Create a new reaction path diagram.
int32_t	rdiag_showDetails (int handle)
	Boolean flag to show details.
int32_t	rdiag_setShowDetails (int32_t handle, int32_t show_details)
	Boolean flag to show details.
double	rdiag_threshold (int handle)
	Threshold for the minimum flux relative value that will be plotted.
int32_t	rdiag_setThreshold (int32_t handle, double threshold)
	Threshold for the minimum flux relative value that will be plotted.
double	rdiag_boldThreshold (int handle)
	Minimum relative flux for bold lines.
int32_t	rdiag_setBoldThreshold (int32_t handle, double bold_min)
	Minimum relative flux for bold lines.
double	rdiag_normalThreshold (int handle)
	Maximum relative flux for dashed lines.
int32_t	rdiag_setNormalThreshold (int32_t handle, double dashed_max)
	Maximum relative flux for dashed lines.
double	rdiag_labelThreshold (int handle)
	Minimum relative flux for labels.
int32_t	rdiag_setLabelThreshold (int32_t handle, double label_min)
	Minimum relative flux for labels.
int32_t	rdiag_boldColor (int handle, int32_t bufLen, char *buf)
	Color for bold lines.
int32_t	rdiag_setBoldColor (int32_t handle, const char *bold_color)
	Color for bold lines.
int32_t	rdiag_normalColor (int handle, int32_t bufLen, char *buf)
	Color for normal-weight lines.
int32_t	rdiag_setNormalColor (int32_t handle, const char *normal_color)
	Color for normal-weight lines.
int32_t	rdiag_dashedColor (int handle, int32_t bufLen, char *buf)
	Color for dashed lines.
int32_t	rdiag_setDashedColor (int32_t handle, const char *dashed_color)
	Color for dashed lines.
int32_t	rdiag_dotOptions (int handle, int32_t bufLen, char *buf)
	Options for the 'dot' program.
int32_t	rdiag_setDotOptions (int32_t handle, const char *dot_options)
	Options for the 'dot' program.
int32_t	rdiag_font (int handle, int32_t bufLen, char *buf)
	Reaction path diagram font.
int32_t	rdiag_setFont (int32_t handle, const char *font)
	Set name of the font used.
double	rdiag_scale (int handle)
	The scaling factor for the fluxes.
int32_t	rdiag_setScale (int32_t handle, double scale)
	The scaling factor for the fluxes.
int32_t	rdiag_flowType (int32_t handle, int32_t bufLen, char *buf)
	Get the way flows are drawn.
int32_t	rdiag_setFlowType (int32_t handle, const char *fType)
	Get the way flows are drawn.
double	rdiag_arrowWidth (int handle)
	The arrow width.
int32_t	rdiag_setArrowWidth (int32_t handle, double arrow_width)
	The arrow width.
int32_t	rdiag_title (int handle, int32_t bufLen, char *buf)
	Reaction path diagram title.
int32_t	rdiag_setTitle (int32_t handle, const char *title)
	Reaction path diagram title.
int32_t	rdiag_add (int32_t handle, int32_t d)
	Add fluxes from other ReactionPathDiagram to this diagram.
int32_t	rdiag_displayOnly (int32_t handle, int32_t k)
	Include only species and fluxes that are directly connected to a species.
int32_t	rdiag_getDot (int32_t handle, int32_t bufLen, char *buf)
	Export string in.
int32_t	rdiag_getData (int32_t handle, int32_t bufLen, char *buf)
	Get a (roughly) human-readable representation of the reaction path diagram.
int32_t	rdiag_build (int32_t handle)
	Build the reaction path diagram.
int32_t	rdiag_getLog (int32_t handle, int32_t bufLen, char *buf)
	Get logging messages generated while building the reaction path diagram.
int32_t	rdiag_findMajor (int32_t handle, double threshold, int32_t lda, int32_t aLen, double *a)
	Undocumented.
int32_t	rdiag_del (int32_t handle)
	Delete ReactionPathDiagram object.
int32_t	rdiag_cabinetSize ()
	Return size of ReactionPathDiagram storage.
int32_t	rdiag_parentHandle (int32_t handle)
	Return handle to parent of ReactionPathDiagram object.