interfaces/clib/include/cantera_clib/ctfunc.h

Go to the documentation of this file.

/**
 *  CTFUNC - Generated CLib %Cantera interface library.
 *
 *  @file ctfunc.h
 *
 *  Generated CLib API for %Cantera's Func1 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 CTFUNC_H
#define CTFUNC_H
 
#include <stdint.h>  // for 32-bit int32_t / 64-bit int64_t
 
#ifdef __cplusplus
extern "C" {
#endif
 
    /**
     *  @defgroup CAPIctfunc ctfunc Library
     *  Generated CLib API for %Cantera's Func1 class.
     *
     *  @warning  This library is an experimental part of the %Cantera API and
     *      may be changed or removed without notice.
     *
     *  @ingroup CAPIindex
     */
 
    /**
     *  @addtogroup CAPIctfunc
     *  @{
     */
 
    /**
     *  Check definition of functor object.
     *
     *  Wraps C++ function: `string checkFunc1(const string&)`
     *
     *  @param func1Type    String identifying functor type.
     *  @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 func1_checkFunc1(const char* func1Type, int32_t bufLen, char* buf);
 
    /**
     *  Create a new basic functor object (see Basic Functors).
     *
     *  Wraps C++ constructor: `shared_ptr<Func1> newFunc1(const string&, double)`
     *
     *  @param func1Type    String identifying functor type.
     *  @param coeff        Coefficient; definition depends on functor type.
     *  @returns            Handle to stored Func1 object or -1 for exception handling.
     */
    int32_t func1_newBasic(const char* func1Type, double coeff);
 
    /**
     *  Create a new advanced functor object (see Advanced Functors).
     *
     *  Wraps C++ constructor: `shared_ptr<Func1> newFunc1(const string&, const vector<double>&)`
     *
     *  @param func1Type    String identifying functor type.
     *  @param[in] arrLen   Length of vector reserved for arr.
     *  @param arr          Parameter vector; definition depends on functor type.
     *  @returns            Handle to stored Func1 object or -1 for exception handling.
     */
    int32_t func1_newAdvanced(const char* func1Type, int32_t arrLen, const double* arr);
 
    /**
     *  Create a new compound functor object (see Compound Functors).
     *
     *  Wraps C++ constructor: `shared_ptr<Func1> newFunc1(const string&, const shared_ptr<Func1>, const shared_ptr<Func1>)`
     *
     *  @param func1Type    String identifying functor type.
     *  @param f1           Integer handle to Func1 object. First Func1 object.
     *  @param f2           Integer handle to Func1 object. Second Func1 object.
     *  @returns            Handle to stored Func1 object or -1 for exception handling.
     */
    int32_t func1_newCompound(const char* func1Type, const int32_t f1, const int32_t f2);
 
    /**
     *  Create a new modified functor object (see Modified Functors).
     *
     *  Wraps C++ constructor: `shared_ptr<Func1> newFunc1(const string&, const shared_ptr<Func1>, double)`
     *
     *  @param func1Type    String identifying functor type.
     *  @param f            Integer handle to Func1 object. Func1 object.
     *  @param coeff        Coefficient; definition depends on functor type.
     *  @returns            Handle to stored Func1 object or -1 for exception handling.
     */
    int32_t func1_newModified(const char* func1Type, const int32_t f, double coeff);
 
    /**
     *  Sum of two functions.
     *
     *  Wraps C++ constructor: `shared_ptr<Func1> newSumFunction(shared_ptr<Func1>, shared_ptr<Func1>)`
     *
     *  @param f1           Integer handle to Func1 object. Undocumented.
     *  @param f2           Integer handle to Func1 object. Undocumented.
     *  @returns            Handle to stored Func1 object or -1 for exception handling.
     */
    int32_t func1_newSumFunction(int32_t f1, int32_t f2);
 
    /**
     *  Difference of two functions.
     *
     *  Wraps C++ constructor: `shared_ptr<Func1> newDiffFunction(shared_ptr<Func1>, shared_ptr<Func1>)`
     *
     *  @param f1           Integer handle to Func1 object. Undocumented.
     *  @param f2           Integer handle to Func1 object. Undocumented.
     *  @returns            Handle to stored Func1 object or -1 for exception handling.
     */
    int32_t func1_newDiffFunction(int32_t f1, int32_t f2);
 
    /**
     *  Product of two functions.
     *
     *  Wraps C++ constructor: `shared_ptr<Func1> newProdFunction(shared_ptr<Func1>, shared_ptr<Func1>)`
     *
     *  @param f1           Integer handle to Func1 object. Undocumented.
     *  @param f2           Integer handle to Func1 object. Undocumented.
     *  @returns            Handle to stored Func1 object or -1 for exception handling.
     */
    int32_t func1_newProdFunction(int32_t f1, int32_t f2);
 
    /**
     *  Ratio of two functions.
     *
     *  Wraps C++ constructor: `shared_ptr<Func1> newRatioFunction(shared_ptr<Func1>, shared_ptr<Func1>)`
     *
     *  @param f1           Integer handle to Func1 object. Undocumented.
     *  @param f2           Integer handle to Func1 object. Undocumented.
     *  @returns            Handle to stored Func1 object or -1 for exception handling.
     */
    int32_t func1_newRatioFunction(int32_t f1, int32_t f2);
 
    /**
     *  Returns a string describing the type of the function.
     *
     *  Wraps C++ getter: `virtual string Func1::type()`
     *
     *  @param handle       Handle to queried Func1 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 func1_type(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Evaluate the function.
     *
     *  Wraps C++ method: `virtual double Func1::eval(double)`
     *
     *  @param handle       Handle to queried Func1 object.
     *  @param t            Undocumented.
     */
    double func1_eval(int32_t handle, double t);
 
    /**
     *  Creates a derivative to the current function.
     *
     *  Wraps C++ accessor: `virtual shared_ptr<Func1> Func1::derivative()`
     *
     *  @param handle       Handle to queried Func1 object.
     *  @returns            Handle to stored Func1 object or -1 for exception handling.
     */
    int32_t func1_derivative(int32_t handle);
 
    /**
     *  Write LaTeX string describing function.
     *
     *  Wraps C++ method: `virtual string Func1::write(const string&)`
     *
     *  @param handle       Handle to queried Func1 object.
     *  @param arg          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 func1_write(int32_t handle, const char* arg, int32_t bufLen, char* buf);
 
    /**
     *  Delete Func1 object.
     *
     *  Wraps C++ destructor: `undefined`
     *
     *  @param handle       Handle to Func1 object.
     *  @returns            Zero for success and -1 for exception handling.
     */
    int32_t func1_del(int32_t handle);
 
    /**
     *  Return size of Func1 storage.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @returns            Size or -1 for exception handling.
     */
    int32_t func1_cabinetSize();
 
    /**
     *  @}
     */
 
#ifdef __cplusplus
}
#endif
 
#endif // CTFUNC_H