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

Collaboration diagram for cttrans Library:

Detailed Description

Generated CLib API for Cantera's Transport class.

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

Functions
int32_t	trans_transportModel (int32_t handle, int32_t bufLen, char *buf)
	Identifies the model represented by this Transport object.

double	trans_viscosity (int32_t handle)
	Get the dynamic viscosity [Pa·s].

double	trans_thermalConductivity (int32_t handle)
	Get the mixture thermal conductivity [W/m/K].

double	trans_electricalConductivity (int32_t handle)
	Get the electrical conductivity [siemens/m].

int32_t	trans_getThermalDiffCoeffs (int32_t handle, int32_t dtLen, double *dt)
	Return a vector of thermal diffusion coefficients [kg/m/s].

int32_t	trans_getMixDiffCoeffs (int32_t handle, int32_t dLen, double *d)
	Return a vector of mixture averaged diffusion coefficients [m²/s].

int32_t	trans_getBinaryDiffCoeffs (int32_t handle, const int32_t ld, int32_t dLen, double *d)
	Returns the matrix of binary diffusion coefficients [m²/s].

int32_t	trans_getMultiDiffCoeffs (int32_t handle, const int32_t ld, int32_t dLen, double *d)
	Return the multicomponent diffusion coefficients [m²/s].

int32_t	trans_getMolarFluxes (int32_t handle, int32_t state1Len, const double state1, int32_t state2Len, const double state2, const double delta, int32_t cfluxesLen, double *cfluxes)
	Get the molar fluxes [kmol/m²/s], given the thermodynamic state at two nearby points.

int32_t	trans_getMassFluxes (int32_t handle, int32_t state1Len, const double state1, int32_t state2Len, const double state2, double delta, int32_t mfluxesLen, double *mfluxes)
	Get the mass fluxes [kg/m²/s], given the thermodynamic state at two nearby points.

int32_t	trans_del (int32_t handle)
	Destructor; required by some APIs although object is managed by Solution.

int32_t	trans_cabinetSize ()
	Return size of Transport storage.

int32_t	trans_parentHandle (int32_t handle)
	Return handle to parent of Transport object.

Function Documentation

◆ trans_transportModel()

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

Identifies the model represented by this Transport object.

Wraps C++ getter: virtual string Transport::transportModel()

Parameters

	handle	Handle to queried Transport 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 37 of file cttrans.cpp.

◆ trans_viscosity()

double trans_viscosity ( int32_t handle )

Get the dynamic viscosity [Pa·s].

Wraps C++ getter: virtual double Transport::viscosity()

Parameters

handle Handle to queried Transport object.

Definition at line 49 of file cttrans.cpp.

◆ trans_thermalConductivity()

double trans_thermalConductivity ( int32_t handle )

Get the mixture thermal conductivity [W/m/K].

Wraps C++ getter: virtual double Transport::thermalConductivity()

Parameters

handle Handle to queried Transport object.

Definition at line 59 of file cttrans.cpp.

◆ trans_electricalConductivity()

double trans_electricalConductivity ( int32_t handle )

Get the electrical conductivity [siemens/m].

Wraps C++ getter: virtual double Transport::electricalConductivity()

Parameters

handle Handle to queried Transport object.

Definition at line 69 of file cttrans.cpp.

◆ trans_getThermalDiffCoeffs()

int32_t trans_getThermalDiffCoeffs	(	int32_t	handle,
		int32_t	dtLen,
		double *	dt
	)

Return a vector of thermal diffusion coefficients [kg/m/s].

Wraps C++ getter: virtual void Transport::getThermalDiffCoeffs(double* const)

Parameters

	handle	Handle to queried Transport object.
[in]	dtLen	Length of array reserved for dt.
	dt	On return, dt will contain the species thermal diffusion coefficients. Dimension dt at least as large as the number of species.

Definition at line 79 of file cttrans.cpp.

◆ trans_getMixDiffCoeffs()

int32_t trans_getMixDiffCoeffs	(	int32_t	handle,
		int32_t	dLen,
		double *	d
	)

Return a vector of mixture averaged diffusion coefficients [m²/s].

Wraps C++ getter: virtual void Transport::getMixDiffCoeffs(double* const)

Parameters

	handle	Handle to queried Transport object.
[in]	dLen	Length of array reserved for d.
	d	Return vector of mixture averaged diffusion coefficients; length is the number of species.

Definition at line 92 of file cttrans.cpp.

◆ trans_getBinaryDiffCoeffs()

int32_t trans_getBinaryDiffCoeffs	(	int32_t	handle,
		const int32_t	ld,
		int32_t	dLen,
		double *	d
	)

