VTK  9.1.0
vtkOpenQubeElectronicData.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkOpenQubeElectronicData.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
21 #ifndef vtkOpenQubeElectronicData_h
22 #define vtkOpenQubeElectronicData_h
23 
25 #include "vtkDomainsChemistryModule.h" // For export macro
26 #include "vtkNew.h" // for vtkNew
27 
28 namespace OpenQube
29 {
30 class BasisSet;
31 class Cube;
32 }
33 
34 class vtkImageData;
36 
37 class VTKDOMAINSCHEMISTRY_EXPORT vtkOpenQubeElectronicData : public vtkAbstractElectronicData
38 {
39 public:
42  void PrintSelf(ostream& os, vtkIndent indent);
43 
48 
53 
57  unsigned int GetNumberOfElectrons();
58 
63  vtkImageData* GetMO(vtkIdType orbitalNumber);
64 
70 
72 
75  vtkSetMacro(BasisSet, OpenQube::BasisSet*);
76  vtkGetMacro(BasisSet, OpenQube::BasisSet*);
78 
80 
84  vtkSetMacro(Padding, double);
85  vtkGetMacro(Padding, double);
87 
89 
92  vtkSetMacro(Spacing, double);
93  vtkGetMacro(Spacing, double);
95 
97 
102 
106  virtual void DeepCopy(vtkDataObject* obj);
107 
108 protected:
111 
113 
120 
124  void FillImageDataFromQube(OpenQube::Cube* qube, vtkImageData* image);
125 
130 
134  OpenQube::BasisSet* BasisSet;
135 
139  double Spacing;
140 
141 private:
143  void operator=(const vtkOpenQubeElectronicData&) = delete;
144 };
145 
146 #endif
VTK_OPEN_QUBE_ELECTRONIC_DATA
#define VTK_OPEN_QUBE_ELECTRONIC_DATA
Definition: vtkType.h:120
vtkOpenQubeElectronicData::New
static vtkOpenQubeElectronicData * New()
vtkOpenQubeElectronicData::GetElectronDensity
vtkImageData * GetElectronDensity()
Returns vtkImageData for the molecule's electron density.
vtkOpenQubeElectronicData::BasisSet
OpenQube::BasisSet * BasisSet
The OpenQube::BasisSet object used to calculate the images.
Definition: vtkOpenQubeElectronicData.h:134
vtkIdType
int vtkIdType
Definition: vtkType.h:332
vtkX3D::image
@ image
Definition: vtkX3D.h:380
vtkOpenQubeElectronicData
Provides access to and storage of electronic data calculated by OpenQube.
Definition: vtkOpenQubeElectronicData.h:38
vtkOpenQubeElectronicData::~vtkOpenQubeElectronicData
~vtkOpenQubeElectronicData() override
vtkOpenQubeElectronicData::DeepCopy
virtual void DeepCopy(vtkDataObject *obj)
Deep copies the data object into this.
vtkAbstractElectronicData
Provides access to and storage of chemical electronic data.
Definition: vtkAbstractElectronicData.h:31
vtkOpenQubeElectronicData::vtkGetNewMacro
vtkGetNewMacro(Images, vtkDataSetCollection)
Get the collection of cached images.
vtkOpenQubeElectronicData::GetDataObjectType
int GetDataObjectType() override
Returns VTK_OPEN_QUBE_ELECTRONIC_DATA.
Definition: vtkOpenQubeElectronicData.h:47
vtkOpenQubeElectronicData::CalculateMO
vtkImageData * CalculateMO(vtkIdType orbitalNumber)
Calculates and returns the requested vtkImageData.
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkOpenQubeElectronicData::GetNumberOfMOs
vtkIdType GetNumberOfMOs()
Returns the number of molecular orbitals in the OpenQube::BasisSet.
vtkNew< vtkDataSetCollection >
vtkOpenQubeElectronicData::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkOpenQubeElectronicData::GetNumberOfElectrons
unsigned int GetNumberOfElectrons()
Returns the number of electrons in the molecule.
vtkOpenQubeElectronicData::Spacing
double Spacing
Used to determine the spacing of the image data.
Definition: vtkOpenQubeElectronicData.h:139
vtkOpenQubeElectronicData::CalculateElectronDensity
vtkImageData * CalculateElectronDensity()
Calculates and returns the requested vtkImageData.
vtkNew.h
vtkOpenQubeElectronicData::Images
vtkNew< vtkDataSetCollection > Images
Cache of calculated image data.
Definition: vtkOpenQubeElectronicData.h:129
OpenQube
Definition: vtkOpenQubeElectronicData.h:29
vtkAbstractElectronicData.h
vtkDataSetCollection
maintain an unordered list of dataset objects
Definition: vtkDataSetCollection.h:61
vtkOpenQubeElectronicData::FillImageDataFromQube
void FillImageDataFromQube(OpenQube::Cube *qube, vtkImageData *image)
Converts an OpenQube::Cube object into vtkImageData.
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:169
vtkOpenQubeElectronicData::vtkOpenQubeElectronicData
vtkOpenQubeElectronicData()
vtkOpenQubeElectronicData::GetMO
vtkImageData * GetMO(vtkIdType orbitalNumber)
Returns the vtkImageData for the requested molecular orbital.