include/qcphase.h

/***************************************************************************
 *   Quantum Construct (qC++)                                                                  *
 *   The Quantum Physics Computational Library                                         *
 *   Copyright (C) 2005 by Shekhar S. Chandra                                      *
 *   Shekhar.Chandra@sci.monash,edu.au                                     *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
/*
        Ver Info - QCPhase.h
        1.0.0 - Original Implementation
*/

#ifndef QCPHASE_H
#define QCPHASE_H

#include "qccomplexfield.h"
#include "qcparameter.h"

class QCPhase
{
public:
        // -------------------------------------------------------
        QCPhase(void);
        ~QCPhase(void);

        // -------------------------------------------------------
        parameterType constantFunction();
        parameterType spiralFunction(parameterType  x, parameterType y);
        void applyUniform(QCComplexField<2> &field, parameterType  deltaX, parameterType deltaY, int x0, int y0);
        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);
        void applyRandomQuadrant(QCComplexField<2> &field, parameterType deltaX, parameterType deltaY, int x0, int y0);
        void applyVortex(QCComplexField<2> &field, parameterType  deltaX, parameterType deltaY, int x0, int y0);
        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);
        void applyDisturbanceTypeI(QCComplexField<2> &field, parameterType deltaX, parameterType deltaY, int x0, int y0);
        void applyDisturbanceTypeII(QCComplexField<2> &field, parameterType deltaX, parameterType deltaY, int x0, int y0);
        void applyDisturbanceTypeII(QCComplexField<3> &field, parameterType deltaX, parameterType deltaY, int x0, int y0);

        // -------------------------------------------------------
        bool outputPhaseFunction(QCComplexField<2> &field, const char* filename);
        bool outputPhaseFunction(QCComplexField<3> &field, const char* filename);

        // -------------------------------------------------------
        void setDisturbPosition(int position)
        {       disturbPosition = position;     }
        void setDisturbWidth(int width)
        {       disturbWidth = width;   }
        void setDisturbHeight(parameterType height)
        {       disturbHeight = height; }
        int getDisturbPosition()
        {       return disturbPosition; }
        int getDisturbWidth()
        {       return disturbWidth;    }
        parameterType getDisturbHeight()
        {       return disturbHeight;   }
private:
        int disturbPosition; 
        int disturbWidth; 
        parameterType disturbHeight; 
};
#endif

---