Generated CLib API for Cantera's ReactionPathDiagram class. More...

Collaboration diagram for ctrdiag Library:

Detailed Description

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.

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.

Function Documentation

◆ rdiag_newReactionPathDiagram()

int32_t rdiag_newReactionPathDiagram	(	int32_t	kin,
		const char *	element
	)

Create a new reaction path diagram.

Wraps C++ constructor: shared_ptr<ReactionPathDiagram> newReactionPathDiagram(shared_ptr<Kinetics>, const string&)

Parameters

kin	Integer handle to Kinetics object. Shared pointer to Kinetics object.
element	Element used for the calculation of net reaction rates.

Returns: Handle to stored ReactionPathDiagram object or -1 for exception handling.

Definition at line 42 of file ctrdiag.cpp.

◆ rdiag_showDetails()

int32_t rdiag_showDetails ( int handle )

Boolean flag to show details.

Wraps C++ variable-getter: bool ReactionPathDiagram::show_details

Parameters

handle Handle to queried ReactionPathDiagram object.

Definition at line 52 of file ctrdiag.cpp.

◆ rdiag_setShowDetails()

int32_t rdiag_setShowDetails	(	int32_t	handle,
		int32_t	show_details
	)

Boolean flag to show details.

Wraps C++ variable-setter: bool ReactionPathDiagram::show_details

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	show_details	Boolean flag to show details.

Definition at line 63 of file ctrdiag.cpp.

◆ rdiag_threshold()

double rdiag_threshold ( int handle )

Threshold for the minimum flux relative value that will be plotted.

Wraps C++ variable-getter: double ReactionPathDiagram::threshold

Parameters

handle Handle to queried ReactionPathDiagram object.

Definition at line 75 of file ctrdiag.cpp.

◆ rdiag_setThreshold()

int32_t rdiag_setThreshold	(	int32_t	handle,
		double	threshold
	)

Threshold for the minimum flux relative value that will be plotted.

Wraps C++ variable-setter: double ReactionPathDiagram::threshold

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	threshold	Threshold for the minimum flux relative value that will be plotted.

Definition at line 85 of file ctrdiag.cpp.

◆ rdiag_boldThreshold()

double rdiag_boldThreshold ( int handle )

Minimum relative flux for bold lines.

Wraps C++ variable-getter: double ReactionPathDiagram::bold_min

Parameters

handle Handle to queried ReactionPathDiagram object.

Definition at line 96 of file ctrdiag.cpp.

◆ rdiag_setBoldThreshold()

int32_t rdiag_setBoldThreshold	(	int32_t	handle,
		double	bold_min
	)

Minimum relative flux for bold lines.

Wraps C++ variable-setter: double ReactionPathDiagram::bold_min

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bold_min	Minimum relative flux for bold lines.

Definition at line 106 of file ctrdiag.cpp.

◆ rdiag_normalThreshold()

double rdiag_normalThreshold ( int handle )

Maximum relative flux for dashed lines.

Wraps C++ variable-getter: double ReactionPathDiagram::dashed_max

Parameters

handle Handle to queried ReactionPathDiagram object.

Definition at line 117 of file ctrdiag.cpp.

◆ rdiag_setNormalThreshold()

int32_t rdiag_setNormalThreshold	(	int32_t	handle,
		double	dashed_max
	)

Maximum relative flux for dashed lines.

Wraps C++ variable-setter: double ReactionPathDiagram::dashed_max

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	dashed_max	Maximum relative flux for dashed lines.

Definition at line 127 of file ctrdiag.cpp.

◆ rdiag_labelThreshold()

double rdiag_labelThreshold ( int handle )

Minimum relative flux for labels.

Wraps C++ variable-getter: double ReactionPathDiagram::label_min

Parameters

handle Handle to queried ReactionPathDiagram object.

Definition at line 138 of file ctrdiag.cpp.

◆ rdiag_setLabelThreshold()

int32_t rdiag_setLabelThreshold	(	int32_t	handle,
		double	label_min
	)

Minimum relative flux for labels.

Wraps C++ variable-setter: double ReactionPathDiagram::label_min

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	label_min	Minimum relative flux for labels.

Definition at line 148 of file ctrdiag.cpp.

◆ rdiag_boldColor()

int32_t rdiag_boldColor	(	int	handle,
		int32_t	bufLen,
		char *	buf
	)

Color for bold lines.

Wraps C++ variable-getter: string ReactionPathDiagram::bold_color

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns: Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 159 of file ctrdiag.cpp.

◆ rdiag_setBoldColor()

int32_t rdiag_setBoldColor	(	int32_t	handle,
		const char *	bold_color
	)

Color for bold lines.

Wraps C++ variable-setter: string ReactionPathDiagram::bold_color

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bold_color	Color for bold lines.

Definition at line 171 of file ctrdiag.cpp.

◆ rdiag_normalColor()

int32_t rdiag_normalColor	(	int	handle,
		int32_t	bufLen,
		char *	buf
	)

Color for normal-weight lines.

