VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractElectronicData Class Referenceabstract

Provides access to and storage of chemical electronic data. More...

#include <vtkAbstractElectronicData.h>

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

Public Types

typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
typedef vtkObject Superclass
 
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS,
  FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS
}
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkAbstractElectronicData * NewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkIdType GetNumberOfMOs ()=0
 
virtual vtkIdType GetNumberOfElectrons ()=0
 
virtual vtkImageData * GetMO (vtkIdType orbitalNumber)=0
 
virtual vtkImageData * GetElectronDensity ()=0
 
vtkImageData * GetHOMO ()
 
vtkImageData * GetLUMO ()
 
vtkIdType GetHOMOOrbitalNumber ()
 
vtkIdType GetLUMOOrbitalNumber ()
 
virtual void DeepCopy (vtkDataObject *obj)
 
bool IsHOMO (vtkIdType orbitalNumber)
 
bool IsLUMO (vtkIdType orbitalNumber)
 
virtual double GetPadding ()
 
- Public Member Functions inherited from vtkDataObject
vtkDataObject * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned long int GetMTime ()
 
virtual void Initialize ()
 
void ReleaseData ()
 
virtual int GetDataObjectType ()
 
unsigned long GetUpdateTime ()
 
virtual unsigned long GetActualMemorySize ()
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual int GetExtentType ()
 
virtual void Crop (const int *updateExtent)
 
virtual vtkDataSetAttributes * GetAttributes (int type)
 
