lua_user_data.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 */
 
 
#ifndef __H__UG_BRIDGE__BRIDGES__USER_DATA__USER_DATA__
#define __H__UG_BRIDGE__BRIDGES__USER_DATA__USER_DATA__
 
#include <stdarg.h>
#include <string>
#include "registry/registry.h"
 
 
 
 
#ifndef USE_LUAJIT
extern "C" {
#include "externals/lua/lua.h"
}
#else
#include <lua.hpp>
#endif
 
 
 
#include "lua_util.h"
 
#include "common/common.h"
#include "common/math/ugmath.h"
#include "lib_disc/spatial_disc/user_data/user_data.h"
#include "lib_disc/spatial_disc/user_data/std_glob_pos_data.h"
#include "lib_disc/spatial_disc/user_data/user_function.h"
#include "lib_disc/spatial_disc/user_data/linker/linker.h"
#include "lua_traits.h"
 
#include "bindings/lua/lua_function_handle.h"
 
#ifdef USE_LUA2C
#include "bindings/lua/compiler/lua_compiler.h"
#endif
 
namespace ug
{
 
// LuaUserData
 
bool CheckLuaCallbackName(const char* name);
 
// predeclaration
template <typename TData, int dim, typename TRet = void>
class LuaUserDataFactory;
 
 
template <typename TData, int dim, typename TRet = void>
class LuaUserData
  : public StdGlobPosData<LuaUserData<TData, dim, TRet>, TData, dim, TRet>
{
    friend class LuaUserDataFactory<TData, dim, TRet>;
 
  public:
 
    LuaUserData(const char* luaCallback);
    LuaUserData(LuaFunctionHandle handle);
 
    virtual ~LuaUserData();
 
    static std::string signature();
 
    static std::string name();
 
    static bool check_callback_returns(const char* callName,
                       const bool bThrow = false);
 
    static bool check_callback_returns(LuaFunctionHandle handle,
                       const bool bThrow = false);
 
    static bool check_callback_returns(lua_State* L, int callbackRef, const char* callName,
                                       const bool bThrow = false);
 
    inline TRet evaluate(TData& D, const MathVector<dim>& x, number time, int si) const;
 
  protected:
    void set_created_from_factory(bool bFromFactory) {m_bFromFactory = bFromFactory;}
 
  protected:
    std::string m_callbackName;
 
    int m_callbackRef;
    
    #ifdef USE_LUA2C
      bridge::LUACompiler m_luaComp;
    #endif
    bool m_bFromFactory;
 
    lua_State*  m_L;
};
 
// LuaUserDataFactory
 
 
template <typename TData, int dim, typename TRet>
class LuaUserDataFactory
{
  friend class LuaUserData<TData,dim,TRet>;
 
  protected:
    LuaUserDataFactory(){};
 
  //  disallow copy
    LuaUserDataFactory(const LuaUserDataFactory&);
    LuaUserDataFactory& operator=(const LuaUserDataFactory&);
 
    static LuaUserDataFactory<TData,dim,TRet>& instance()
    {
      static LuaUserDataFactory<TData,dim,TRet> inst;
      return inst;
    }
 
    static SmartPtr<LuaUserData<TData,dim,TRet> > provide_or_create(
        const std::string& name);
 
    static void remove(const std::string& name);
 
    static std::map<std::string, std::pair<LuaUserData<TData,dim,TRet>*, int*> > m_mData;
 
