interfaces/clib/include/cantera_clib/ctreactor.h

Go to the documentation of this file.

/**
 *  CTREACTOR - Generated CLib %Cantera interface library.
 *
 *  @file ctreactor.h
 *
 *  Generated CLib API for %Cantera's ReactorBase 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 CTREACTOR_H
#define CTREACTOR_H
 
#include <stdint.h>  // for 32-bit int32_t / 64-bit int64_t
 
#ifdef __cplusplus
extern "C" {
#endif
 
    /**
     *  @defgroup CAPIctreactor ctreactor Library
     *  Generated CLib API for %Cantera's ReactorBase class.
     *
     *  @warning  This library is an experimental part of the %Cantera API and
     *      may be changed or removed without notice.
     *
     *  @ingroup CAPIindex
     */
 
    /**
     *  @addtogroup CAPIctreactor
     *  @{
     */
 
    /**
     *  Create a ReactorBase object of the specified type and contents.
     *
     *  Wraps C++ constructor: `shared_ptr<ReactorBase> newReactorBase(const string&, shared_ptr<Solution>, bool, const string&)`
     *
     *  @param model        Undocumented.
     *  @param phase        Integer handle to Solution object. Undocumented.
     *  @param clone        Undocumented.
     *  @param name         Undocumented.
     *  @returns            Handle to stored ReactorBase object or -1 for exception handling.
     */
    int32_t reactor_new(const char* model, int32_t phase, int32_t clone, const char* name);
 
    /**
     *  Create a ReactorSurface object with the specified contents and adjacent reactors participating in surface reactions.
     *
     *  Wraps C++ constructor: `shared_ptr<ReactorSurface> newReactorSurface(shared_ptr<Solution>, const vector<shared_ptr<ReactorBase>>&, bool, const string&)`
     *
     *  @param phase        Integer handle to Solution object. Solution (Interface) object to model the thermodynamic properties and reactions occurring in the reactor
     *  @param[in] reactorsLen Length of array reserved for reactors.
     *  @param reactors     Memory holding ReactorBase objects. List of Reactors adjacent to this surface, whose contents participate in reactions occurring on this surface.
     *  @param clone        Determines whether to clone `sol` so that the internal state of this surface is independent of the original Interface object and any Solution objects used by other reactors in the network except those in the `reactors` list.
     *  @param name         Name of the reactor surface.
     *  @returns            Handle to stored ReactorSurface object or -1 for exception handling.
     */
    int32_t reactor_newSurface(int32_t phase, int32_t reactorsLen, const int32_t* reactors, int32_t clone, const char* name);
 
    /**
     *  String indicating the reactor model implemented.
     *
     *  Wraps C++ getter: `virtual string ReactorBase::type()`
     *
     *  @param handle       Handle to queried ReactorBase 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 reactor_type(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Return the name of this reactor.
     *
     *  Wraps C++ getter: `string ReactorBase::name()`
     *
     *  @param handle       Handle to queried ReactorBase 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 reactor_name(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Set the name of this reactor.
     *
     *  Wraps C++ setter: `void ReactorBase::setName(const string&)`
     *
     *  @param handle       Handle to queried ReactorBase object.
     *  @param name         Undocumented.
     */
    int32_t reactor_setName(int32_t handle, const char* name);
 
    /**
     *  Access the Solution object used to represent the contents of this reactor.
     *
     *  Wraps C++ accessor: `shared_ptr<Solution> ReactorBase::phase()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     *  @returns            Handle to stored Solution object or -1 for exception handling.
     */
    int32_t reactor_phase(int32_t handle);
 
    /**
     *  Set the initial reactor volume.
     *
     *  Wraps C++ setter: `virtual void ReactorBase::setInitialVolume(double)`
     *
     *  @param handle       Handle to queried ReactorBase object.
     *  @param vol          Undocumented.
     */
    int32_t reactor_setInitialVolume(int32_t handle, double vol);
 
    /**
     *  Returns an area associated with a reactor [m²].
     *
     *  Wraps C++ getter: `virtual double ReactorBase::area()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     */
    double reactor_area(int32_t handle);
 
    /**
     *  Set an area associated with a reactor [m²].
     *
     *  Wraps C++ setter: `virtual void ReactorBase::setArea(double)`
     *
     *  @param handle       Handle to queried ReactorBase object.
     *  @param a            Undocumented.
     */
    int32_t reactor_setArea(int32_t handle, double a);
 
    /**
     *  Returns `true` if changes in the reactor composition due to chemical reactions are enabled.
     *
     *  Wraps C++ getter: `virtual bool ReactorBase::chemistryEnabled()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     */
    int32_t reactor_chemistryEnabled(int32_t handle);
 
    /**
     *  Enable or disable changes in reactor composition due to chemical reactions.
     *
     *  Wraps C++ setter: `virtual void ReactorBase::setChemistryEnabled(bool)`
     *
     *  @param handle       Handle to queried ReactorBase object.
     *  @param cflag        Undocumented.
     */
    int32_t reactor_setChemistryEnabled(int32_t handle, int32_t cflag);
 
    /**
     *  Returns `true` if solution of the energy equation is enabled.
     *
     *  Wraps C++ getter: `virtual bool ReactorBase::energyEnabled()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     */
    int32_t reactor_energyEnabled(int32_t handle);
 
    /**
     *  Set the energy equation on or off.
     *
     *  Wraps C++ setter: `virtual void ReactorBase::setEnergyEnabled(bool)`
     *
     *  @param handle       Handle to queried ReactorBase object.
     *  @param eflag        Undocumented.
     */
    int32_t reactor_setEnergyEnabled(int32_t handle, int32_t eflag);
 
    /**
     *  Returns the mass (kg) of the reactor's contents.
     *
     *  Wraps C++ getter: `double ReactorBase::mass()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     */
    double reactor_mass(int32_t handle);
 
    /**
     *  Returns the current volume (m^3) of the reactor.
     *
     *  Wraps C++ getter: `double ReactorBase::volume()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     */
    double reactor_volume(int32_t handle);
 
    /**
     *  Returns the current density (kg/m^3) of the reactor's contents.
     *
     *  Wraps C++ getter: `double ReactorBase::density()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     */
    double reactor_density(int32_t handle);
 
    /**
     *  Returns the current temperature (K) of the reactor's contents.
     *
     *  Wraps C++ getter: `double ReactorBase::temperature()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     */
    double reactor_temperature(int32_t handle);
 
    /**
     *  Returns the current enthalpy (J/kg) of the reactor's contents.
     *
     *  Wraps C++ getter: `double ReactorBase::enthalpy_mass()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     */
    double reactor_enthalpy_mass(int32_t handle);
 
    /**
     *  Returns the current internal energy (J/kg) of the reactor's contents.
     *
     *  Wraps C++ getter: `double ReactorBase::intEnergy_mass()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     *
     *  @deprecated Per C++ annotation: To be removed after Cantera 3.2.
     */
    double reactor_intEnergy_mass(int32_t handle);
 
    /**
     *  Returns the current pressure (Pa) of the reactor.
     *
     *  Wraps C++ getter: `double ReactorBase::pressure()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     */
    double reactor_pressure(int32_t handle);
 
    /**
     *  Return the mass fraction of the *k*-th species.
     *
     *  Wraps C++ method: `double ReactorBase::massFraction(size_t)`
     *
     *  @param handle       Handle to queried ReactorBase object.
     *  @param k            Undocumented.
     */
    double reactor_massFraction(int32_t handle, int32_t k);
 
    /**
     *  Return the vector of species mass fractions.
     *
     *  Wraps C++ getter: `const double* ReactorBase::massFractions()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned array value.
     *  @returns            Actual length of value array or -1 for exception handling.
     */
    int32_t reactor_massFractions(int32_t handle, int32_t bufLen, double* buf);
 
    /**
     *  Number of sensitivity parameters associated with this reactor.
     *
     *  Wraps C++ getter: `virtual size_t ReactorBase::nSensParams()`
     *
     *  @param handle       Handle to queried ReactorBase object.
     */
    int32_t reactor_nSensParams(int32_t handle);
 
    /**
     *  Add a sensitivity parameter associated with the reaction number *rxn*
     *
     *  Wraps C++ setter: `virtual void ReactorBase::addSensitivityReaction(size_t)`
     *
     *  @param handle       Handle to queried ReactorBase object.
     *  @param rxn          Undocumented.
     */
    int32_t reactor_addSensitivityReaction(int32_t handle, int32_t rxn);
 
    /**
     *  Add a ReactorSurface object to a Reactor object.
     *
     *  Wraps C++ setter: `void ReactorBase::addSurface(shared_ptr<ReactorBase>)`
     *
     *  @param handle       Handle to queried ReactorBase object.
     *  @param surf         Integer handle to ReactorBase object. Undocumented.
     *
     *  @deprecated Per C++ annotation: Unused. To be removed after Cantera 3.2.
     */
    int32_t reactor_addSurface(int32_t handle, int32_t surf);
 
    /**
     *  Mass flow rate through the reactor [kg/s].
     *
     *  Wraps C++ getter: `double FlowReactor::massFlowRate()`
     *
     *  @param handle       Handle to queried FlowReactor object.
     */
    double reactor_massFlowRate(int32_t handle);
 
    /**
     *  Set the mass flow rate through the reactor [kg/s].
     *
     *  Wraps C++ setter: `void FlowReactor::setMassFlowRate(double)`
     *
     *  @param handle       Handle to queried FlowReactor object.
     *  @param mdot         Undocumented.
     */
    int32_t reactor_setMassFlowRate(int32_t handle, double mdot);
 
    /**
     *  Delete ReactorBase object.
     *
     *  Wraps C++ destructor: `undefined`
     *
     *  @param handle       Handle to ReactorBase object.
     *  @returns            Zero for success and -1 for exception handling.
     */
    int32_t reactor_del(int32_t handle);
 
    /**
     *  Return size of ReactorBase storage.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @returns            Size or -1 for exception handling.
     */
    int32_t reactor_cabinetSize();
 
    /**
     *  @}
     */
 
#ifdef __cplusplus
}
#endif
 
#endif // CTREACTOR_H