QCPhase Class Reference

Class designed to encapsulate the Phase Operator, as well as other important phase related functions and manipulations. More...

#include <qcphase.h>

List of all members.

Public Member Functions
Constructors
	QCPhase (void)
	Standard Constructor.
	~QCPhase (void)
	Standard Destructor.
Phase Functions
parameterType	constantFunction ()
	Returns the phase value based on the x and y positions. This function returns the phase to form a constant distribution.
parameterType	spiralFunction (parameterType x, parameterType y)
	Returns the phase value based on the x and y positions. This function returns the phase to form a spiral distribution.
void	applyUniform (QCComplexField< 2 > &field, parameterType deltaX, parameterType deltaY, int x0, int y0)
	Applies a uniform topological phase distribution for 3D Fields. Uses the constant function to do this.
void	applyUniform (QCComplexField< 3 > &field, parameterType deltaX, parameterType deltaY, parameterType deltaZ, int x0, int y0, int z0)
void	applyRandom (QCComplexField< 2 > &field, parameterType deltaX, parameterType deltaY, int x0, int y0)
	Applies a random topological phase distribution.
void	applyRandomQuadrant (QCComplexField< 2 > &field, parameterType deltaX, parameterType deltaY, int x0, int y0)
	Applies a random topological phase distribution at each quadrant, i.e. each quadrant has a random phase assigned to it.
void	applyVortex (QCComplexField< 2 > &field, parameterType deltaX, parameterType deltaY, int x0, int y0)
	Applies a topological phase distribution according to that of a vortex to the 3D field. Uses the spiral function to do this.
void	applyVortex (QCComplexField< 3 > &field, parameterType deltaX, parameterType deltaY, parameterType deltaZ, int x0, int y0, int z0)
void	applyVortexReverse (QCComplexField< 2 > &field, parameterType deltaX, parameterType deltaY, int x0, int y0)
	Applies a topological phase distribution according to that of a vortex reverse to that of the above function. Uses the spiral function to do this.
void	applyDisturbanceTypeI (QCComplexField< 2 > &field, parameterType deltaX, parameterType deltaY, int x0, int y0)
	Applies a disturbance in the phase of the system configuration in the form of a single square wave.
void	applyDisturbanceTypeII (QCComplexField< 2 > &field, parameterType deltaX, parameterType deltaY, int x0, int y0)
	Applies a disturbance in the phase of the system configuration in the form of a one-sided gradient step.
void	applyDisturbanceTypeII (QCComplexField< 3 > &field, parameterType deltaX, parameterType deltaY, int x0, int y0)
	Applies a disturbance in the phase of the system configuration in the form of a one-sided gradient step to a 3D Field.
I/O Operations
bool	outputPhaseFunction (QCComplexField< 2 > &field, const char *filename)
	Outputs the phase distribution of the 3D field.
bool	outputPhaseFunction (QCComplexField< 3 > &field, const char *filename)
Data Operations
void	setDisturbPosition (int position)
	Sets the position of the disturbance in the phase of the field.
void	setDisturbWidth (int width)
	Sets the width of the disturbance in the phase of the field.
void	setDisturbHeight (parameterType height)
	Sets the height of the disturbance in the phase of the field.
int	getDisturbPosition ()
	Returns the position of the disturbance in the phase of the field.
int	getDisturbWidth ()
	Returns the height of the disturbance in the phase of the field.
parameterType	getDisturbHeight ()

---

Detailed Description

Class designed to encapsulate the Phase Operator, as well as other important phase related functions and manipulations.

Definition at line 37 of file qcphase.h.

---

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

• include/qcphase.h
• src/qcphase.cpp

---