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

Collaboration diagram for ctconnector Library:

Detailed Description

Generated CLib API for Cantera's ConnectorNode class.

Warning: This library is an experimental part of the Cantera API and may be changed or removed without notice.

Functions
int32_t	connector_new (const char model, int32_t r0, int32_t r1, const char name)
	Create a ConnectorNode object of the specified type.

int32_t	connector_type (int32_t handle, int32_t bufLen, char *buf)
	String indicating the connector implemented.

int32_t	connector_name (int32_t handle, int32_t bufLen, char *buf)
	Retrieve connector name.

int32_t	connector_setName (int32_t handle, const char *name)
	Set connector name.

int32_t	flowdev_setPrimary (int32_t handle, int32_t primary)
	Set the primary mass flow controller.

double	flowdev_massFlowRate (int32_t handle)
	Mass flow rate (kg/s).

double	flowdev_deviceCoefficient (int32_t handle)
	Get the device coefficient (defined by derived class).

int32_t	flowdev_setDeviceCoefficient (int32_t handle, double c)
	Set the device coefficient (defined by derived class).

int32_t	flowdev_setPressureFunction (int32_t handle, int32_t f)
	Set a function of pressure to modify the pressure response.

int32_t	flowdev_setTimeFunction (int32_t handle, int32_t g)
	Set a function of time to modulate the mass flow rate.

double	wall_expansionRate (int32_t handle)
	Rate of volume change (m^3/s) for the adjacent reactors at current reactor network time.

double	wall_heatRate (int32_t handle)
	Heat flow rate through the wall (W) at current reactor network time.

double	wall_area (int32_t handle)
	Area in (m^2).

int32_t	wall_setArea (int32_t handle, double a)
	Set the area [m^2].

int32_t	wall_setThermalResistance (int32_t handle, double Rth)
	Set the thermal resistance of the wall [K*m^2/W].

int32_t	wall_setHeatTransferCoeff (int32_t handle, double U)
	Set the overall heat transfer coefficient [W/m^2/K].

int32_t	wall_setHeatFlux (int32_t handle, int32_t q)
	Specify the heat flux function.

int32_t	wall_setExpansionRateCoeff (int32_t handle, double k)
	Set the expansion rate coefficient.

int32_t	wall_setVelocity (int32_t handle, int32_t f)
	Set the wall velocity to a specified function of time,.

int32_t	wall_setEmissivity (int32_t handle, double epsilon)
	Set the emissivity.

int32_t	connector_del (int32_t handle)
	Delete ConnectorNode object.

int32_t	connector_cabinetSize ()
	Return size of ConnectorNode storage.

int32_t	connector_parentHandle (int32_t handle)
	Return handle to parent of ConnectorNode object.

Function Documentation

◆ connector_new()

int32_t connector_new	(	const char *	model,
		int32_t	r0,
		int32_t	r1,
		const char *	name
	)

Create a ConnectorNode object of the specified type.

Wraps C++ constructor: shared_ptr<ConnectorNode> newConnectorNode(const string&, shared_ptr<ReactorBase>, shared_ptr<ReactorBase>, const string&)

Parameters

model	String specifying reactor type.
r0	Integer handle to ReactorBase object. First reactor.
r1	Integer handle to ReactorBase object. Second reactor.
name	Name of the connector.

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

Definition at line 48 of file ctconnector.cpp.

◆ connector_type()

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

String indicating the connector implemented.

Wraps C++ getter: virtual string ConnectorNode::type()

Parameters

	handle	Handle to queried ConnectorNode 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 58 of file ctconnector.cpp.

◆ connector_name()

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

Retrieve connector name.

Wraps C++ getter: string ConnectorNode::name()

Parameters

	handle	Handle to queried ConnectorNode 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 70 of file ctconnector.cpp.

◆ connector_setName()

int32_t connector_setName	(	int32_t	handle,
		const char *	name
	)

Set connector name.

