provides data specified in the lua script More...

#include <lua_user_data.h>

Inheritance diagram for ug::LuaUserData< TData, dim, TRet >:

Public Member Functions
TRet	evaluate (TData &D, const MathVector< dim > &x, number time, int si) const
	evaluates the data at a given point and time

	LuaUserData (const char *luaCallback)
	Constructor.

	LuaUserData (LuaFunctionHandle handle)

virtual	~LuaUserData ()
	}

Public Member Functions inherited from ug::StdGlobPosData< TImpl, TData, dim, TRet >
virtual void	compute (LocalVector u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)
	implement as a UserData

virtual void	compute (LocalVectorTimeSeries u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)
	implement as a UserData

virtual bool	constant () const
	returns if data is constant

virtual bool	continuous () const
	returns if provided data is continuous over geometric object boundaries

template<int refDim>
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

virtual TRet	operator() (TData &value, const MathVector< dim > &globIP, number time, int si) const
	returns value for a global position

virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, const size_t nip) const
	returns value for global positions

virtual bool	requires_grid_fct () const
	returns if grid function is needed for evaluation

Public Member Functions inherited from ug::StdUserData< TImpl, TData, dim, TRet, TBase >
virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 1 > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< 1, dim > *vJT=NULL) const

virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 2 > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< 2, dim > *vJT=NULL) const

virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 3 > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< 3, dim > *vJT=NULL) const

Public Member Functions inherited from ug::CplUserData< TData, dim, TRet >
bool	defined (size_t s, size_t ip) const
	returns flag, if data is evaluated (for conditional data)

size_t	num_ip (size_t s) const
	returns the number of integration points

size_t	num_series () const
	explicitly forward some functions

void	register_storage_callback (DataImport< TData, dim > obj, void(DataImport< TData, dim >::func)())
	register external callback, invoked when data storage changed

void	unregister_storage_callback (DataImport< TData, dim > *obj)
	register all callbacks registered by class

TData &	value (size_t s, size_t ip)
	returns the value at ip

const TData &	value (size_t s, size_t ip) const
	returns the value at ip

TData *	values (size_t s)
	returns all values for a series

const TData *	values (size_t s) const
	returns all values for a series

	~CplUserData ()
	destructor

Public Member Functions inherited from ug::ICplUserData< dim >
bool	at_current_time (size_t s) const
	returns true iff the time point specification is equal to the current one, or not specified

virtual void	check_setup () const
	returns if the dependent data is ready for evaluation

void	clear ()
	clear all data

int	dim_local_ips () const
	returns current local ip dimension

	ICplUserData ()
	default constructor

const MathVector< dim > &	ip (size_t s, size_t ip) const
	returns global ip

const MathVector< dim > *	ips (size_t s) const
	returns global ips

template<int ldim>
const MathVector< ldim > &	local_ip (size_t s, size_t ip) const
	returns local ip

template<int ldim>
const MathVector< ldim > *	local_ips (size_t s) const
	returns local ips

virtual SmartPtr< ICplUserData >	needed_data (size_t i)
	return needed data

size_t	num_ip (size_t s) const
	returns the number of integration points

virtual size_t	num_needed_data () const
	number of other Data this data depends on

size_t	num_series () const
	returns the number of ip series

template<int ldim>
size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, bool bMayChange=true)
	set local positions without the specification of the time point, returns series id

template<int ldim>
size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, const int timePointSpec, bool bMayChange=true)
	set local positions, returns series id

void	set_global_ips (size_t s, const MathVector< dim > *vPos, size_t numIP)
	set global positions

template<int ldim>
void	set_local_ips (const size_t seriesId, const MathVector< ldim > *vPos, const size_t numIP)
	sets new local ip positions for a local ip series

void	set_subset (int si)
	set the subset of evaluation

void	set_time_point (const size_t seriesId, const int timePointSpec)
	sets a new time point for a local ip series

void	set_time_point (size_t timePoint)
	sets the current time point

void	set_times (const std::vector< number > &vTime)
	set evaluation time

int	subset () const
	returns the subset of evaluation

number	time () const
	get the current evaluation time

number	time (size_t s) const
	get the specified evaluation time

size_t	time_point ()
	returns the current time point

size_t	time_point (size_t s) const
	returns the time point specification (in particular, the current one, if the own one not specified)

