VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkQuadratureSchemeDefinition Class Reference

An Elemental data type that holds a definition of a numerical quadrature scheme. More...

#include <vtkQuadratureSchemeDefinition.h>

Inheritance diagram for vtkQuadratureSchemeDefinition:
[legend]
Collaboration diagram for vtkQuadratureSchemeDefinition:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkQuadratureSchemeDefinitionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
int DeepCopy (const vtkQuadratureSchemeDefinition *other)
 Deep copy.
 
int SaveState (vtkXMLDataElement *root)
 Put the object into an XML representation.
 
int RestoreState (vtkXMLDataElement *root)
 Restore the object from an XML representation.
 
void Clear ()
 Release all allocated resources and set the object to an uninitialized state.
 
void Initialize (int cellType, int numberOfNodes, int numberOfQuadraturePoints, double *shapeFunctionWeights)
 Initialize the object allocating resources as needed.
 
void Initialize (int cellType, int numberOfNodes, int numberOfQuadraturePoints, double *shapeFunctionWeights, double *quadratureWeights)
 Initialize the object allocating resources as needed.
 
int GetCellType () const
 Access the VTK cell type id.
 
int GetQuadratureKey () const
 Access to an alternative key.
 
int GetNumberOfNodes () const
 Get the number of nodes associated with the interpolation.
 
int GetNumberOfQuadraturePoints () const
 Get the number of quadrature points associated with the scheme.
 
const double * GetShapeFunctionWeights () const
 Get the array of shape function weights.
 
const double * GetQuadratureWeights () const
 Access to the quadrature weights.
 
const double * GetShapeFunctionWeights (int quadraturePointId) const
 Get the array of shape function weights associated with a single quadrature point.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkQuadratureSchemeDefinitionSafeDownCast (vtkObjectBase *o)
 
static vtkInformationQuadratureSchemeDefinitionVectorKeyDICTIONARY ()
 
static vtkInformationStringKeyQUADRATURE_OFFSET_ARRAY_NAME ()
 
static vtkQuadratureSchemeDefinitionNew ()
 New object in an unsuable state.
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkQuadratureSchemeDefinition ()
 
 ~vtkQuadratureSchemeDefinition () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Friends

ostream & operator<< (ostream &s, const vtkQuadratureSchemeDefinition &d)
 
istream & operator>> (istream &s, vtkQuadratureSchemeDefinition &d)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

An Elemental data type that holds a definition of a numerical quadrature scheme.

The definition contains the requisite information to interpolate to the so called quadrature points of the specific scheme. namely:

1)
A matrix of shape function weights(shape functions evaluated
at parametric coordinates of the quadrature points).

2)
The number of quadrature points and cell nodes. These parameters
size the matrix, and allow for convinent evaluation by users
of the definition.

Definition at line 45 of file vtkQuadratureSchemeDefinition.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file vtkQuadratureSchemeDefinition.h.

Constructor & Destructor Documentation

◆ vtkQuadratureSchemeDefinition()

vtkQuadratureSchemeDefinition::vtkQuadratureSchemeDefinition ( )
protected

◆ ~vtkQuadratureSchemeDefinition()

vtkQuadratureSchemeDefinition::~vtkQuadratureSchemeDefinition ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkQuadratureSchemeDefinition::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkQuadratureSchemeDefinition::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkQuadratureSchemeDefinition * vtkQuadratureSchemeDefinition::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkQuadratureSchemeDefinition::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkQuadratureSchemeDefinition * vtkQuadratureSchemeDefinition::NewInstance ( ) const

◆ PrintSelf()

void vtkQuadratureSchemeDefinition::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ DICTIONARY()

static vtkInformationQuadratureSchemeDefinitionVectorKey * vtkQuadratureSchemeDefinition::DICTIONARY ( )
static

◆ QUADRATURE_OFFSET_ARRAY_NAME()

static vtkInformationStringKey * vtkQuadratureSchemeDefinition::QUADRATURE_OFFSET_ARRAY_NAME ( )
static

◆ New()

static vtkQuadratureSchemeDefinition * vtkQuadratureSchemeDefinition::New ( )
static

New object in an unsuable state.

You'll have to call "Initilaize" to get the definition in to a usable state.

◆ DeepCopy()

int vtkQuadratureSchemeDefinition::DeepCopy ( const vtkQuadratureSchemeDefinition other)

Deep copy.

◆ SaveState()

int vtkQuadratureSchemeDefinition::SaveState ( vtkXMLDataElement root)

Put the object into an XML representation.

The element passed in is assumed to be empty.

◆ RestoreState()

int vtkQuadratureSchemeDefinition::RestoreState ( vtkXMLDataElement root)

Restore the object from an XML representation.

◆ Clear()

void vtkQuadratureSchemeDefinition::Clear ( )

Release all allocated resources and set the object to an uninitialized state.

◆ Initialize() [1/2]

void vtkQuadratureSchemeDefinition::Initialize ( int  cellType,
int  numberOfNodes,
int  numberOfQuadraturePoints,
double *  shapeFunctionWeights 
)

Initialize the object allocating resources as needed.

◆ Initialize() [2/2]

void vtkQuadratureSchemeDefinition::Initialize ( int  cellType,
int  numberOfNodes,
int  numberOfQuadraturePoints,
double *  shapeFunctionWeights,
double *  quadratureWeights 
)

Initialize the object allocating resources as needed.

◆ GetCellType()

int vtkQuadratureSchemeDefinition::GetCellType ( ) const
inline

Access the VTK cell type id.

Definition at line 95 of file vtkQuadratureSchemeDefinition.h.

◆ GetQuadratureKey()

int vtkQuadratureSchemeDefinition::GetQuadratureKey ( ) const
inline

Access to an alternative key.

Definition at line 99 of file vtkQuadratureSchemeDefinition.h.

◆ GetNumberOfNodes()

int vtkQuadratureSchemeDefinition::GetNumberOfNodes ( ) const
inline

Get the number of nodes associated with the interpolation.

Definition at line 103 of file vtkQuadratureSchemeDefinition.h.

◆ GetNumberOfQuadraturePoints()

int vtkQuadratureSchemeDefinition::GetNumberOfQuadraturePoints ( ) const
inline

Get the number of quadrature points associated with the scheme.

Definition at line 107 of file vtkQuadratureSchemeDefinition.h.

◆ GetShapeFunctionWeights() [1/2]

const double * vtkQuadratureSchemeDefinition::GetShapeFunctionWeights ( ) const
inline

Get the array of shape function weights.

Shape function weights are the shape functions evaluated at the quadrature points. There are "NumberOfNodes" weights for each quadrature point.

Definition at line 113 of file vtkQuadratureSchemeDefinition.h.

◆ GetShapeFunctionWeights() [2/2]

const double * vtkQuadratureSchemeDefinition::GetShapeFunctionWeights ( int  quadraturePointId) const
inline

Get the array of shape function weights associated with a single quadrature point.

Definition at line 119 of file vtkQuadratureSchemeDefinition.h.

◆ GetQuadratureWeights()

const double * vtkQuadratureSchemeDefinition::GetQuadratureWeights ( ) const
inline

Access to the quadrature weights.

Definition at line 128 of file vtkQuadratureSchemeDefinition.h.

Friends And Related Function Documentation

◆ operator<<

ostream & operator<< ( ostream &  s,
const vtkQuadratureSchemeDefinition d 
)
friend

◆ operator>>

istream & operator>> ( istream &  s,
vtkQuadratureSchemeDefinition d 
)
friend

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