TBTK
SpinPolarizedLDOS.h
Go to the documentation of this file.
1 /* Copyright 2016 Kristofer Bj√∂rnson
2  *
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
24 #ifndef COM_DAFER45_TBTK_SPIN_POLARIZED_LDOS
25 #define COM_DAFER45_TBTK_SPIN_POLARIZED_LDOS
26 
27 #include "TBTK/Property/AbstractProperty.h"
28 #include "TBTK/SpinMatrix.h"
29 
30 #include <complex>
31 
32 namespace TBTK{
33 namespace Property{
34 
37 class SpinPolarizedLDOS : public AbstractProperty<SpinMatrix>{
38 public:
41  int dimensions,
42  const int *ranges,
43  double lowerBound,
44  double upperBound,
45  int resolution
46  );
47 
50  int dimensions,
51  const int *ranges,
52  double lowerBound,
53  double upperBound,
54  int resolution,
55  const SpinMatrix *data
56  );
57 
60  const IndexTree &indexTree,
61  double lowerBound,
62  double upperBound,
63  int resolution
64  );
65 
68  const IndexTree &indexTree,
69  double lowerBound,
70  double upperBound,
71  int resolution,
72  const SpinMatrix *data
73  );
74 
76  SpinPolarizedLDOS(const SpinPolarizedLDOS &spinPolarizedLDOS);
77 
79  SpinPolarizedLDOS(SpinPolarizedLDOS &&spinPolarizedLDOS);
80 
83  SpinPolarizedLDOS(const std::string &serialization, Mode mode);
84 
87 
89  double getLowerBound() const;
90 
92  double getUpperBound() const;
93 
95  int getResolution() const;
96 
99 
102 
104  std::string serialize(Mode mode) const;
105 private:
107  double lowerBound;
108 
110  double upperBound;
111 
113  int resolution;
114 };
115 
116 inline double SpinPolarizedLDOS::getLowerBound() const{
117  return lowerBound;
118 }
119 
120 inline double SpinPolarizedLDOS::getUpperBound() const{
121  return upperBound;
122 }
123 
125  return resolution;
126 }
127 
128 }; //End namespace Property
129 }; //End namespace TBTK
130 
131 #endif
std::string serialize(Mode mode) const
SpinPolarizedLDOS(int dimensions, const int *ranges, double lowerBound, double upperBound, int resolution)
double getUpperBound() const
Definition: SpinPolarizedLDOS.h:120
double getLowerBound() const
Definition: SpinPolarizedLDOS.h:116
Abstract Property class.
Definition: AbstractProperty.h:41
int getResolution() const
Definition: SpinPolarizedLDOS.h:124
Data structure for mapping physical indices to a linear index.
Definition: IndexTree.h:34
Definition: ModelFactory.h:35
Property container for spin-polarized local density of states (spin-polarized LDOS).
Definition: SpinPolarizedLDOS.h:37
Mode
Definition: Serializable.h:44
SpinPolarizedLDOS & operator=(const SpinPolarizedLDOS &rhs)
Definition: SpinMatrix.h:33