Loading [MathJax]/extensions/tex2jax.js
ug4
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | Private Attributes | List of all members
ug::vrl::VRLUserData< TData, dim > Class Template Reference
+ Inheritance diagram for ug::vrl::VRLUserData< TData, dim >:

Public Member Functions

void evaluate (TData &value, const MathVector< dim > &x, number time, int si) const
 evaluates the data at a given point and time
 
void releaseGlobalRefs ()
 
void set_vrl_callback (const char *expression)
 
 VRLUserData ()
 
 ~VRLUserData ()
 
- Public Member Functions inherited from ug::StdGlobPosData< VRLUserData< TData, dim >, TData, dim >
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
 
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 void 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 std::string group_name ()
 
static std::string name ()
 
static std::string params ()
 

Static Public Attributes

static const unsigned int retArrayDim = vrl_traits<TData>::retArrayDim
 

Static Protected Member Functions

static jobject compileUserDataString (JNIEnv *env, const char *s)
 
static jclass getUserDataClass (JNIEnv *env)
 
static jmethodID getUserDataRunMethod (JNIEnv *env, jclass cls)
 

Private Attributes

bool initialized
 
jmethodID runMethod
 
jclass userDataClass
 
jobject userDataObject
 

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
 
- Protected Member Functions inherited from ug::StdGlobPosData< VRLUserData< TData, dim >, TData, dim >
VRLUserData< TData, dim > & getImpl ()
 access to implementation
 
const VRLUserData< TData, dim > & 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 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.
 

Constructor & Destructor Documentation

◆ VRLUserData()

template<typename TData , int dim>
ug::vrl::VRLUserData< TData, dim >::VRLUserData ( )
inline

◆ ~VRLUserData()

template<typename TData , int dim>
ug::vrl::VRLUserData< TData, dim >::~VRLUserData ( )
inline

References ug::vrl::VRLUserData< TData, dim >::releaseGlobalRefs().

Member Function Documentation

◆ compileUserDataString()

template<typename TData , int dim>
static jobject ug::vrl::VRLUserData< TData, dim >::compileUserDataString ( JNIEnv *  env,
const char *  s 
)
inlinestaticprotected

References ug::vrl::VRLUserData< TData, dim >::retArrayDim, ug::vrl::VRLUserData< TData, dim >::runMethod, s, and ug::vrl::stringC2J().

Referenced by ug::vrl::VRLUserData< TData, dim >::set_vrl_callback().

◆ evaluate()

template<typename TData , int dim>
void ug::vrl::VRLUserData< TData, dim >::evaluate ( TData &  value,
const MathVector< dim > &  x,
number  time,
int  si 
) const
inline

evaluates the data at a given point and time

References ug::vrl::ConvertParametersToJava(), ug::vrl::threading::getEnv(), ug::vrl::getJavaVM(), ug::vrl::VRLUserData< TData, dim >::params(), ug::vrl::VRLUserData< TData, dim >::runMethod, ug::ICplUserData< dim >::time(), ug::vrl::VRLUserData< TData, dim >::userDataObject, and ug::CplUserData< TData, dim, TRet >::value().

◆ getUserDataClass()

template<typename TData , int dim>
static jclass ug::vrl::VRLUserData< TData, dim >::getUserDataClass ( JNIEnv *  env)
inlinestaticprotected

Referenced by ug::vrl::VRLUserData< TData, dim >::set_vrl_callback().

◆ getUserDataRunMethod()

template<typename TData , int dim>
static jmethodID ug::vrl::VRLUserData< TData, dim >::getUserDataRunMethod ( JNIEnv *  env,
jclass  cls 
)
inlinestaticprotected

References ug::vrl::checkException(), ug::vrl::VRLUserData< TData, dim >::name(), ug::vrl::VRLUserData< TData, dim >::retArrayDim, and UG_LOG.

Referenced by ug::vrl::VRLUserData< TData, dim >::set_vrl_callback().

◆ group_name()

template<typename TData , int dim>
static std::string ug::vrl::VRLUserData< TData, dim >::group_name ( )
inlinestatic

