ctreactornet.h

Go to the documentation of this file.

/**
 *  CTREACTORNET - Generated CLib %Cantera interface library.
 *
 *  @file ctreactornet.h
 *
 *  Generated CLib API for %Cantera's ReactorNet 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 CTREACTORNET_H
#define CTREACTORNET_H
 
#include <stdint.h>  // for 32-bit int32_t / 64-bit int64_t
 
#ifdef __cplusplus
extern "C" {
#endif
 
    /**
     *  @defgroup CAPIctreactornet ctreactornet Library
     *  Generated CLib API for %Cantera's ReactorNet class.
     *
     *  @warning  This library is an experimental part of the %Cantera API and
     *      may be changed or removed without notice.
     *
     *  @ingroup CAPIindex
     */
 
    /**
     *  @addtogroup CAPIctreactornet
     *  @{
     */
 
    /**
     *  Create a reactor network containing one or more coupled reactors.
     *
     *  Wraps C++ constructor: `shared_ptr<ReactorNet> newReactorNet(span<shared_ptr<ReactorBase>>)`
     *
     *  @param[in] reactorsLen Length of array reserved for reactors.
     *  @param reactors     Memory holding ReactorBase objects. A vector of shared pointers to the reactors to be linked together.
     *  @returns            Handle to stored ReactorNet object or -1 for exception handling.
     */
    int32_t reactornet_new(int32_t reactorsLen, int32_t* reactors);
 
    /**
     *  Set the initial value of the independent variable (typically time).
     *
     *  Wraps C++ setter: `void ReactorNet::setInitialTime(double)`
     *
     *  @param handle       Handle to queried ReactorNet object.
     *  @param time         Undocumented.
     */
    int32_t reactornet_setInitialTime(int32_t handle, double time);
 
    /**
     *  Set the maximum integrator step.
     *
     *  Wraps C++ setter: `void ReactorNet::setMaxTimeStep(double)`
     *
     *  @param handle       Handle to queried ReactorNet object.
     *  @param maxstep      Undocumented.
     */
    int32_t reactornet_setMaxTimeStep(int32_t handle, double maxstep);
 
    /**
     *  Set the relative tolerance for the integrator.
     *
     *  Wraps C++ setter: `void ReactorNet::setRelativeTolerance(double)`
     *
     *  @param handle       Handle to queried ReactorNet object.
     *  @param rtol         Relative tolerance for all state variables; must be positive.
     */
    int32_t reactornet_setRelativeTolerance(int32_t handle, double rtol);
 
    /**
     *  Set the scalar absolute tolerance for the integrator.
     *
     *  Wraps C++ setter: `void ReactorNet::setAbsoluteTolerance(double)`
     *
     *  @param handle       Handle to queried ReactorNet object.
     *  @param atol         Scalar absolute tolerance for state variables without reactor-specific absolute tolerances; must be positive. Superseded by absolute tolerances set for individual reactors.
     */
    int32_t reactornet_setAbsoluteTolerance(int32_t handle, double atol);
 
    /**
     *  Clear the user-specified scalar absolute tolerance.
     *
     *  Wraps C++ method: `void ReactorNet::clearAbsoluteTolerance()`
     *
     *  @param handle       Handle to queried ReactorNet object.
     */
    int32_t reactornet_clearAbsoluteTolerance(int32_t handle);
 
    /**
     *  Set the relative and scalar absolute tolerances for the integrator.
     *
     *  Wraps C++ method: `void ReactorNet::setTolerances(double, double)`
     *
     *  @param handle       Handle to queried ReactorNet object.
     *  @param rtol         If positive, set the relative tolerance for all state variables; ignored if negative.
     *  @param atol         If positive, set the scalar absolute tolerance for all state variables; ignored if negative. Superseded by absolute tolerances set for individual reactors.
     *
     *  @deprecated Per C++ annotation: To be removed after Cantera 4.0. Use setRelativeTolerance() and setAbsoluteTolerance() instead.
     */
    int32_t reactornet_setTolerances(int32_t handle, double rtol, double atol);
 
    /**
     *  Set the relative and absolute tolerances for integrating the sensitivity equations.
     *
     *  Wraps C++ method: `void ReactorNet::setSensitivityTolerances(double, double)`
     *
     *  @param handle       Handle to queried ReactorNet object.
     *  @param rtol         Undocumented.
     *  @param atol         Undocumented.
     */
    int32_t reactornet_setSensitivityTolerances(int32_t handle, double rtol, double atol);
 
    /**
     *  Advance the state of all reactors in the independent variable (time or space).
     *
     *  Wraps C++ setter: `void ReactorNet::advance(double)`
     *
     *  @param handle       Handle to queried ReactorNet object.
     *  @param t            Time/distance to advance to (s or m).
     */
    int32_t reactornet_advance(int32_t handle, double t);
 
    /**
     *  Advance the state of all reactors with respect to the independent variable (time or space).
     *
     *  Wraps C++ getter: `double ReactorNet::step()`
     *
     *  @param handle       Handle to queried ReactorNet object.
     */
    double reactornet_step(int32_t handle);
 
    /**
     *  Current value of the simulation time [s], for reactor networks that are solved in the time domain.
     *
     *  Wraps C++ getter: `double ReactorNet::time()`
     *
     *  @param handle       Handle to queried ReactorNet object.
     */
    double reactornet_time(int32_t handle);
 
    /**
     *  Relative tolerance.
     *
     *  Wraps C++ getter: `double ReactorNet::rtol()`
     *
     *  @param handle       Handle to queried ReactorNet object.
     */
    double reactornet_rtol(int32_t handle);
 
    /**
     *  Scalar absolute integration tolerance.
     *
     *  Wraps C++ getter: `double ReactorNet::atol()`
     *
     *  @param handle       Handle to queried ReactorNet object.
     */
    double reactornet_atol(int32_t handle);
 
    /**
     *  Return the sensitivity of the component named *component* with respect to the *p*-th sensitivity parameter.
     *
     *  Wraps C++ method: `double ReactorNet::sensitivity(const string&, size_t, int)`
     *
     *  @param handle       Handle to queried ReactorNet object.
     *  @param component    Undocumented.
     *  @param p            Undocumented.
     *  @param reactor      Undocumented.
     */
    double reactornet_sensitivity(int32_t handle, const char* component, int32_t p, int32_t reactor);
 
    /**
     *  Number of equations.
     *
     *  Wraps C++ getter: `size_t ReactorNet::neq()`
     *
     *  @param handle       Handle to queried ReactorNet object.
     */
    int32_t reactornet_neq(int32_t handle);
 
    /**
     *  Fill in the vector *y* with the current state of the system.
     *
     *  Wraps C++ getter: `void ReactorNet::getState(span<double>)`
     *
     *  @param handle       Handle to queried ReactorNet object.
     *  @param[in] yLen     Length of vector reserved for y.
     *  @param y            Undocumented.
     */
    int32_t reactornet_getState(int32_t handle, int32_t yLen, double* y);
 
    /**
     *  Return the name of the i-th component of the global state vector.
     *
     *  Wraps C++ method: `string ReactorNet::componentName(size_t)`
     *
     *  Uses:
     *  - `size_t ReactorNet::neq()`
     *
     *  @param handle       Handle to queried ReactorNet object.
     *  @param i            Undocumented.
     *  @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 reactornet_componentName(int32_t handle, int32_t i, int32_t bufLen, char* buf);
 
    /**
     *  Delete ReactorNet object.
     *
     *  Wraps C++ destructor: `undefined`
     *
     *  @param handle       Handle to ReactorNet object.
     *  @returns            Zero for success and -1 for exception handling.
     */
    int32_t reactornet_del(int32_t handle);
 
    /**
     *  Return size of ReactorNet storage.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @returns            Size or -1 for exception handling.
     */
    int32_t reactornet_cabinetSize();
 
    /**
     *  @}
     */
 
#ifdef __cplusplus
}
#endif
 
#endif // CTREACTORNET_H