int	time_point_specification (size_t s) const
	returns the time point specification (note: it may be -1, i.e. not specified)

virtual void	update_dof_sizes (const LocalIndices &ind)
	resize arrays

virtual bool	zero_derivative () const
	returns if data depends on solution

virtual	~ICplUserData ()
	virtual desctructor

Public Member Functions inherited from ug::UserDataInfo
const FunctionGroup &	function_group () const
	Function Group of functions.

const FunctionIndexMapping &	map () const
	get function mapping

size_t	num_fct () const
	number of functions this export depends on

const char *	obj_name ()
	gets the name of the object (s. the field m_objName)

virtual void	set_function_pattern (ConstSmartPtr< FunctionPattern > fctPatt)
	sets the function pattern for a possibly needed grid function

void	set_obj_name (const char *name)
	sets the name of the object (s. the field m_objName)

virtual	~UserDataInfo ()
	virtual destructor

Public Member Functions inherited from ug::UserData< TData, dim, TRet >
int	get_dim () const
	returns dimension

virtual void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, Vertex *vrt) const
	returns a value at a vertex

std::string	type () const
	returns type of data as string (e.g. "Number", "Vector", "Matrix")

TRet	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 1 > &locIP, LocalVector u) const

TRet	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 2 > &locIP, LocalVector u) const

TRet	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject elem, const MathVector< dim > vCornerCoords[], const MathVector< 3 > &locIP, LocalVector u) const

Static Public Member Functions
static bool	check_callback_returns (const char *callName, const bool bThrow=false)
	returns true if callback has correct return values

static bool	check_callback_returns (lua_State L, int callbackRef, const char callName, const bool bThrow=false)
	returns true if callback has correct return values

static bool	check_callback_returns (LuaFunctionHandle handle, const bool bThrow=false)
	returns true if callback has correct return values

static std::string	name ()
	returns name of UserData

static std::string	signature ()
	returns string of required callback signature

Protected Member Functions
void	set_created_from_factory (bool bFromFactory)
	sets that LuaUserData is created by LuaUserDataFactory

Protected Member Functions inherited from ug::StdGlobPosData< TImpl, TData, dim, TRet >
TImpl &	getImpl ()
	access to implementation

const TImpl &	getImpl () const
	const access to implementation

Protected Member Functions inherited from ug::StdUserData< TImpl, TData, dim, TRet, TBase >
TImpl &	getImpl ()
	access to implementation

const TImpl &	getImpl () const
	const access to implementation

Protected Member Functions inherited from ug::CplUserData< TData, dim, TRet >
void	call_storage_callback () const
	calls are registered external storage callbacks

void	check_series (size_t s) const
	checks in debug mode the correct index

void	check_series_ip (size_t s, size_t ip) const
	checks in debug mode the correct index

virtual void	local_ip_series_added (const size_t seriesID)
	resizes the data field, when local ip changed signaled

virtual void	local_ip_series_to_be_cleared ()
	free the data field memory and set series to zero

virtual void	local_ips_changed (const size_t seriesID, const size_t newNumIP)
	implement callback, called when local IPs changed

virtual void	value_storage_changed (const size_t seriesID)
	callback, invoked when storage of data has changed for a series

Protected Member Functions inherited from ug::ICplUserData< dim >
void	check_s (size_t s) const
	checks in debug mode the correct usage of indices

void	check_s_ip (size_t s, size_t ip) const
	checks in debug mode the correct usage of indices

std::vector< const MathVector< 1 > * > &	get_local_ips (Int2Type< 1 >)
	help function to get local ips

const std::vector< const MathVector< 1 > * > &	get_local_ips (Int2Type< 1 >) const

std::vector< const MathVector< 2 > * > &	get_local_ips (Int2Type< 2 >)

const std::vector< const MathVector< 2 > * > &	get_local_ips (Int2Type< 2 >) const

std::vector< const MathVector< 3 > * > &	get_local_ips (Int2Type< 3 >)

const std::vector< const MathVector< 3 > * > &	get_local_ips (Int2Type< 3 >) const

virtual void	global_ips_changed (const size_t seriesID, const MathVector< dim > *vPos, const size_t numIP)
	callback invoked after global ips have been changed

Protected Attributes
bool	m_bFromFactory
	flag, indicating if created from factory

std::string	m_callbackName
	callback name as string

int	m_callbackRef
	reference to lua function