Wraps C++ setter: void ConnectorNode::setName(const string&)

Parameters

handle	Handle to queried ConnectorNode object.
name	Undocumented.

Definition at line 82 of file ctconnector.cpp.

◆ flowdev_setPrimary()

int32_t flowdev_setPrimary	(	int32_t	handle,
		int32_t	primary
	)

Set the primary mass flow controller.

Wraps C++ setter: virtual void FlowDevice::setPrimary(shared_ptr<ConnectorNode>)

Parameters

handle	Handle to queried FlowDevice object.
primary	Integer handle to ConnectorNode object. Undocumented.

Definition at line 93 of file ctconnector.cpp.

◆ flowdev_massFlowRate()

double flowdev_massFlowRate ( int32_t handle )

Mass flow rate (kg/s).

Wraps C++ getter: double FlowDevice::massFlowRate()

Parameters

handle Handle to queried FlowDevice object.

Definition at line 104 of file ctconnector.cpp.

◆ flowdev_deviceCoefficient()

double flowdev_deviceCoefficient ( int32_t handle )

Get the device coefficient (defined by derived class).

Wraps C++ getter: double FlowDevice::deviceCoefficient()

Parameters

handle Handle to queried FlowDevice object.

Definition at line 114 of file ctconnector.cpp.

◆ flowdev_setDeviceCoefficient()

int32_t flowdev_setDeviceCoefficient	(	int32_t	handle,
		double	c
	)

Set the device coefficient (defined by derived class).

Wraps C++ setter: void FlowDevice::setDeviceCoefficient(double)

Parameters

handle	Handle to queried FlowDevice object.
c	Undocumented.

Definition at line 124 of file ctconnector.cpp.

◆ flowdev_setPressureFunction()

int32_t flowdev_setPressureFunction	(	int32_t	handle,
		int32_t	f
	)

Set a function of pressure to modify the pressure response.

Wraps C++ setter: virtual void FlowDevice::setPressureFunction(shared_ptr<Func1>)

Parameters

handle	Handle to queried FlowDevice object.
f	Integer handle to Func1 object. Undocumented.

Definition at line 135 of file ctconnector.cpp.

◆ flowdev_setTimeFunction()

int32_t flowdev_setTimeFunction	(	int32_t	handle,
		int32_t	g
	)

Set a function of time to modulate the mass flow rate.

Wraps C++ setter: virtual void FlowDevice::setTimeFunction(shared_ptr<Func1>)

Parameters

handle	Handle to queried FlowDevice object.
g	Integer handle to Func1 object. Undocumented.

Definition at line 146 of file ctconnector.cpp.

◆ wall_expansionRate()

double wall_expansionRate ( int32_t handle )

Rate of volume change (m^3/s) for the adjacent reactors at current reactor network time.

Wraps C++ getter: virtual double WallBase::expansionRate()

Parameters

handle Handle to queried WallBase object.

Definition at line 157 of file ctconnector.cpp.

◆ wall_heatRate()

double wall_heatRate ( int32_t handle )

Heat flow rate through the wall (W) at current reactor network time.

Wraps C++ getter: virtual double WallBase::heatRate()

Parameters

handle Handle to queried WallBase object.

Definition at line 167 of file ctconnector.cpp.

◆ wall_area()

double wall_area ( int32_t handle )

Area in (m^2).

Wraps C++ getter: double WallBase::area()

Parameters

handle Handle to queried WallBase object.

Definition at line 177 of file ctconnector.cpp.

◆ wall_setArea()

int32_t wall_setArea	(	int32_t	handle,
		double	a
	)

Set the area [m^2].

Wraps C++ setter: virtual void WallBase::setArea(double)

Parameters

handle	Handle to queried WallBase object.
a	Undocumented.

Definition at line 187 of file ctconnector.cpp.

◆ wall_setThermalResistance()

int32_t wall_setThermalResistance	(	int32_t	handle,
		double	Rth
	)