Wraps C++ variable-getter: string ReactionPathDiagram::normal_color

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns: Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 182 of file ctrdiag.cpp.

◆ rdiag_setNormalColor()

int32_t rdiag_setNormalColor	(	int32_t	handle,
		const char *	normal_color
	)

Color for normal-weight lines.

Wraps C++ variable-setter: string ReactionPathDiagram::normal_color

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	normal_color	Color for normal-weight lines.

Definition at line 194 of file ctrdiag.cpp.

◆ rdiag_dashedColor()

int32_t rdiag_dashedColor	(	int	handle,
		int32_t	bufLen,
		char *	buf
	)

Color for dashed lines.

Wraps C++ variable-getter: string ReactionPathDiagram::dashed_color

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns: Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 205 of file ctrdiag.cpp.

◆ rdiag_setDashedColor()

int32_t rdiag_setDashedColor	(	int32_t	handle,
		const char *	dashed_color
	)

Color for dashed lines.

Wraps C++ variable-setter: string ReactionPathDiagram::dashed_color

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	dashed_color	Color for dashed lines.

Definition at line 217 of file ctrdiag.cpp.

◆ rdiag_dotOptions()

int32_t rdiag_dotOptions	(	int	handle,
		int32_t	bufLen,
		char *	buf
	)

Options for the 'dot' program.

Wraps C++ variable-getter: string ReactionPathDiagram::dot_options

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns: Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 228 of file ctrdiag.cpp.

◆ rdiag_setDotOptions()

int32_t rdiag_setDotOptions	(	int32_t	handle,
		const char *	dot_options
	)

Options for the 'dot' program.

Wraps C++ variable-setter: string ReactionPathDiagram::dot_options

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	dot_options	Options for the 'dot' program.

Definition at line 240 of file ctrdiag.cpp.

◆ rdiag_font()

int32_t rdiag_font	(	int	handle,
		int32_t	bufLen,
		char *	buf
	)

Reaction path diagram font.

Wraps C++ variable-getter: string ReactionPathDiagram::m_font

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns: Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 251 of file ctrdiag.cpp.

◆ rdiag_setFont()

int32_t rdiag_setFont	(	int32_t	handle,
		const char *	font
	)

Set name of the font used.

Wraps C++ setter: void ReactionPathDiagram::setFont(const string&)

Parameters

handle	Handle to queried ReactionPathDiagram object.
font	Undocumented.

Definition at line 263 of file ctrdiag.cpp.

◆ rdiag_scale()

double rdiag_scale ( int handle )

The scaling factor for the fluxes.

Wraps C++ variable-getter: double ReactionPathDiagram::scale

Parameters

handle Handle to queried ReactionPathDiagram object.

Definition at line 274 of file ctrdiag.cpp.

◆ rdiag_setScale()

int32_t rdiag_setScale	(	int32_t	handle,
		double	scale
	)

The scaling factor for the fluxes.

Wraps C++ variable-setter: double ReactionPathDiagram::scale

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	scale	The scaling factor for the fluxes.

Definition at line 284 of file ctrdiag.cpp.

◆ rdiag_flowType()

int32_t rdiag_flowType	(	int32_t	handle,
		int32_t	bufLen,
		char *	buf
	)

Get the way flows are drawn.

Either 'NetFlow' or 'OneWayFlow'.

Wraps C++ getter: const string ReactionPathDiagram::flowType()

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns: Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 295 of file ctrdiag.cpp.

◆ rdiag_setFlowType()

int32_t rdiag_setFlowType	(	int32_t	handle,
		const char *	fType
	)

Get the way flows are drawn.

Either 'NetFlow' or 'OneWayFlow'.

Wraps C++ setter: void ReactionPathDiagram::setFlowType(const string&)

Parameters

handle	Handle to queried ReactionPathDiagram object.
fType	Undocumented.

Definition at line 307 of file ctrdiag.cpp.

◆ rdiag_arrowWidth()

double rdiag_arrowWidth ( int handle )

The arrow width.

If < 0, then scale with flux value.

Wraps C++ variable-getter: double ReactionPathDiagram::arrow_width

Parameters

handle Handle to queried ReactionPathDiagram object.

Definition at line 318 of file ctrdiag.cpp.

◆ rdiag_setArrowWidth()

int32_t rdiag_setArrowWidth	(	int32_t	handle,
		double	arrow_width
	)

The arrow width.

If < 0, then scale with flux value.

Wraps C++ variable-setter: double ReactionPathDiagram::arrow_width

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	arrow_width	The arrow width. If < 0, then scale with flux value.

Definition at line 328 of file ctrdiag.cpp.

◆ rdiag_title()

int32_t rdiag_title	(	int	handle,
		int32_t	bufLen,
		char *	buf
	)

Reaction path diagram title.

Wraps C++ variable-getter: string ReactionPathDiagram::title

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns: Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 339 of file ctrdiag.cpp.

◆ rdiag_setTitle()

int32_t rdiag_setTitle	(	int32_t	handle,
		const char *	title
	)

Reaction path diagram title.

Wraps C++ variable-setter: string ReactionPathDiagram::title

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	title	Reaction path diagram title.