lua_State *	m_L
	lua state

Protected Attributes inherited from ug::ICplUserData< dim >
int	m_defaultTimePoint
	default time point (or -1 if not specified)

int	m_locPosDim
	dimension of local position (-1 indicates no dim set)

std::vector< const MathVector< 1 > * >	m_pvLocIP1d
	local ips of dimension 1d-3d

std::vector< const MathVector< 2 > * >	m_pvLocIP2d

std::vector< const MathVector< 3 > * >	m_pvLocIP3d

int	m_si
	subset for evaluation

size_t	m_timePoint
	current time point (used if no explicit specification for series)

std::vector< bool >	m_vMayChange
	flags if local ips may change

std::vector< size_t >	m_vNumIP
	number of evaluation points (-1 indicates no ips set)

std::vector< number >	m_vTime
	time for evaluation

std::vector< int >	m_vTimePoint
	time points for the series

std::vector< const MathVector< dim > * >	m_vvGlobPos
	global ips

Protected Attributes inherited from ug::UserDataInfo
FunctionGroup	m_fctGrp
	functions the data depends on

FunctionIndexMapping	m_map
	Mapping for import fct.

SmartPtr< char >	m_objName
	This field is used mainly for debugging: One can assign a name to the object to identify it when running.

Friends
class	LuaUserDataFactory< TData, dim, TRet >
	friend class

Additional Inherited Members
Public Types inherited from ug::CplUserData< TData, dim, TRet >
typedef ICplUserData< dim >	base_type
	type of base class

Public Types inherited from ug::UserData< TData, dim, TRet >
typedef TData	data_type

typedef TRet	return_type

Detailed Description

template<typename TData, int dim, typename TRet = void>
class ug::LuaUserData< TData, dim, TRet >

provides data specified in the lua script

This class implements the UserData interface to provide data at arbitrary points. A Lua callback is used to evaluate the data.

NOTE: If the LuaUserData has been created by the LuaUserDataFactory, then the fromFactory flag is set to true internally and while deconstruction of the instance LuaUserDataFactory::remove is called.

Constructor & Destructor Documentation

◆ LuaUserData() [1/2]

template<typename TData , int dim, typename TRet >

ug::LuaUserData< TData, dim, TRet >::LuaUserData ( const char * luaCallback )

Constructor.

Creates a LuaUserData that uses a Lua function to evaluate some data. NOTE: The Lua callback function is called once with dummy parameters in order to check the correct return values.

Parameters

luaCallback Name of Lua Callback Function {

References ug::LuaUserData< TData, dim, TRet >::check_callback_returns(), ug::script::GetDefaultLuaState(), ug::LuaUserData< TData, dim, TRet >::m_callbackName, ug::LuaUserData< TData, dim, TRet >::m_callbackRef, ug::LuaUserData< TData, dim, TRet >::m_L, ug::LuaUserData< TData, dim, TRet >::name(), UG_THROW, and ug::useLuaCompiler.

◆ LuaUserData() [2/2]

template<typename TData , int dim, typename TRet >

ug::LuaUserData< TData, dim, TRet >::LuaUserData ( LuaFunctionHandle handle )

References ug::LuaUserData< TData, dim, TRet >::check_callback_returns(), ug::script::GetDefaultLuaState(), ug::LuaUserData< TData, dim, TRet >::m_callbackName, ug::LuaUserData< TData, dim, TRet >::m_callbackRef, ug::LuaUserData< TData, dim, TRet >::m_L, ug::LuaFunctionHandle::ref, and ug::useLuaCompiler.

◆ ~LuaUserData()

template<typename TData , int dim, typename TRet >

ug::LuaUserData< TData, dim, TRet >::~LuaUserData ( )

virtual

}

destructor: frees lua callback, unregisters from LuaUserDataFactory if used

References ug::LuaUserDataFactory< TData, dim, TRet >::remove().

Member Function Documentation

◆ check_callback_returns() [1/3]

template<typename TData , int dim, typename TRet >

bool ug::LuaUserData< TData, dim, TRet >::check_callback_returns	(	const char *	callName,
		const bool	bThrow = `false`
	)

static

returns true if callback has correct return values

References ug::script::GetDefaultLuaState(), name, PROFILE_CALLBACK, and UG_THROW.

Referenced by ug::LuaUserData< TData, dim, TRet >::LuaUserData(), and ug::LuaUserData< TData, dim, TRet >::LuaUserData().

