SFreedom_Constraint.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/>.
//----------------------------------------------------------------------------
/* ****************************************************************** **
**    OpenSees - Open System for Earthquake Engineering Simulation    **
**          Pacific Earthquake Engineering Research Center            **
**                                                                    **
**                                                                    **
** (C) Copyright 1999, The Regents of the University of California    **
** All Rights Reserved.                                               **
**                                                                    **
** Commercial use of this program without express permission of the   **
** University of California, Berkeley, is strictly prohibited.  See   **
** file 'COPYRIGHT'  in main directory for information on usage and   **
** redistribution,  and for a DISCLAIMER OF ALL WARRANTIES.           **
**                                                                    **
** Developed by:                                                      **
**   Frank McKenna (fmckenna@ce.berkeley.edu)                         **
**   Gregory L. Fenves (fenves@ce.berkeley.edu)                       **
**   Filip C. Filippou (filippou@ce.berkeley.edu)                     **
**                                                                    **
** ****************************************************************** */
                                                                        
// $Revision: 1.3 $
// $Date: 2005/11/22 19:41:17 $
// $Source: /usr/local/cvs/OpenSees/SRC/domain/constraints/SFreedom_Constraint.h,v $
                                                                        
                                                                        
#ifndef SFreedom_Constraint_h
#define SFreedom_Constraint_h

// Written: fmk 
// Created: 11/96
// Revision: A
//
// Purpose: This file contains the class definition for SFreedom_Constraint.
// SFreedom_Constraint is a class which stores the information for a single
// DOF constraint. Each single point constraint specifies a particular
// degree-of-freedom response (displacement, rotation) at a node.
// The constraint may be time-varying .. time varying constarints however 
// must be implemented using subclasses.
//
// What: "@(#) SFreedom_Constraint, revA"

#include "Constraint.h"

namespace XC {
  class ID;

//
//
class SFreedom_Constraint: public Constraint
  {
  protected:
    int dofNumber; 
    double valueR; 
    double valueC; 
    double initialValue; // the value of the dof when the sp constrain is added to the domain
    bool isConstant; 
    int loadPatternTag;

    DbTagData &getDbTagData(void) const;
    int sendData(Communicator &comm);
    int recvData(const Communicator &comm);

  public:
    // constructors
    SFreedom_Constraint(int classTag);        
    SFreedom_Constraint(int spTag, int nodeTag);
    SFreedom_Constraint(int spTag, int nodeTag, int ndof, int classTag);
    SFreedom_Constraint(int spTag, int nodeTag, int ndof, double value, bool isConstant= true);
    virtual SFreedom_Constraint *getCopy(void) const;
    SFreedom_Constraint *getCopy(const int &) const;

    virtual int getDOF_Number(void) const;
    virtual bool affectsNodeAndDOF(int , int ) const;
    virtual int applyConstraint(double loadFactor);    
    virtual double getValue(void) const;
    virtual double getInitialValue(void);
    virtual bool isHomogeneous(void) const;
    virtual void setLoadPatternTag(int loadPaternTag);
    virtual int getLoadPatternTag(void) const;

    void setDomain(Domain *);
    
    inline void setIsConstant(const bool &b)
      { isConstant= b; }
    inline bool getIsConstant(void) const
      { return isConstant; }

    int getVtkCellType(void) const;

    int sendSelf(Communicator &);
    int recvSelf(const Communicator &);
    virtual void Print(std::ostream &s, int flag =0) const;
    boost::python::dict getPyDict(void) const;
    void setPyDict(const boost::python::dict &);
  };
} // end of XC namespace

#endif