Definition at line 351 of file ctrdiag.cpp.

◆ rdiag_add()

int32_t rdiag_add	(	int32_t	handle,
		int32_t	d
	)

Add fluxes from other ReactionPathDiagram to this diagram.

Wraps C++ setter: void ReactionPathDiagram::add(shared_ptr<ReactionPathDiagram>)

Parameters

handle	Handle to queried ReactionPathDiagram object.
d	Integer handle to ReactionPathDiagram object. Undocumented.

Definition at line 362 of file ctrdiag.cpp.

◆ rdiag_displayOnly()

int32_t rdiag_displayOnly	(	int32_t	handle,
		int32_t	k
	)

Include only species and fluxes that are directly connected to a species.

Wraps C++ setter: void ReactionPathDiagram::displayOnly(size_t)

Parameters

handle	Handle to queried ReactionPathDiagram object.
k	Undocumented.

Definition at line 373 of file ctrdiag.cpp.

◆ rdiag_getDot()

int32_t rdiag_getDot	(	int32_t	handle,
		int32_t	bufLen,
		char *	buf
	)

Export string in.

Wraps C++ getter: string ReactionPathDiagram::getDot()

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns: Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 384 of file ctrdiag.cpp.

◆ rdiag_getData()

int32_t rdiag_getData	(	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()

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns: Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 396 of file ctrdiag.cpp.

◆ rdiag_build()

int32_t rdiag_build ( int32_t handle )

Build the reaction path diagram.

Wraps C++ method: void ReactionPathDiagram::build()

Parameters

handle Handle to queried ReactionPathDiagram object.

Definition at line 408 of file ctrdiag.cpp.

◆ rdiag_getLog()

int32_t rdiag_getLog	(	int32_t	handle,
		int32_t	bufLen,
		char *	buf
	)

Get logging messages generated while building the reaction path diagram.

Wraps C++ getter: string ReactionPathDiagram::getLog()

Parameters

	handle	Handle to queried ReactionPathDiagram object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns: Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 419 of file ctrdiag.cpp.

◆ rdiag_findMajor()

int32_t rdiag_findMajor	(	int32_t	handle,
		double	threshold,
		int32_t	lda,
		int32_t	aLen,
		double *	a
	)

Undocumented.

Wraps C++ method: void ReactionPathDiagram::findMajorPaths(double, size_t, double*)

Parameters

	handle	Handle to queried ReactionPathDiagram object.
	threshold	Undocumented.
	lda	Undocumented.
[in]	aLen	Length of array reserved for a.
	a	Undocumented.

Definition at line 431 of file ctrdiag.cpp.

◆ rdiag_del()

int32_t rdiag_del ( int32_t handle )

Delete ReactionPathDiagram object.

Wraps C++ destructor: undefined

Parameters

handle Handle to ReactionPathDiagram object.

Returns: Zero for success and -1 for exception handling.

Definition at line 442 of file ctrdiag.cpp.

◆ rdiag_cabinetSize()

int32_t rdiag_cabinetSize ( )

Return size of ReactionPathDiagram storage.

Wraps C++ reserved CLib function: custom code

Returns: Size or -1 for exception handling.

Definition at line 453 of file ctrdiag.cpp.

◆ rdiag_parentHandle()

int32_t rdiag_parentHandle ( int32_t handle )

Return handle to parent of ReactionPathDiagram object.

Wraps C++ reserved CLib function: custom code

Parameters

handle Handle to queried ReactionPathDiagram object.

Returns: Parent handle or -1 for exception handling.

Definition at line 465 of file ctrdiag.cpp.

Detailed Description

Functions

Function Documentation

◆ rdiag_newReactionPathDiagram()

◆ rdiag_showDetails()

◆ rdiag_setShowDetails()

◆ rdiag_threshold()

◆ rdiag_setThreshold()

◆ rdiag_boldThreshold()

◆ rdiag_setBoldThreshold()

◆ rdiag_normalThreshold()

◆ rdiag_setNormalThreshold()

◆ rdiag_labelThreshold()

◆ rdiag_setLabelThreshold()

◆ rdiag_boldColor()

◆ rdiag_setBoldColor()

◆ rdiag_normalColor()

◆ rdiag_setNormalColor()

◆ rdiag_dashedColor()

◆ rdiag_setDashedColor()

◆ rdiag_dotOptions()

◆ rdiag_setDotOptions()

◆ rdiag_font()

◆ rdiag_setFont()

◆ rdiag_scale()

◆ rdiag_setScale()

◆ rdiag_flowType()

◆ rdiag_setFlowType()

◆ rdiag_arrowWidth()

◆ rdiag_setArrowWidth()

◆ rdiag_title()

◆ rdiag_setTitle()

◆ rdiag_add()

◆ rdiag_displayOnly()

◆ rdiag_getDot()

◆ rdiag_getData()

◆ rdiag_build()

◆ rdiag_getLog()

◆ rdiag_findMajor()

◆ rdiag_del()

◆ rdiag_cabinetSize()

◆ rdiag_parentHandle()