RayleighDampingFactors.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/>.
//----------------------------------------------------------------------------
//RayleighDampingFactors.h

#ifndef RayleighDampingFactors_h
#define RayleighDampingFactors_h

#include "utility/kernel/CommandEntity.h"
#include "utility/actor/actor/MovableObject.h"

class Pos3dArray3d;

namespace XC {

class Vector;
class Information;

//
class RayleighDampingFactors: public CommandEntity, public MovableObject
  {
    double alphaM; 
    double betaK; 
    double betaK0; 
    double betaKc; 
  protected:
    int sendData(Communicator &);
    int recvData(const Communicator &);

  public:
    RayleighDampingFactors(void);
    RayleighDampingFactors(const double &alphaM,const double &betaK,const double &betaK0,const double &betaKc);
    explicit RayleighDampingFactors(const Vector &);

    inline const double &getAlphaM(void) const
      { return alphaM; }
    inline void setAlphaM(const double &d)
      { alphaM= d; }
    inline const double &getBetaK(void) const
      { return betaK; }
    inline void setBetaK(const double &d)
      { betaK= d; }
    inline const double &getBetaK0(void) const
      { return betaK0; }
    inline void setBetaK0(const double &d)
      { betaK0= d; }
    inline const double &getBetaKc(void) const
      { return betaKc; }
    inline void setBetaKc(const double &d)
      { betaKc= d; }
    inline bool nullValues(void) const
      { return (alphaM == 0.0 && nullKValues()); }
    inline bool nullKValues(void) const
      { return (betaK == 0.0 && betaK0 == 0.0 && betaKc == 0.0); }
    int updateParameter(int parameterID, Information &info);

    double getCurrentDampingRatio(const double &) const;
    double getInitialDampingRatio(const double &) const;
    double getCommitedDampingRatio(const double &) const;
    
    int sendSelf(Communicator &);
    int recvSelf(const Communicator &);
    boost::python::dict getPyDict(void) const;
    void setPyDict(const boost::python::dict &);

    void Print(std::ostream &s, int flag= 0) const;

  };

std::ostream &operator<<(std::ostream &,const RayleighDampingFactors &);

} // end of XC namespace

#endif