EigenSOE.h

// -*-c++-*-
//----------------------------------------------------------------------------
//  XC program; finite element analysis code
//  for structural analysis and design.
//
//  Copyright (C)  Luis C. Pérez Tato
//
//  This program derives from OpenSees <http://opensees.berkeley.edu>
//  developed by the  «Pacific earthquake engineering research center».
//
//  Except for the restrictions that may arise from the copyright
//  of the original program (see copyright_opensees.txt)
//  XC 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 3 of the License, or 
//  (at your option) any later version.
//
//  This software 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, see <http://www.gnu.org/licenses/>.
//----------------------------------------------------------------------------
// File: ~/system_of_eqn/eigenSOE/EigenSOE.h
//
// Written: Jun Peng
// Created: Sat Feb. 6, 1999
// Revision: A
//
// Description: This file contains the class definition of EigenSOE.
// EigenSOE is a subclass of SystemOfEqn.
// It has pure virtual functions which must be implemented in it's derived
// subclasses. To solve the general eigen value equations means that
// by the given K and M, find the corresponding eigen value and eigen
// vectors.
//
// This class is inherited from the base class of SystemOfEqn
// which was created by fmk (Frank).


#ifndef EigenSOE_h
#define EigenSOE_h

#include <solution/system_of_eqn/SystemOfEqn.h>
#include "/usr/include/boost/numeric/ublas/matrix_sparse.hpp"

namespace XC {
class EigenSolver;
class Matrix;
class Vector;
class ID;

//
//
class EigenSOE: public SystemOfEqn
  {
  public:
    typedef boost::numeric::ublas::mapped_matrix<double> sparse_matrix;
  protected:
    int size; 
    bool factored;
    sparse_matrix massMatrix; 
    EigenSolver *theSolver;

    void free_mem(void);
    void copy(const EigenSolver *);
    virtual bool setSolver(EigenSolver *);
    void resize_mass_matrix_if_needed(const size_t &);

    EigenSOE(SolutionStrategy *,int classTag);
  public:
    virtual ~EigenSOE(void);
     
    int getNumEqn(void) const;

    virtual int solve(int numModes);
    virtual int solve(void);
    virtual double getDeterminant(void);
    virtual double getRCond(const char &norm= '1');
     
    // pure virtual functions
    virtual int addA(const Matrix &, const ID &, double fact = 1.0) = 0;
    virtual int addM(const Matrix &, const ID &, double fact = 1.0) = 0;

    virtual int setSize(Graph &theGraph) = 0;
    virtual void zeroA(void) = 0;
    virtual void zeroM(void);
    virtual void identityM(void);
    virtual boost::python::list getMPy(void) const;

    const int &getNumModes(void) const;
    bool standardProblem(void) const;

    //Eigenvectors
    virtual const Vector &getEigenvector(int mode) const;
    Vector getNormalizedEigenvector(int mode) const;
    Matrix getEigenvectors(void) const;
    Matrix getNormalizedEigenvectors(void) const;

    //Eigenvalues
    virtual const double &getEigenvalue(int mode) const;
    double getAngularFrequency(int mode) const;
    double getPeriod(int mode) const;
    double getFrequency(int mode) const;
    Vector getEigenvalues(const int &numModes) const;
    Vector getEigenvalues(void) const;
    Vector getAngularFrequencies(void) const;
    Vector getPeriods(void) const;
    Vector getFrequencies(void) const;

    //Modal participation factors.
    virtual double getModalParticipationFactor(int mode) const;
    Vector getModalParticipationFactors(const int &numModes) const;
    Vector getModalParticipationFactors(void) const;

    //Distribution factors.
    Vector getDistributionFactor(int mode) const;
    Matrix getDistributionFactors(void) const;

    //Effective modal masses
    double getEffectiveModalMass(int mode) const;
    Vector getEffectiveModalMasses(void) const;
    double getTotalMass(void) const;

    //Equivalent static load.
    Vector getEquivalentStaticLoad(int mode,const double &) const;

    EigenSolver *getSolver(void);
    EigenSolver &newSolver(const std::string &);
  };
} // end of XC namespace

#endif