Greens-code
A modular quantum transport code
List of all members
ChangeHop_Hamiltonian Class Reference

Decorator which modifies 1st nearest neighbor hopping. More...

#include <potential_hamiltonian.hpp>

Inheritance diagram for ChangeHop_Hamiltonian:
Inheritance graph
[legend]
Collaboration diagram for ChangeHop_Hamiltonian:
Collaboration graph
[legend]

Additional Inherited Members

- Public Types inherited from Hamiltonian
typedef STD_TR1::shared_ptr< Hamiltonianref
 
typedef STD_TR1::shared_ptr< const Hamiltonianconst_ref
 
- Public Types inherited from loadable_Object
typedef STD_TR1::shared_ptr< loadable_Objectref
 
typedef STD_TR1::shared_ptr< const loadable_Objectconst_ref
 
typedef std::pair< std::string, ref > ref_pair
 
typedef STD_TR1::weak_ptr< loadable_Objectlink
 
typedef STD_TR1::weak_ptr< const loadable_Objectconst_link
 
- Public Member Functions inherited from Hamiltonian
void create_H0 (Matrix &, const geometry_const_Iterator &) const
 fill a Matrix with the $ H_0 $ block
 
void create_HI (Matrix &, const geometry_const_Iterator &) const
 fill a Matrix with the $ H_I $ block
 
void create_HIt (Matrix &s, const geometry_const_Iterator &pos) const
 fill a Matrix with the $ H_I^\dagger$ block
 
size_t layers () const
 Number of layers of this Hamiltonian.
 
int ny (const geometry_const_Iterator &pos) const
 Number of total transverse points at given position.
 
int ny_layer (const geometry_const_Iterator &pos) const
 Number of transverse points in specific layer at given position.
 
point_Positions::ref rxy (const geometry_const_Iterator &pos) const
 point_Positions of the grid-points at given position
 
double dx (const geometry_const_Iterator &pos) const
 horizontal distance between adjacent sclices
 
double dy (const geometry_const_Iterator &pos) const
 vertical distance when going from one slice to the next, usually zero.
 
double dphi (const geometry_const_Iterator &pos) const
 directional change when going from one slice to the next, usually zero.
 
double width (const geometry_const_Iterator &pos) const
 width of the slice at given position
 
std::unique_ptr< pencilget_pencil () const
 Return one instance of a pencil used to drawing this Hamiltonian.
 
const std::string & pencil_name () const
 name of the pencil used to drawing this type of Hamiltonian.
 
STD_TR1::shared_ptr< simple_Hamiltonianget_simple_H ()
 
STD_TR1::shared_ptr< const simple_Hamiltonianget_simple_H () const
 
- Public Member Functions inherited from loadable_Object
void write_xml (std::ostream &) const
 Output the xml code that would construct the object to stream.
 
 loadable_Object ()
 Empty construction, objects are initialized by init routine.
 
const char * class_Name () const
 Calls virtual const char* name(), which must be redefined for derived classes.
 
bool get_param (const std::string &s, double &v) const
 get a double, integer or string parameter by name (s), return wether parameter exists
 
bool get_param (const std::string &s, int &v) const
 
bool get_param (const std::string &s, std::string &v) const
 
double get_double_param (const std::string &s) const
 get a double, integer or string parameter, throw if it does not exist
 
int get_int_param (const std::string &s) const
 
std::string get_string_param (const std::string &s) const
 
void set_param (const std::string &s, double v)
 set a double, integer or string parameter
 
void set_param (const std::string &s, int v)
 
void set_param (const std::string &s, std::string v)
 
bool get_bool (const std::string &s, const bool def) const
 return bool parameter, return def if string not found
 
void acquire_params (const const_ref &)
 import all parameters from another object
 
void insert_object (const std::string &s, ref o)
 insert an object as parameter
 
void link_object (const std::string &s, ref o)
 insert a link to an object as parameter, the refered object must be defined elsewhere
 
bool get_component (const std::string &s, const_ref &) const
 get a contained object by string s, return wether it exists
 
bool get_component (const std::string &s, ref &)
 
const_ref get_component (const std::string &s) const
 get a contained object by string s, throw if it does not exist
 
ref get_component (const std::string &s)
 
template<typename T >
STD_TR1::shared_ptr< T > get_dynamic_component (const std::string &s)
 get a contained object with a dynamic cast More...
 
template<typename T >
STD_TR1::shared_ptr< const T > get_dynamic_component (const std::string &s) const
 
ref get_ref ()
 Get a shared_ptr to this object. More...
 
const_ref get_ref () const
 
template<typename T >
STD_TR1::shared_ptr< T > get_dynamic_ref ()
 Get a dynamic reference to this object. More...
 
template<typename T >
STD_TR1::shared_ptr< const T > get_dynamic_ref () const
 
void initialize (ref me)
 called by the xml_parser to initialize the object More...
 
void set_correct_ref (ref me)
 called to set reference to object More...
 
bool is_initialized () const
 returns whether the object has been correctly initialized
 
void require_initialized () const
 throws if is_initialized returns false
 
void force_reinit ()
 call if parameters are changed, object is completely reinitialized, children are not
 
void register_Observer (Observer::ref)
 register/unregister Observer: All registered Observers will have notify() called upon state change (reinit)
 
void unregister_Observer (Observer::ref)
 
size_t nparams () const
 returns total number of parameters
 
ref clone () const
 returns a complete clone of the Object and all parameters (with correct dynamic type)
 
virtual size_t verbosity ()
 
- Static Public Member Functions inherited from loadable_Object
template<class T >
static STD_TR1::shared_ptr< const T > clone (const STD_TR1::shared_ptr< const T > r)
 
template<class T >
static STD_TR1::shared_ptr< T > clone (STD_TR1::shared_ptr< T > r)
 
- Protected Member Functions inherited from Hamiltonian_Decorator
Hamiltonian::const_ref get_H () const
 
Matrixget_m () const
 
const geometry_const_Iteratorget_pos () const
 

Detailed Description

Decorator which modifies 1st nearest neighbor hopping.

Name: ChangeHop_Decorator Parameters:

Objects: -sub_H: Hamiltonian -Potential: an Enumeration of Potentials


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