ctconnector.h

Go to the documentation of this file.

/**
 *  CTCONNECTOR - Generated CLib %Cantera interface library.
 *
 *  @file ctconnector.h
 *
 *  Generated CLib API for %Cantera's ConnectorNode 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 CTCONNECTOR_H
#define CTCONNECTOR_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
    /**
     *  @defgroup CAPIctconnector ctconnector Library
     *  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.
     *
     *  @ingroup CAPIindex
     */
 
    /**
     *  @addtogroup CAPIctconnector
     *  @{
     */
 
    /**
     *  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&)`
     *
     *  @param model        String specifying reactor type.
     *  @param r0           Integer handle to ReactorBase object. First reactor.
     *  @param r1           Integer handle to ReactorBase object. Second reactor.
     *  @param name         Name of the connector.
     *  @returns            Handle to stored ConnectorNode object or -1 for exception handling.
     */
    int32_t connector_new(const char* model, int32_t r0, int32_t r1, const char* name);
 
    /**
     *  String indicating the connector implemented.
     *
     *  Wraps C++ getter: `virtual string ConnectorNode::type()`
     *
     *  @param handle       Handle to queried ConnectorNode 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 connector_type(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Retrieve connector name.
     *
     *  Wraps C++ getter: `string ConnectorNode::name()`
     *
     *  @param handle       Handle to queried ConnectorNode 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 connector_name(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Set connector name.
     *
     *  Wraps C++ setter: `void ConnectorNode::setName(const string&)`
     *
     *  @param handle       Handle to queried ConnectorNode object.
     *  @param name         Undocumented.
     */
    int32_t connector_setName(int32_t handle, const char* name);
 
    /**
     *  Set the primary mass flow controller.
     *
     *  Wraps C++ setter: `virtual void FlowDevice::setPrimary(shared_ptr<ConnectorNode>)`
     *
     *  @param handle       Handle to queried FlowDevice object.
     *  @param primary      Integer handle to ConnectorNode object. Undocumented.
     */
    int32_t flowdev_setPrimary(int32_t handle, int32_t primary);
 
    /**
     *  Mass flow rate (kg/s).
     *
     *  Wraps C++ getter: `double FlowDevice::massFlowRate()`
     *
     *  @param handle       Handle to queried FlowDevice object.
     */
    double flowdev_massFlowRate(int32_t handle);
 
    /**
     *  Get the device coefficient (defined by derived class).
     *
     *  Wraps C++ getter: `double FlowDevice::deviceCoefficient()`
     *
     *  @param handle       Handle to queried FlowDevice object.
     */
    double flowdev_deviceCoefficient(int32_t handle);
 
    /**
     *  Set the device coefficient (defined by derived class).
     *
     *  Wraps C++ setter: `void FlowDevice::setDeviceCoefficient(double)`
     *
     *  @param handle       Handle to queried FlowDevice object.
     *  @param c            Undocumented.
     */
    int32_t flowdev_setDeviceCoefficient(int32_t handle, double c);
 
    /**
     *  Set a function of pressure to modify the pressure response.
     *
     *  Wraps C++ setter: `virtual void FlowDevice::setPressureFunction(shared_ptr<Func1>)`
     *
     *  @param handle       Handle to queried FlowDevice object.
     *  @param f            Integer handle to Func1 object. Undocumented.
     */
    int32_t flowdev_setPressureFunction(int32_t handle, int32_t f);
 
    /**
     *  Set a function of time to modulate the mass flow rate.
     *
     *  Wraps C++ setter: `virtual void FlowDevice::setTimeFunction(shared_ptr<Func1>)`
     *
     *  @param handle       Handle to queried FlowDevice object.
     *  @param g            Integer handle to Func1 object. Undocumented.
     */
    int32_t flowdev_setTimeFunction(int32_t handle, int32_t g);
 
    /**
     *  Rate of volume change (m^3/s) for the adjacent reactors at current reactor network time.
     *
     *  Wraps C++ getter: `virtual double WallBase::expansionRate()`
     *
     *  @param handle       Handle to queried WallBase object.
     */
    double wall_expansionRate(int32_t handle);
 
    /**
     *  Heat flow rate through the wall (W) at current reactor network time.
     *
     *  Wraps C++ getter: `virtual double WallBase::heatRate()`
     *
     *  @param handle       Handle to queried WallBase object.
     */
    double wall_heatRate(int32_t handle);
 
    /**
     *  Area in (m^2).
     *
     *  Wraps C++ getter: `double WallBase::area()`
     *
     *  @param handle       Handle to queried WallBase object.
     */
    double wall_area(int32_t handle);
 
    /**
     *  Set the area [m^2].
     *
     *  Wraps C++ setter: `virtual void WallBase::setArea(double)`
     *
     *  @param handle       Handle to queried WallBase object.
     *  @param a            Undocumented.
     */
    int32_t wall_setArea(int32_t handle, double a);
 
    /**
     *  Set the thermal resistance of the wall [K*m^2/W].
     *
     *  Wraps C++ setter: `void Wall::setThermalResistance(double)`
     *
     *  @param handle       Handle to queried Wall object.
     *  @param Rth          Undocumented.
     */
    int32_t wall_setThermalResistance(int32_t handle, double Rth);
 
    /**
     *  Set the overall heat transfer coefficient [W/m^2/K].
     *
     *  Wraps C++ setter: `void Wall::setHeatTransferCoeff(double)`
     *
     *  @param handle       Handle to queried Wall object.
     *  @param U            Undocumented.
     */
    int32_t wall_setHeatTransferCoeff(int32_t handle, double U);
 
    /**
     *  Specify the heat flux function
     *
     *  Wraps C++ setter: `void Wall::setHeatFlux(shared_ptr<Func1>)`
     *
     *  @param handle       Handle to queried Wall object.
     *  @param q            Integer handle to Func1 object. Undocumented.
     */
    int32_t wall_setHeatFlux(int32_t handle, int32_t q);
 
    /**
     *  Set the expansion rate coefficient.
     *
     *  Wraps C++ setter: `void Wall::setExpansionRateCoeff(double)`
     *
     *  @param handle       Handle to queried Wall object.
     *  @param k            Undocumented.
     */
    int32_t wall_setExpansionRateCoeff(int32_t handle, double k);
 
    /**
     *  Set the wall velocity to a specified function of time,
     *
     *  Wraps C++ setter: `void Wall::setVelocity(shared_ptr<Func1>)`
     *
     *  @param handle       Handle to queried Wall object.
     *  @param f            Integer handle to Func1 object. Undocumented.
     */
    int32_t wall_setVelocity(int32_t handle, int32_t f);
 
    /**
     *  Set the emissivity.
     *
     *  Wraps C++ setter: `void Wall::setEmissivity(double)`
     *
     *  @param handle       Handle to queried Wall object.
     *  @param epsilon      Undocumented.
     */
    int32_t wall_setEmissivity(int32_t handle, double epsilon);
 
    /**
     *  Delete ConnectorNode object.
     *
     *  Wraps C++ destructor: `undefined`
     *
     *  @param handle       Handle to ConnectorNode object.
     *  @returns            Zero for success and -1 for exception handling.
     */
    int32_t connector_del(int32_t handle);
 
    /**
     *  Return size of ConnectorNode storage.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @returns            Size or -1 for exception handling.
     */
    int32_t connector_cabinetSize();
 
    /**
     *  Return handle to parent of ConnectorNode object.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @param handle       Handle to queried ConnectorNode object.
     *  @returns            Parent handle or -1 for exception handling.
     */
    int32_t connector_parentHandle(int32_t handle);
 
    /**
     *  @}
     */
 
#ifdef __cplusplus
}
#endif
 
#endif // CTCONNECTOR_H