virtual vtkFieldData * GetAttributesAsFieldData (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkIdType GetNumberOfElements (int type)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldData * GetFieldData ()
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 
virtual void ShallowCopy (vtkDataObject *src)
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommand * GetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkAbstractElectronicData * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObject * New ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObject * SafeDownCast (vtkObjectBase *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static int GetAssociationTypeFromString (const char *associationType)
 
static vtkInformationStringKey * DATA_TYPE_NAME ()
 
static vtkInformationDataObjectKey * DATA_OBJECT ()
 
static vtkInformationIntegerKey * DATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKey * DATA_EXTENT ()
 
static vtkInformationIntegerVectorKey * ALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKey * DATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKey * DATA_TIME_STEP ()
 
static vtkInformationInformationVectorKey * POINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKey * CELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKey * VERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKey * EDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKey * FIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ASSOCIATION ()
 
static vtkInformationIntegerKey * FIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKey * FIELD_OPERATION ()
 
static vtkInformationDoubleVectorKey * FIELD_RANGE ()
 
static vtkInformationIntegerVectorKey * PIECE_EXTENT ()
 
static vtkInformationStringKey * FIELD_NAME ()
 
static vtkInformationDoubleVectorKey * ORIGIN ()
 
static vtkInformationDoubleVectorKey * SPACING ()
 
static vtkInformationDoubleVectorKey * BOUNDING_BOX ()
 
static vtkInformationDataObjectKey * SIL ()
 
static vtkInformation * GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 
static vtkInformation * GetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static vtkInformation * SetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 
static vtkDataObject * GetData (vtkInformation *info)
 
static vtkDataObject * GetData (vtkInformationVector *v, int i=0)
 
static void SetGlobalReleaseDataFlag (int val)
 
static int GetGlobalReleaseDataFlag ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkAbstractElectronicData ()
 
 ~vtkAbstractElectronicData ()
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Padding
 
- Protected Attributes inherited from vtkDataObject
vtkFieldData * FieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformation * Information
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Provides access to and storage of chemical electronic data.

Tests:
vtkAbstractElectronicData (Tests)

Definition at line 32 of file vtkAbstractElectronicData.h.

Member Typedef Documentation

◆ Superclass

Definition at line 35 of file vtkAbstractElectronicData.h.

Constructor & Destructor Documentation

◆ vtkAbstractElectronicData()

vtkAbstractElectronicData::vtkAbstractElectronicData ( )
protected

◆ ~vtkAbstractElectronicData()

vtkAbstractElectronicData::~vtkAbstractElectronicData ( )
protected

Member Function Documentation

◆ IsTypeOf()

static int vtkAbstractElectronicData::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkAbstractElectronicData::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 vtkDataObject.

Reimplemented in vtkOpenQubeElectronicData, and vtkProgrammableElectronicData.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractElectronicData::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObject.

Reimplemented in vtkOpenQubeElectronicData, and vtkProgrammableElectronicData.

◆ NewInstance()

vtkAbstractElectronicData* vtkAbstractElectronicData::NewInstance ( ) const

◆ PrintSelf()

virtual void vtkAbstractElectronicData::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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.

Reimplemented in vtkOpenQubeElectronicData, and vtkProgrammableElectronicData.

◆ GetNumberOfMOs()

virtual vtkIdType vtkAbstractElectronicData::GetNumberOfMOs ( )
pure virtual

Returns the number of molecular orbitals available.

Implemented in vtkOpenQubeElectronicData, and vtkProgrammableElectronicData.

◆ GetNumberOfElectrons()

virtual vtkIdType vtkAbstractElectronicData::GetNumberOfElectrons ( )
pure virtual

Returns the number of electrons in the molecule.

Implemented in vtkProgrammableElectronicData, and vtkOpenQubeElectronicData.

◆ GetMO()

virtual vtkImageData* vtkAbstractElectronicData::GetMO ( vtkIdType  orbitalNumber)
pure virtual

Returns the vtkImageData for the requested molecular orbital.

Implemented in vtkProgrammableElectronicData, and vtkOpenQubeElectronicData.

◆ GetElectronDensity()

virtual vtkImageData* vtkAbstractElectronicData::GetElectronDensity ( )
pure virtual

Returns vtkImageData for the molecule's electron density. The data will be calculated when first requested, and cached for later requests.

Implemented in vtkProgrammableElectronicData, and vtkOpenQubeElectronicData.

◆ GetHOMO()

vtkImageData* vtkAbstractElectronicData::GetHOMO ( )
inline

Returns vtkImageData for the Highest Occupied Molecular Orbital.

Definition at line 53 of file vtkAbstractElectronicData.h.

◆ GetLUMO()

vtkImageData* vtkAbstractElectronicData::GetLUMO ( )
inline

Returns vtkImageData for the Lowest Unoccupied Molecular Orbital.

Definition at line 56 of file vtkAbstractElectronicData.h.

◆ GetHOMOOrbitalNumber()

vtkIdType vtkAbstractElectronicData::GetHOMOOrbitalNumber ( )
inline

Definition at line 60 of file vtkAbstractElectronicData.h.

◆ GetLUMOOrbitalNumber()

vtkIdType vtkAbstractElectronicData::GetLUMOOrbitalNumber ( )
inline

Definition at line 67 of file vtkAbstractElectronicData.h.

◆ IsHOMO()

bool vtkAbstractElectronicData::IsHOMO ( vtkIdType  orbitalNumber)
inline

Returns true if the given orbital number is the Highest Occupied Molecular Orbital, false otherwise.

Definition at line 75 of file vtkAbstractElectronicData.h.

◆ IsLUMO()

bool vtkAbstractElectronicData::IsLUMO ( vtkIdType  orbitalNumber)
inline

Returns true if the given orbital number is the Lowest Unoccupied Molecular Orbital, false otherwise.

Definition at line 84 of file vtkAbstractElectronicData.h.

◆ DeepCopy()

virtual void vtkAbstractElectronicData::DeepCopy ( vtkDataObject *  obj)
virtual

Deep copies the data object into this.

Reimplemented from vtkDataObject.

Reimplemented in vtkOpenQubeElectronicData, and vtkProgrammableElectronicData.

◆ GetPadding()

virtual double vtkAbstractElectronicData::GetPadding ( )
virtual

Get the padding between the molecule and the cube boundaries. This is used to determine the dataset's bounds.

Reimplemented in vtkOpenQubeElectronicData, and vtkProgrammableElectronicData.

Member Data Documentation

◆ Padding

double vtkAbstractElectronicData::Padding
protected

Definition at line 103 of file vtkAbstractElectronicData.h.


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