QCQuantumSystem< T, rank > Class Template Reference

Class designed to represent the basis of a quantum system and all numerical calculations. Uses other relevant QC objects to achieve this basis. More...

#include <qcquantumsystem.h>

List of all members.

Public Member Functions

Constructors
 QCQuantumSystem (void)
 Standard Constructor.
virtual ~QCQuantumSystem (void)
 Standard Destructor.
System Characteristic Operations
virtual void setSize (int noOfRows, int noOfCols)
 Sets the size of the Field destroying data currently held.
void resize (int &noOfRows, int &noOfCols)
 Resizes the Field while perserving data currently held (if within resized area).
void setDeltaT (parameterType value)
 Sets the value of the time-step used in numerical calculations.
void setDeltaX (parameterType value)
 Sets the value of the x-step used in numerical calculations.
void setDeltaY (parameterType value)
 Sets the value of the y-step used in numerical calculations.
void setDeltaR (parameterType value)
 Sets the value of the radial-step used in numerical calculations.
void setXOffset (int value)
 Sets the value of the x coordinate offset.
void setYOffset (int value)
 Sets the value of the y coordinate offset.
void setTolerance (parameterType value)
 Sets the value of the tolerance used in numerical calculations.
void setFileName (string name)
 Sets the name of the output file.
int getNoOfRows ()
 Returns the number of rows of the Field.
int getNoOfColumns ()
 Returns the number of columns of the Field.
parameterType getDeltaT ()
 Sets the value of the time-step used in numerical calculations.
parameterType getDeltaX ()
 Returns the value of the x-step used in numerical calculations.
parameterType getDeltaY ()
 Returns the value of the y-step used in numerical calculations.
parameterType getDeltaR ()
 Returns the value of the radial-step used in numerical calculations.
parameterType getXOffset ()
 Returns the value of the x coordinate offset.
parameterType getYOffset ()
 Returns the value of the y coordinate offset.
parameterType getTolerance ()
 Returns the value of the tolerance used in numerical calculations.
string getFileName ()
 Returns the currently stored name of the output file as an std::string.
const char * getFileNameCSTR ()
 Returns the currently stored name of the output file as an c-string.
virtual void writeImage (int shot, string filePrefix, string extension)
 Writes the current state of the field to file (with built in seqencing system).
Array< T, rank > * accessData ()
 Returns the Blitz++ Array containing data.

Protected Attributes

QCEvolve Evolve
 Structure used to evolve the field.
QCSteadyState SteadyState
 Structure used to determine the steady state solution of the field.
QCField< T, rank > * ptrField
 Pointer to the base of the Field to be implemented.
QCParameter SystemParameters
 Container for the parameters to be used in the calculations.
parameterType deltaX
 x-step value
parameterType deltaY
 y-step value
parameterType deltaR
 radial-step value
int xOffset
 X-Co-ordinate Offset.
int yOffset
 Y-Co-ordinate Offset.
string outFileName
 Output File Name.


Detailed Description

template<typename T, int rank>
class QCQuantumSystem< T, rank >

Class designed to represent the basis of a quantum system and all numerical calculations. Uses other relevant QC objects to achieve this basis.

Author:
Shekhar S. Chandra

Definition at line 48 of file qcquantumsystem.h.


The documentation for this class was generated from the following file:
Generated on Sat May 13 13:22:50 2006 for Quantum Construct (qC++) by  doxygen 1.4.6-NO