include/qcggs.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 - QCGGS.h
        1.0.0 - Original Implementation
*/

#ifndef QCGGS_H
#define QCGGS_H

#include <string>

#include "qccomplexfield.h"
#include "qc2componentbec.h"

class QCGGS
{
public:
    // -------------------------------------------------------
    QCGGS();
    ~QCGGS();

    // -------------------------------------------------------
    void setNoOfImages(int number);
    void setIteration(int number)
    {   iterationNo = number;        }
    void setMaxIterations(int max)
    {   maxIterations = max;        }
    void setMaxTimeSteps(int max)
    {   maxTimeSteps = max;        }
    void setFilePrefix(string prefix)
    {   filePrefix = prefix;        }
    void setSystem(QCQuantumSystem<complexType,2> &system);
    void setSystem(QC2ComponentBEC<2> &system);
    void setGuess(parameterType mag, parameterType phase);
    int getNoOfImages()
    {   return noOfImages;          }
    int getIterationNo()
    {   return iterationNo;          }
    int getMaxIterations()
    {   return maxIterations;       }
    int getTimeSteps()
    {   return maxTimeSteps;        }
    string getFilePrefix()
    {   return filePrefix;          }
    QCQuantumSystem<complexType,2>* getSystem()
    {   return ptrSystem;           }
    void loadImages(string extension);
    void writeResults(string extension);
    void writeOriginals(string extension);

    // -------------------------------------------------------
    void copyField(QCComplexField<2>& dest, QCComplexField<2>& source);
    void copyField(QCComplexField<2>& dest, Array<complexType,2>& source);
    void updateMagnitude(QCComplexField<2>& image, QCComplexField<2>& result);
    void updateMagnitude(QCComplexField<2>& image, Array<complexType,2>& result);
    parameterType RMSError(QCComplexField<2>& original, QCComplexField<2>& result);
    parameterType RMSError(QCComplexField<2>& original, Array<complexType,2> &result);
    parameterType iterate(QCBEC<2> &bec);
    parameterType iterate(QC2ComponentBEC<2> &bec);


protected:
    int noOfImages; 
    int iterationNo; 
    int maxIterations; 
    int maxTimeSteps; 
    parameterType rmsError; 
    string filePrefix; 
    QCQuantumSystem<complexType,2> *ptrSystem; 
    Array<complexType,2> *ptrField; 
    Array<complexType,2> *ptrField2; 
    Array<QCComplexField<2>,1> GSPhases; 
    Array<QCComplexField<2>,1> GSPhases2; 
    Array<QCComplexField<2>,1> Images; 
    Array<QCComplexField<2>,1> Images2; 
    bool twoCompBEC; 
};

#endif // QCGGS_H

---