A class to create wavefunctions out of eigenstates, scattering states, or geometries. More...
#include <generate_wavefunction.hpp>
Inheritance diagram for image_Factory:
Collaboration diagram for image_Factory:
Public Types | |
| typedef STD_TR1::shared_ptr< image_Factory > | ref |
 Public Types inherited from state_worker | |
| typedef STD_TR1::shared_ptr< const state_worker > | const_ref |
| typedef STD_TR1::shared_ptr< state_worker > | ref |
| Public Types inherited from executable_Object | |
| typedef STD_TR1::shared_ptr< executable_Object > | ref |
| Public Types inherited from loadable_Object | |
| typedef STD_TR1::shared_ptr< loadable_Object > | ref |
| typedef STD_TR1::shared_ptr< const loadable_Object > | const_ref |
| typedef std::pair< std::string, ref > | ref_pair |
| typedef STD_TR1::weak_ptr< loadable_Object > | link |
| typedef STD_TR1::weak_ptr< const loadable_Object > | const_link |
Public Member Functions | |
| std::unique_ptr< Bild > | Image (MPI_Comm comm, const state s, const size_t drawing_layer) |
| Public Member Functions inherited from state_worker | |
| void | process_wvs (MPI_Comm comm, const state_collection::const_ref sc) |
| process wavefunction of Rectangle in state, using filen and n More... | |
| void | process_geometry (const std::string &filen, const STD_TR1::shared_ptr< const Rectangle > &rect) |
| create a wv showing geometry of Rectangle, use filen to create output filename | |
| void | process_potential (const std::string &filen, const STD_TR1::shared_ptr< const Rectangle > &rect) |
| create a wv showing potential inside Rectangle, use filen to create output filename | |
| int | n_start () |
| return the starting index of a file | |
| void | prepare_wv (const STD_TR1::shared_ptr< const Rectangle > &r) |
| prepae wavefunction creation, usually you do not need to call this explicitly | |
| Public Member Functions inherited from executable_Object | |
| void | setup_data (const std::string &f, size_t n) |
| void | reinitialize_param (const std::string ¶m_name) |
| void | perform (MPI_Comm comm, size_t rd) |
| void | post_process (MPI_Comm comm, const std::vector< int > &thread_ids) |
| void | perform (MPI_Comm comm, const std::string &f) |
| 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 () |
Additional Inherited Members | |
| 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 state_worker | |
| t_filename_list_ref | get_filenames (MPI_Comm, const std::string &head, const std::string &getfilen, const std::string &identifier) const |
| Protected Member Functions inherited from executable_Object | |
| const std::string & | get_filen () const |
| std::string | get_id_filen () const |
| size_t | get_run_id () const |
| size_t | get_N () const |
| int | get_thread_id (int i) const |
Detailed Description
A class to create wavefunctions out of eigenstates, scattering states, or geometries.
Image_Factory: XML-name "Image"
Parameters:
zoom: real, optional (default 1.0), number of pixels per grid point
n_start: int, optional (default 1), index of the first picture
prepend_zero: bool, optional (default true), whether to prepend 0 to filename number
write_geometry: bool, optional(default false), whether to create a geometry image
write_potential: bool, optional(default false), whether to create a potential image
processor: possible enumeration of processors, that will work on the image
subtract_average: bool, optional(default false), subtract average of all pixels before drawing subtract_minimum: bool, optional(default false), subtract minimum of all pixels before drawing
The documentation for this class was generated from the following files:
- src/geometries/inc/generate_wavefunction.hpp
- src/geometries/src/generate_wavefunction.cpp
