base class providing runtime-info on dimension and type More...
#include <user_data.h>
Inheritance diagram for ug::UserDataInfo:
Public Member Functions | |
| virtual bool | continuous () const =0 |
| returns if provided data is continuous over geometric object boundaries More... | |
| const FunctionGroup & | function_group () const |
| Function Group of functions. More... | |
| virtual int | get_dim () const =0 |
| returns dimension More... | |
| const FunctionIndexMapping & | map () const |
| get function mapping More... | |
| size_t | num_fct () const |
| number of functions this export depends on More... | |
| const char * | obj_name () |
| gets the name of the object (s. the field m_objName) More... | |
| virtual bool | requires_grid_fct () const =0 |
| returns if grid function is needed for evaluation More... | |
| virtual void | set_function_pattern (ConstSmartPtr< FunctionPattern > fctPatt) |
| sets the function pattern for a possibly needed grid function More... | |
| void | set_obj_name (const char *name) |
| sets the name of the object (s. the field m_objName) More... | |
| virtual std::string | type () const =0 |
| returns type of data as string (e.g. "Number", "Vector", "Matrix") More... | |
| virtual | ~UserDataInfo () |
| virtual destructor More... | |
Protected Attributes | |
| FunctionGroup | m_fctGrp |
| functions the data depends on More... | |
| FunctionIndexMapping | m_map |
| Mapping for import fct. More... | |
| SmartPtr< char > | m_objName |
| This field is used mainly for debugging: One can assign a name to the object to identify it when running. More... | |
Detailed Description
base class providing runtime-info on dimension and type
Constructor & Destructor Documentation
◆ ~UserDataInfo()
|
inlinevirtual |
virtual destructor
Member Function Documentation
◆ continuous()
|
pure virtual |
returns if provided data is continuous over geometric object boundaries
Implemented in ug::UserData< TData, dim, void >, ug::UserData< number, dim, bool >, ug::UserData< TData, dim, TRet >, ug::StdGlobPosData< TImpl, TData, dim, TRet >, ug::StdGlobPosData< VRLCondUserNumber< dim >, number, dim, bool >, ug::StdGlobPosData< VRLUserData< TData, dim >, TData, dim >, ug::StdGlobPosData< RotatingVelocity2d, MathVector< 2 >, 2 >, ug::StdGlobPosData< RasterUserData< dim >, number, dim, void >, ug::StdGlobPosData< IDWUserData< WDim, number >, number, WDim >, ug::StdGlobPosData< BarryMercerRefPressure, number, 2, void >, ug::StdGlobPosData< GlobalGridFunctionGradientData< TGridFunction >, MathVector< TGridFunction::dim >, TGridFunction::dim >, ug::StdGlobPosData< BarryMercerRefDispY, number, 2, void >, ug::StdGlobPosData< BarryMercerPointSource, number, 2, void >, ug::StdGlobPosData< LognormalRandomField< TData, dim, void >, TData, dim, void >, ug::StdGlobPosData< RotatingCone2d, number, 2 >, ug::StdGlobPosData< BarryMercerRefDispX, number, 2, void >, ug::StdGlobPosData< GlobalGridFunctionNumberData< TGridFunction, TGridFunction::dim >, number, TGridFunction::dim >, ug::StdGlobPosData< LuaUserData< TData, dim, void >, TData, dim, void >, ug::StdDataLinker< TImpl, TData, dim >, ug::StdDataLinker< BinghamViscosityLinker< dim >, number, dim >, ug::StdDataLinker< LuaUserFunction< TData, dim, TDataIn >, TData, dim >, ug::StdDataLinker< UserVectorEntryAdapter< dim >, number, dim >, ug::StdDataLinker< ProjectionLinker< dim >, MathVector< dim >, dim >, ug::StdDataLinker< ScaleAddLinker< TData, dim, TDataScale, TData >, TData, dim >, ug::StdDataLinker< InverseLinker< dim >, number, dim >, ug::StdDataLinker< IntervalNumberLinker< dim >, number, dim >, ug::StdDataLinker< VRLUserLinker< TData, dim, TDataIn >, TData, dim >, ug::StdDataLinker< DarcyVelocityLinker< dim >, MathVector< dim >, dim >, ug::StdDataLinker< RichardsLinker< dim, TFunctor >, number, dim >, ug::DataExport< TData, dim >, ug::VectorDataExport< dim >, ug::GradientDataExport< dim >, ug::ValueDataExport< dim >, ug::StdConstData< TImpl, TData, dim >, ug::StdConstData< ConstUserNumber< dim >, number, dim >, ug::StdConstData< ConstUserMatrix< N, N, N >, MathMatrix< N, N >, N >, ug::StdConstData< ConstUserVector< dim, dim >, MathVector< dim >, dim >, ug::StdConstData< ConstUserTensor< TRank, dim >, MathTensor< TRank, dim >, dim >, ug::ValueIndicatorUserData< TDomain >, ug::SubsetIndicatorUserData< TDomain >, ug::RasterUserData< dim >, ug::GlobAttachmentElementUserData< WDim, TData >, ug::EdgeOrientation< TDomain >, ug::OutNormCmp< TDomain >, ug::CompositeUserData< TData, dim, TRet >, ug::ExplicitGridFunctionGradient< TGridFunction >, ug::ExplicitGridFunctionVector< TGridFunction >, ug::ExplicitGridFunctionValue< TGridFunction >, ug::StdExplicitGridFunctionData< TImpl, TData, TGridFunction >, ug::StdExplicitGridFunctionData< ExplicitGridFunctionVector< TGridFunction >, MathVector< TGridFunction::dim >, TGridFunction >, ug::StdExplicitGridFunctionData< ExplicitGridFunctionValue< TGridFunction >, number, TGridFunction >, ug::StdExplicitGridFunctionData< ExplicitGridFunctionGradient< TGridFunction >, MathVector< TGridFunction::dim >, TGridFunction >, ug::GridFunctionGradientComponentData< TGridFunction >, ug::GridFunctionGradientData< TGridFunction >, ug::GridFunctionVectorData< TGridFunction >, ug::GridFunctionNumberData< TGridFunction >, ug::GlobalGridFunctionGradientData< TGridFunction >, ug::GlobalGridFunctionNumberData< TGridFunction, elemDim >, ug::vrl::VRLCondUserNumber< dim >, ug::Electromagnetism::EddyCurrentCurlEDependentCmpUserData< class, ReIm, class >, EddyCurrentCurlEDependentCmpUserData< EddyCurrentImBofEUserData< TGridFunc >, EddyCurrentTraits::_Re_, TGridFunc >, EddyCurrentCurlEDependentCmpUserData< EddyCurrentReBofEUserData< TGridFunc >, EddyCurrentTraits::_Im_, TGridFunc >, ug::Electromagnetism::EddyCurrentHeat< class >, ug::Electromagnetism::NedelecCurlData< class >, ug::Electromagnetism::NedelecGridFunctionData< class >, ug::Electromagnetism::NedelecSigmaEData< class >, ug::Richards::OnSurfaceCondition< dim >, ug::NavierStokes::SeparatedPressureSource< class >, ug::NavierStokes::SeparatedPressureSourceInter< class >, ug::NavierStokes::StdTurbulentViscosityData< class, dim, class, class >, StdTurbulentViscosityData< number, TGridFunction::dim, CRDynamicTurbViscData< TGridFunction >, TGridFunction >, StdTurbulentViscosityData< number, TGridFunction::dim, CRSmagorinskyTurbViscData< TGridFunction >, TGridFunction >, ug::NavierStokes::StdTurbulentViscosityDataFV1< class, dim, class, class >, StdTurbulentViscosityDataFV1< number, TGridFunction::dim, FV1DynamicTurbViscData< TGridFunction >, TGridFunction >, and StdTurbulentViscosityDataFV1< number, TGridFunction::dim, FV1SmagorinskyTurbViscData< TGridFunction >, TGridFunction >.
◆ function_group()
|
inline |
Function Group of functions.
References m_fctGrp.
◆ get_dim()
|
pure virtual |
returns dimension
Implemented in ug::UserData< TData, dim, TRet >, ug::UserData< TData, dim, void >, and ug::UserData< number, dim, bool >.
◆ map()
|
inline |
get function mapping
References m_map.
Referenced by ug::GlobalGridFunctionGradientData< TGridFunction >::evaluate(), ug::GlobalGridFunctionNumberData< TGridFunction, elemDim >::evaluate(), and ug::OutNormCmp< TDomain >::evaluate().
◆ num_fct()
|
inline |
number of functions this export depends on
References m_map, and ug::FunctionIndexMapping::num_fct().
Referenced by ug::StdDataLinker< TImpl, TData, dim >::input_common_fct().
◆ obj_name()
|
inline |
gets the name of the object (s. the field m_objName)
Note that the object name is not unique in general. Several objects may have the same name.
References SmartPtr< T, FreePolicy >::get(), and m_objName.
◆ requires_grid_fct()
|
pure virtual |
returns if grid function is needed for evaluation
Implemented in ug::UserData< TData, dim, void >, ug::UserData< number, dim, bool >, ug::UserData< TData, dim, TRet >, ug::DependentUserData< TData, dim >, ug::StdGlobPosData< TImpl, TData, dim, TRet >, ug::StdGlobPosData< VRLCondUserNumber< dim >, number, dim, bool >, ug::StdGlobPosData< VRLUserData< TData, dim >, TData, dim >, ug::StdGlobPosData< RotatingVelocity2d, MathVector< 2 >, 2 >, ug::StdGlobPosData< RasterUserData< dim >, number, dim, void >, ug::StdGlobPosData< IDWUserData< WDim, number >, number, WDim >, ug::StdGlobPosData< BarryMercerRefPressure, number, 2, void >, ug::StdGlobPosData< GlobalGridFunctionGradientData< TGridFunction >, MathVector< TGridFunction::dim >, TGridFunction::dim >, ug::StdGlobPosData< BarryMercerRefDispY, number, 2, void >, ug::StdGlobPosData< BarryMercerPointSource, number, 2, void >, ug::StdGlobPosData< LognormalRandomField< TData, dim, void >, TData, dim, void >, ug::StdGlobPosData< RotatingCone2d, number, 2 >, ug::StdGlobPosData< BarryMercerRefDispX, number, 2, void >, ug::StdGlobPosData< GlobalGridFunctionNumberData< TGridFunction, TGridFunction::dim >, number, TGridFunction::dim >, ug::StdGlobPosData< LuaUserData< TData, dim, void >, TData, dim, void >, ug::ProjectionLinker< dim >, ug::StdDataLinker< TImpl, TData, dim >, ug::StdDataLinker< BinghamViscosityLinker< dim >, number, dim >, ug::StdDataLinker< LuaUserFunction< TData, dim, TDataIn >, TData, dim >, ug::StdDataLinker< UserVectorEntryAdapter< dim >, number, dim >, ug::StdDataLinker< ProjectionLinker< dim >, MathVector< dim >, dim >, ug::StdDataLinker< ScaleAddLinker< TData, dim, TDataScale, TData >, TData, dim >, ug::StdDataLinker< InverseLinker< dim >, number, dim >, ug::StdDataLinker< IntervalNumberLinker< dim >, number, dim >, ug::StdDataLinker< VRLUserLinker< TData, dim, TDataIn >, TData, dim >, ug::StdDataLinker< DarcyVelocityLinker< dim >, MathVector< dim >, dim >, ug::StdDataLinker< RichardsLinker< dim, TFunctor >, number, dim >, ug::IntervalNumberLinker< dim >, ug::DataExport< TData, dim >, ug::StdConstData< TImpl, TData, dim >, ug::StdConstData< ConstUserNumber< dim >, number, dim >, ug::StdConstData< ConstUserMatrix< N, N, N >, MathMatrix< N, N >, N >, ug::StdConstData< ConstUserVector< dim, dim >, MathVector< dim >, dim >, ug::StdConstData< ConstUserTensor< TRank, dim >, MathTensor< TRank, dim >, dim >, ug::ValueIndicatorUserData< TDomain >, ug::SubsetIndicatorUserData< TDomain >, ug::RasterUserData< dim >, ug::GlobAttachmentElementUserData< WDim, TData >, ug::EdgeOrientation< TDomain >, ug::OutNormCmp< TDomain >, ug::CompositeUserData< TData, dim, TRet >, ug::StdExplicitGridFunctionData< TImpl, TData, TGridFunction >, ug::StdExplicitGridFunctionData< ExplicitGridFunctionVector< TGridFunction >, MathVector< TGridFunction::dim >, TGridFunction >, ug::StdExplicitGridFunctionData< ExplicitGridFunctionValue< TGridFunction >, number, TGridFunction >, ug::StdExplicitGridFunctionData< ExplicitGridFunctionGradient< TGridFunction >, MathVector< TGridFunction::dim >, TGridFunction >, ug::vrl::VRLCondUserNumber< dim >, ug::Electromagnetism::EddyCurrentCurlEDependentCmpUserData< class, ReIm, class >, EddyCurrentCurlEDependentCmpUserData< EddyCurrentImBofEUserData< TGridFunc >, EddyCurrentTraits::_Re_, TGridFunc >, EddyCurrentCurlEDependentCmpUserData< EddyCurrentReBofEUserData< TGridFunc >, EddyCurrentTraits::_Im_, TGridFunc >, ug::Electromagnetism::EddyCurrentHeat< class >, ug::Electromagnetism::NedelecCurlData< class >, ug::Electromagnetism::NedelecGridFunctionData< class >, ug::Electromagnetism::NedelecSigmaEData< class >, ug::Richards::OnSurfaceCondition< dim >, ug::NavierStokes::SeparatedPressureSource< class >, ug::NavierStokes::SeparatedPressureSourceInter< class >, ug::NavierStokes::StdTurbulentViscosityData< class, dim, class, class >, StdTurbulentViscosityData< number, TGridFunction::dim, CRDynamicTurbViscData< TGridFunction >, TGridFunction >, StdTurbulentViscosityData< number, TGridFunction::dim, CRSmagorinskyTurbViscData< TGridFunction >, TGridFunction >, ug::NavierStokes::StdTurbulentViscosityDataFV1< class, dim, class, class >, StdTurbulentViscosityDataFV1< number, TGridFunction::dim, FV1DynamicTurbViscData< TGridFunction >, TGridFunction >, and StdTurbulentViscosityDataFV1< number, TGridFunction::dim, FV1SmagorinskyTurbViscData< TGridFunction >, TGridFunction >.
◆ set_function_pattern()
|
inlinevirtual |
sets the function pattern for a possibly needed grid function
Reimplemented in ug::DependentUserData< TData, dim >, ug::StdDataLinker< TImpl, TData, dim >, ug::StdDataLinker< BinghamViscosityLinker< dim >, number, dim >, ug::StdDataLinker< LuaUserFunction< TData, dim, TDataIn >, TData, dim >, ug::StdDataLinker< UserVectorEntryAdapter< dim >, number, dim >, ug::StdDataLinker< ProjectionLinker< dim >, MathVector< dim >, dim >, ug::StdDataLinker< ScaleAddLinker< TData, dim, TDataScale, TData >, TData, dim >, ug::StdDataLinker< InverseLinker< dim >, number, dim >, ug::StdDataLinker< IntervalNumberLinker< dim >, number, dim >, ug::StdDataLinker< VRLUserLinker< TData, dim, TDataIn >, TData, dim >, ug::StdDataLinker< DarcyVelocityLinker< dim >, MathVector< dim >, dim >, and ug::StdDataLinker< RichardsLinker< dim, TFunctor >, number, dim >.
References m_fctGrp, and ug::FunctionGroup::set_function_pattern().
◆ set_obj_name()
|
inline |
sets the name of the object (s. the field m_objName)
Note that the object name is not unique in general. Several objects may have the same name.
References SmartPtr< T, FreePolicy >::get(), m_objName, name, SPNULL, UG_LOG, and SmartPtr< T, FreePolicy >::valid().
◆ type()
|
pure virtual |
returns type of data as string (e.g. "Number", "Vector", "Matrix")
Implemented in ug::UserData< TData, dim, TRet >, ug::UserData< TData, dim, void >, and ug::UserData< number, dim, bool >.
Member Data Documentation
◆ m_fctGrp
|
protected |
functions the data depends on
Referenced by function_group(), and set_function_pattern().
◆ m_map
|
protected |
◆ m_objName
|
protected |
This field is used mainly for debugging: One can assign a name to the object to identify it when running.
this strange type underlines the debugging nature of this field: it is seldom used but should be easily accessed in a debugger
Referenced by obj_name(), and set_obj_name().
The documentation for this class was generated from the following file:
- ugbase/lib_disc/spatial_disc/user_data/user_data.h