Returns the matrix of binary diffusion coefficients [m²/s].

Wraps C++ method: virtual void Transport::getBinaryDiffCoeffs(const size_t, double* const)

Parameters

	handle	Handle to queried Transport object.
[in]	ld	Leading dimension of the flattened array
[in]	dLen	Length of array reserved for d.
[out]	d	Diffusion coefficient matrix stored in column-major (Fortran) order, such that

Definition at line 105 of file cttrans.cpp.

◆ trans_getMultiDiffCoeffs()

int32_t trans_getMultiDiffCoeffs	(	int32_t	handle,
		const int32_t	ld,
		int32_t	dLen,
		double *	d
	)

Return the multicomponent diffusion coefficients [m²/s].

Wraps C++ method: virtual void Transport::getMultiDiffCoeffs(const size_t, double* const)

Parameters

	handle	Handle to queried Transport object.
[in]	ld	Leading dimension of the flattened array
[in]	dLen	Length of array reserved for d.
[out]	d	Diffusion coefficient matrix stored in column-major (Fortran) order, such that

Definition at line 116 of file cttrans.cpp.

◆ trans_getMolarFluxes()

int32_t trans_getMolarFluxes	(	int32_t	handle,
		int32_t	state1Len,
		const double *	state1,
		int32_t	state2Len,
		const double *	state2,
		const double	delta,
		int32_t	cfluxesLen,
		double *	cfluxes
	)

Get the molar fluxes [kmol/m²/s], given the thermodynamic state at two nearby points.

Wraps C++ method: virtual void Transport::getMolarFluxes(const double* const, const double* const, const double, double* const)

Parameters

	handle	Handle to queried Transport object.
[in]	state1Len	Length of array reserved for state1.
[in]	state1	Array of temperature, density, and mass fractions for state 1.
[in]	state2Len	Length of array reserved for state2.
[in]	state2	Array of temperature, density, and mass fractions for state 2.
[in]	delta	Distance [m] from state 1 to state 2.
[in]	cfluxesLen	Length of array reserved for cfluxes.
[out]	cfluxes	Array containing the diffusive molar fluxes of species from

Definition at line 127 of file cttrans.cpp.

◆ trans_getMassFluxes()

int32_t trans_getMassFluxes	(	int32_t	handle,
		int32_t	state1Len,
		const double *	state1,
		int32_t	state2Len,
		const double *	state2,
		double	delta,
		int32_t	mfluxesLen,
		double *	mfluxes
	)

Get the mass fluxes [kg/m²/s], given the thermodynamic state at two nearby points.

Wraps C++ method: virtual void Transport::getMassFluxes(const double*, const double*, double, double*)

Parameters

	handle	Handle to queried Transport object.
[in]	state1Len	Length of array reserved for state1.
[in]	state1	Array of temperature, density, and mass fractions for state 1.
[in]	state2Len	Length of array reserved for state2.
[in]	state2	Array of temperature, density, and mass fractions for state 2.
[in]	delta	Distance [m] from state 1 to state 2.
[in]	mfluxesLen	Length of array reserved for mfluxes.
[out]	mfluxes	Array containing the diffusive mass fluxes of species from

Definition at line 138 of file cttrans.cpp.

◆ trans_del()

int32_t trans_del ( int32_t handle )

Destructor; required by some APIs although object is managed by Solution.

Wraps C++ noop: undefined

Parameters

handle Handle to Transport object.

Returns: Always zero.

Definition at line 149 of file cttrans.cpp.

◆ trans_cabinetSize()

int32_t trans_cabinetSize ( )

Return size of Transport storage.

Wraps C++ reserved CLib function: custom code

Returns: Size or -1 for exception handling.

Definition at line 155 of file cttrans.cpp.

◆ trans_parentHandle()

int32_t trans_parentHandle ( int32_t handle )

Return handle to parent of Transport object.

Wraps C++ reserved CLib function: custom code

Parameters

handle Handle to queried Transport object.

Returns: Parent handle or -1 for exception handling.

Definition at line 167 of file cttrans.cpp.

Detailed Description

Functions

Function Documentation

◆ trans_transportModel()

◆ trans_viscosity()

◆ trans_thermalConductivity()

◆ trans_electricalConductivity()

◆ trans_getThermalDiffCoeffs()

◆ trans_getMixDiffCoeffs()

◆ trans_getBinaryDiffCoeffs()

◆ trans_getMultiDiffCoeffs()

◆ trans_getMolarFluxes()

◆ trans_getMassFluxes()

◆ trans_del()

◆ trans_cabinetSize()

◆ trans_parentHandle()