  public:
    static SmartPtr<LuaUserData<TData,dim,TRet> > create(const std::string& name)
    {
      return instance().provide_or_create(name);
    }
};
 
// LuaUserFunction
 
 
template <typename TData, int dim, typename TDataIn>
class LuaUserFunction
  : public StdDataLinker<LuaUserFunction<TData, dim, TDataIn>, TData, dim>
{
  public:
  //  type of base class
    typedef StdDataLinker<LuaUserFunction<TData, dim, TDataIn>, TData, dim> base_type;
    using base_type::set_input;
 
  public:
    LuaUserFunction(const char* luaCallback, size_t numArgs);
    LuaUserFunction(const char* luaCallback, size_t numArgs, bool bPosTimeNeed);
    LuaUserFunction(LuaFunctionHandle handle, size_t numArgs);
    LuaUserFunction(LuaFunctionHandle handle, size_t numArgs, bool bPosTimeNeed);
 
    virtual ~LuaUserFunction();
 
    void set_deriv(size_t arg, const char* luaCallback);
    void set_deriv(size_t arg, LuaFunctionHandle handle);
 
 
    void set_num_input(size_t num);
 
    void set_input(size_t i, SmartPtr<CplUserData<TDataIn, dim> > data);
    void set_input(size_t i, number val);
 
    void set_input_and_deriv(size_t i, SmartPtr<CplUserData<TDataIn, dim> > input, LuaFunctionHandle deriv)
    { set_input(i, input); set_deriv(i, deriv); }
 
    virtual void operator() (TData& out, int numArgs, ...) const;
 
    inline void evaluate (TData& value,
                          const MathVector<dim>& globIP,
                          number time, int si) const;
 
    template <int refDim>
    inline void evaluate(TData vValue[],
                         const MathVector<dim> vGlobIP[],
                         number time, int si,
                         GridObject* elem,
                         const MathVector<dim> vCornerCoords[],
                         const MathVector<refDim> vLocIP[],
                         const size_t nip,
                         LocalVector* u,
                         const MathMatrix<refDim, dim>* vJT = NULL) const;
 
    template <int refDim>
    void eval_and_deriv(TData vValue[],
                        const MathVector<dim> vGlobIP[],
                        number time, int si,
                        GridObject* elem,
                        const MathVector<dim> vCornerCoords[],
                        const MathVector<refDim> vLocIP[],
                        const size_t nip,
                        LocalVector* u,
                        bool bDeriv,
                        int s,
                        std::vector<std::vector<TData> > vvvDeriv[],
                        const MathMatrix<refDim, dim>* vJT = NULL);
 
  protected:
    void set_lua_value_callback(const char* luaCallback, size_t numArgs);
    void set_lua_value_callback(LuaFunctionHandle handle, size_t numArgs);
 
    void free_callback_ref();
 
    void free_deriv_callback_ref(size_t arg);
 
    void eval_value(TData& out, const std::vector<TDataIn>& dataIn,
            const MathVector<dim>& x, number time, int si) const;
 
    void eval_deriv(TData& out, const std::vector<TDataIn>& dataIn,
            const MathVector<dim>& x, number time, int si, size_t arg) const;
 
  protected:
    std::string m_cbValueName;
    std::vector<std::string> m_cbDerivName;
 
    int m_cbValueRef;
    std::vector<int> m_cbDerivRef;
    
    lua_State*  m_L;
 
    size_t m_numArgs;
  
    bool m_bPosTimeNeed;
    
    #ifdef USE_LUA2C
      bridge::LUACompiler m_luaComp;
      std::vector<bridge::LUACompiler > m_luaComp_Deriv;
    #endif
 
  protected:
    std::vector<SmartPtr<CplUserData<TDataIn, dim> > > m_vpUserData;
 
    std::vector<SmartPtr<DependentUserData<TDataIn, dim> > > m_vpDependData;
    
};
 
 
class LuaUserNumberNumberFunction
{
  public:
    LuaUserNumberNumberFunction();
 
    void set_lua_callback(const char* luaCallback);
 
    number operator() ( int numArgs, ... ) const;
 
  protected:
    std::string m_callbackName;
    int m_callbackRef;
    lua_State*  m_L;
};
 
 
// LuaFunction
 
template <typename TData, typename TDataIn>
class LuaFunction : public IFunction<TData, TDataIn>
{
  public:
    LuaFunction();
    virtual ~LuaFunction() {};
 
 
    void set_lua_callback(const char* luaCallback, size_t numArgs);
 
    virtual void operator() (TData& out, int numArgs, ...);
 
  protected:
    std::string m_cbValueName;
 
    int m_cbValueRef;
 
    lua_State*  m_L;
 
    size_t m_numArgs;
};
 
 
 
namespace bridge{
 
void RegisterLuaUserData(Registry& reg, std::string grp);
 
} // end namepace bridge
} // end namespace ug
 
#include "lua_user_data_impl.h"
 
#endif /* __H__UG_BRIDGE__BRIDGES__USER_DATA__USER_DATA__ */