src/eigsolv/JDBSYM.h

Go to the documentation of this file.

//**************************************************************************
//
//                                 NOTICE
//
// This software is a result of the research described in the report
//
// " A comparison of algorithms for modal analysis in the absence 
//   of a sparse direct method", P. Arbenz, R. Lehoucq, and U. Hetmaniuk,
//  Sandia National Laboratories, Technical report SAND2003-1028J.
//
// It is based on the Epetra, AztecOO, and ML packages defined in the Trilinos
// framework ( http://software.sandia.gov/trilinos/ ).
//
// The distribution of this software follows also the rules defined in Trilinos.
// This notice shall be marked on any reproduction of this software, in whole or
// in part.
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// 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.
//
// Code Authors: U. Hetmaniuk (ulhetma@sandia.gov), R. Lehoucq (rblehou@sandia.gov)
//
//**************************************************************************
/**************************************************************************
 *                                                                         *
 *               Swiss Federal Institute of Technology (ETH)               *
 *                       CH-8092 Zuerich, Switzerland                      *
 *                                                                         *
 *                       (C) 1999 All Rights Reserved                      *
 *                                                                         *
 *                                NOTICE                                   *
 *                                                                         *
 *  Permission to use, copy, modify, and distribute this software and      *
 *  its documentation for any purpose and without fee is hereby granted    *
 *  provided that the above copyright notice appear in all copies and      *
 *  that both the copyright notice and this permission notice appear in    *
 *  supporting documentation.                                              *
 *                                                                         *
 *  Neither the Swiss Federal Institute of Technology nor the author make  *
 *  any representations about the suitability of this software for any     *
 *  purpose.  This software is provided ``as is'' without express or       *
 *  implied warranty.                                                      *
 *                                                                         *
 ***************************************************************************/

#ifndef JDBSYM_H
#define JDBSYM_H

#include "Epetra_ConfigDefs.h"

#include "Epetra_BLAS.h"
#include "Epetra_Comm.h"
#include "Epetra_LAPACK.h"
#include "Epetra_Operator.h"
#include "Epetra_Time.h"

#include "CheckingTools.h"
#include "FortranRoutines.h"
#include "ModalAnalysisSolver.h"
#include "MyMemory.h"
#include "ModalTools.h"
#include "LinSolvers.h"
#include "OrthoPack.h"
#include "Projectors.h"
#include "SortingTools.h"

namespace Teuchos {
    class ParameterList;
}

class JDBSYM: public ModalAnalysisSolver {

private:

    enum opType { OP_UNSYM1 = 1, OP_UNSYM2 = 2, OP_SYM = 3};

    const CheckingTools myVerify;
    const Epetra_BLAS callBLAS;
    const Epetra_LAPACK callLAPACK;
    OrthoPack ortho;
    ModalTools modalTool;
    const SortingTools mySort;

    const Epetra_Comm &MyComm;
    const Epetra_Operator *K;
    const Epetra_Operator *M;
    const Epetra_Operator *Prec;
    const Epetra_Time MyWatch;
    const Epetra_Operator *YHC;

    LinSolvers *linSolver;
    Projectors *projK;
    Projectors *projP;

    int historyCount;
    double *resHistory;

    int maxSpaceSize;
    int sumSpaceSize;
    int *spaceSizeHistory;

    int maxIterPCG;
    int sumIterPCG;
    int *iterPCGHistory;

    double memRequested;
    double highMem;

    int numCorrectionSolve;
    int numOrtho;
    int outerIter;
    int precOp;
    int residual;
    int stifOp;

    double timeBuildG;
    double timeBuildH;
    double timeCorrectionRHS;
    double timeCorrectionSolve;
    double timeLocalProj;
    double timeLocalSolve;
    double timeLocalUpdate;
    double timeNorm;
    double timeOrtho;
    double timeOuterLoop;
    double timePostProce;
    double timePrecOp;
    double timeResidual;
    double timeRestart;
    double timeStifOp;

    Teuchos::ParameterList& params_;

    // Don't define these functions
    JDBSYM(const JDBSYM &ref);
    JDBSYM & operator=(const JDBSYM &ref);

protected:

    int jdbsym(double tau, double jdtol,
               int kmax, int jmax, int jmin, int blockSize, int blkwise,
               int V0dim, double *V0,
               opType _optype, double eps_tr, double toldecay,
               int strategy, int max_it, int max_inner_it,
               int clvl,
               int &k_conv, double *Q, double *lambda, int &it);

    void validate(Epetra_MultiVector *Q, Epetra_MultiVector *MQ, Epetra_MultiVector *Y,
                  Epetra_MultiVector *V, double *H, int ldh, opType _optype, double *work1);

    void print_status(int clvl, int it, int k, int j, int kmax,
                      int _blkSize, int actblkSize,    
                      double *s, double *resnrm, int *actcorrits);

    void sorteig(int j, double S[], double U[], int ldu, double tau,
                 double dtemp[], int idx1[], int idx2[], int strategy);
    void quicksort(int n, double arr[], int idx[]);

public:

    JDBSYM(const Epetra_Comm &_Comm, const Epetra_Operator *KK,
           const Epetra_Operator *MM, const Epetra_Operator *PP, const Epetra_Operator *YHCP,
           Teuchos::ParameterList& params);

    ~JDBSYM();

    static void set_defaults(Teuchos::ParameterList& param, int kmax);

    int solve(int numEigen, Epetra_MultiVector &Q, double *lambda);

    int minimumSpaceDimension(int nev) const { return nev; };

    void initializeCounters();

    void algorithmInfo() const;
    void historyInfo() const;
    void memoryInfo() const;
    void operationInfo() const;
    void timeInfo() const;

};

#endif

---