Set the thermal resistance of the wall [K*m^2/W].

Wraps C++ setter: void Wall::setThermalResistance(double)

Parameters

handle	Handle to queried Wall object.
Rth	Undocumented.

Definition at line 198 of file ctconnector.cpp.

◆ wall_setHeatTransferCoeff()

int32_t wall_setHeatTransferCoeff	(	int32_t	handle,
		double	U
	)

Set the overall heat transfer coefficient [W/m^2/K].

Wraps C++ setter: void Wall::setHeatTransferCoeff(double)

Parameters

handle	Handle to queried Wall object.
U	Undocumented.

Definition at line 209 of file ctconnector.cpp.

◆ wall_setHeatFlux()

int32_t wall_setHeatFlux	(	int32_t	handle,
		int32_t	q
	)

Specify the heat flux function.

Wraps C++ setter: void Wall::setHeatFlux(shared_ptr<Func1>)

Parameters

handle	Handle to queried Wall object.
q	Integer handle to Func1 object. Undocumented.

Definition at line 220 of file ctconnector.cpp.

◆ wall_setExpansionRateCoeff()

int32_t wall_setExpansionRateCoeff	(	int32_t	handle,
		double	k
	)

Set the expansion rate coefficient.

Wraps C++ setter: void Wall::setExpansionRateCoeff(double)

Parameters

handle	Handle to queried Wall object.
k	Undocumented.

Definition at line 231 of file ctconnector.cpp.

◆ wall_setVelocity()

int32_t wall_setVelocity	(	int32_t	handle,
		int32_t	f
	)

Set the wall velocity to a specified function of time,.

Wraps C++ setter: void Wall::setVelocity(shared_ptr<Func1>)

Parameters

handle	Handle to queried Wall object.
f	Integer handle to Func1 object. Undocumented.

Definition at line 242 of file ctconnector.cpp.

◆ wall_setEmissivity()

int32_t wall_setEmissivity	(	int32_t	handle,
		double	epsilon
	)

Set the emissivity.

Wraps C++ setter: void Wall::setEmissivity(double)

Parameters

handle	Handle to queried Wall object.
epsilon	Undocumented.

Definition at line 253 of file ctconnector.cpp.

◆ connector_del()

int32_t connector_del ( int32_t handle )

Delete ConnectorNode object.

Wraps C++ destructor: undefined

Parameters

handle Handle to ConnectorNode object.

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

Definition at line 264 of file ctconnector.cpp.

◆ connector_cabinetSize()

int32_t connector_cabinetSize ( )

Return size of ConnectorNode storage.

Wraps C++ reserved CLib function: custom code

Returns: Size or -1 for exception handling.

Definition at line 275 of file ctconnector.cpp.

◆ connector_parentHandle()

int32_t connector_parentHandle ( int32_t handle )

Return handle to parent of ConnectorNode object.

Wraps C++ reserved CLib function: custom code

Parameters

handle Handle to queried ConnectorNode object.

Returns: Parent handle or -1 for exception handling.

Definition at line 287 of file ctconnector.cpp.

Detailed Description

Functions

Function Documentation

◆ connector_new()

◆ connector_type()

◆ connector_name()

◆ connector_setName()

◆ flowdev_setPrimary()

◆ flowdev_massFlowRate()

◆ flowdev_deviceCoefficient()

◆ flowdev_setDeviceCoefficient()

◆ flowdev_setPressureFunction()

◆ flowdev_setTimeFunction()

◆ wall_expansionRate()

◆ wall_heatRate()

◆ wall_area()

◆ wall_setArea()

◆ wall_setThermalResistance()

◆ wall_setHeatTransferCoeff()

◆ wall_setHeatFlux()

◆ wall_setExpansionRateCoeff()

◆ wall_setVelocity()

◆ wall_setEmissivity()

◆ connector_del()

◆ connector_cabinetSize()

◆ connector_parentHandle()