◆ check_callback_returns() [2/3]

template<typename TData , int dim, typename TRet >

bool ug::LuaUserData< TData, dim, TRet >::check_callback_returns	(	lua_State *	L,
		int	callbackRef,
		const char *	callName,
		const bool	bThrow = `false`
	)

static

returns true if callback has correct return values

References ug::bridge::GetLUAScriptFunctionDefined(), name, PROFILE_CALLBACK, and UG_THROW.

◆ check_callback_returns() [3/3]

template<typename TData , int dim, typename TRet >

bool ug::LuaUserData< TData, dim, TRet >::check_callback_returns	(	LuaFunctionHandle	handle,
		const bool	bThrow = `false`
	)

static

returns true if callback has correct return values

References ug::script::GetDefaultLuaState(), PROFILE_CALLBACK, and ug::LuaFunctionHandle::ref.

◆ evaluate()

template<typename TData , int dim, typename TRet >

TRet ug::LuaUserData< TData, dim, TRet >::evaluate	(	TData &	D,
		const MathVector< dim > &	x,
		number	time,
		int	si
	)		const

inline

evaluates the data at a given point and time

References name, PROFILE_CALLBACK, UG_CATCH_THROW, UG_THROW, and ug::useLuaCompiler.

◆ name()

template<typename TData , int dim, typename TRet >

std::string ug::LuaUserData< TData, dim, TRet >::name ( )

static

returns name of UserData

Referenced by ug::LuaUserData< TData, dim, TRet >::LuaUserData().

◆ set_created_from_factory()

template<typename TData , int dim, typename TRet = void>

void ug::LuaUserData< TData, dim, TRet >::set_created_from_factory ( bool bFromFactory )

inlineprotected

sets that LuaUserData is created by LuaUserDataFactory

References ug::LuaUserData< TData, dim, TRet >::m_bFromFactory.

◆ signature()

template<typename TData , int dim, typename TRet >

std::string ug::LuaUserData< TData, dim, TRet >::signature ( )

static

returns string of required callback signature

Friends And Related Symbol Documentation

◆ LuaUserDataFactory< TData, dim, TRet >

template<typename TData , int dim, typename TRet = void>

friend class LuaUserDataFactory< TData, dim, TRet >

friend

friend class

Member Data Documentation

◆ m_bFromFactory

template<typename TData , int dim, typename TRet = void>

bool ug::LuaUserData< TData, dim, TRet >::m_bFromFactory

protected

flag, indicating if created from factory

Referenced by ug::LuaUserData< TData, dim, TRet >::set_created_from_factory().

◆ m_callbackName

template<typename TData , int dim, typename TRet = void>

std::string ug::LuaUserData< TData, dim, TRet >::m_callbackName

protected

callback name as string

Referenced by ug::LuaUserData< TData, dim, TRet >::LuaUserData(), and ug::LuaUserData< TData, dim, TRet >::LuaUserData().

◆ m_callbackRef

template<typename TData , int dim, typename TRet = void>

int ug::LuaUserData< TData, dim, TRet >::m_callbackRef

protected

reference to lua function

Referenced by ug::LuaUserData< TData, dim, TRet >::LuaUserData(), and ug::LuaUserData< TData, dim, TRet >::LuaUserData().

◆ m_L

template<typename TData , int dim, typename TRet = void>

lua_State* ug::LuaUserData< TData, dim, TRet >::m_L

protected

lua state

Referenced by ug::LuaUserData< TData, dim, TRet >::LuaUserData(), and ug::LuaUserData< TData, dim, TRet >::LuaUserData().

The documentation for this class was generated from the following files:

ugbase/bindings/lua/lua_user_data.h
ugbase/bindings/lua/lua_user_data_impl.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LuaUserData() [1/2]

◆ LuaUserData() [2/2]

◆ ~LuaUserData()

Member Function Documentation

◆ check_callback_returns() [1/3]

◆ check_callback_returns() [2/3]

◆ check_callback_returns() [3/3]

◆ evaluate()

◆ name()

◆ set_created_from_factory()

◆ signature()

Friends And Related Symbol Documentation

◆ LuaUserDataFactory< TData, dim, TRet >

Member Data Documentation

◆ m_bFromFactory

◆ m_callbackName

◆ m_callbackRef

◆ m_L