◆ name()

template<typename TData , int dim>
static std::string ug::vrl::VRLUserData< TData, dim >::name ( )
inlinestatic

Referenced by ug::vrl::VRLUserData< TData, dim >::getUserDataRunMethod(), and ug::vrl::VRLUserData< TData, dim >::set_vrl_callback().

◆ params()

template<typename TData , int dim>
static std::string ug::vrl::VRLUserData< TData, dim >::params ( )
inlinestatic

References ug::vrl::VRLUserData< TData, dim >::params().

Referenced by ug::vrl::VRLUserData< TData, dim >::evaluate(), and ug::vrl::VRLUserData< TData, dim >::params().

◆ releaseGlobalRefs()

template<typename TData , int dim>
void ug::vrl::VRLUserData< TData, dim >::releaseGlobalRefs ( )
inline

References ug::vrl::threading::getEnv(), ug::vrl::getJavaVM(), ug::vrl::VRLUserData< TData, dim >::initialized, ug::vrl::VRLUserData< TData, dim >::userDataClass, and ug::vrl::VRLUserData< TData, dim >::userDataObject.

Referenced by ug::vrl::VRLUserData< TData, dim >::set_vrl_callback(), and ug::vrl::VRLUserData< TData, dim >::~VRLUserData().

◆ set_vrl_callback()

template<typename TData , int dim>
void ug::vrl::VRLUserData< TData, dim >::set_vrl_callback ( const char *  expression)
inline

References append(), ug::vrl::checkException(), ug::vrl::VRLUserData< TData, dim >::compileUserDataString(), ug::vrl::threading::getEnv(), ug::vrl::getJavaVM(), ug::vrl::VRLUserData< TData, dim >::getUserDataClass(), ug::vrl::VRLUserData< TData, dim >::getUserDataRunMethod(), ug::vrl::VRLUserData< TData, dim >::initialized, ug::vrl::VRLUserData< TData, dim >::name(), ug::vrl::VRLUserData< TData, dim >::releaseGlobalRefs(), ug::vrl::VRLUserData< TData, dim >::runMethod, ug::vrl::VRLUserData< TData, dim >::userDataClass, and ug::vrl::VRLUserData< TData, dim >::userDataObject.

Member Data Documentation

◆ initialized

template<typename TData , int dim>
bool ug::vrl::VRLUserData< TData, dim >::initialized
private

Referenced by ug::vrl::VRLUserData< TData, dim >::releaseGlobalRefs(), and ug::vrl::VRLUserData< TData, dim >::set_vrl_callback().

◆ retArrayDim

template<typename TData , int dim>
const unsigned int ug::vrl::VRLUserData< TData, dim >::retArrayDim = vrl_traits<TData>::retArrayDim
static

Referenced by ug::vrl::VRLUserData< TData, dim >::compileUserDataString(), and ug::vrl::VRLUserData< TData, dim >::getUserDataRunMethod().

◆ runMethod

template<typename TData , int dim>
jmethodID ug::vrl::VRLUserData< TData, dim >::runMethod
private

Referenced by ug::vrl::VRLUserData< TData, dim >::compileUserDataString(), ug::vrl::VRLUserData< TData, dim >::evaluate(), and ug::vrl::VRLUserData< TData, dim >::set_vrl_callback().

◆ userDataClass

template<typename TData , int dim>
jclass ug::vrl::VRLUserData< TData, dim >::userDataClass
private

Referenced by ug::vrl::VRLUserData< TData, dim >::releaseGlobalRefs(), and ug::vrl::VRLUserData< TData, dim >::set_vrl_callback().

◆ userDataObject

template<typename TData , int dim>
jobject ug::vrl::VRLUserData< TData, dim >::userDataObject
private

Referenced by ug::vrl::VRLUserData< TData, dim >::evaluate(), ug::vrl::VRLUserData< TData, dim >::releaseGlobalRefs(), and ug::vrl::VRLUserData< TData, dim >::set_vrl_callback().

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