LoadPattern.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.12 $
// $Date: 2005/11/22 19:44:22 $
// $Source: /usr/local/cvs/OpenSees/SRC/domain/load/pattern/LoadPattern.h,v $
                                                                        
                                                                        
#ifndef LoadPattern_h
#define LoadPattern_h

// Written: fmk 
// Created: 07/99
// Revision: A
//
// Purpose: This file contains the class definition for LoadPattern.
// LoadPattern is a concrete class
//
// What: "@(#) LoadPattern.h, revA"

#include "NodeLocker.h"
#include "LoadContainer.h"
#include <utility/matrix/Vector.h>

namespace XC {
class NodalLoad;
class TimeSeries;
class ElementalLoad;
class NodalLoadIter;
class ElementalLoadIter;
class GroundMotion;
class Vector;
class MapLoadPatterns;

//
//
class LoadPattern: public NodeLocker
  {
  private:
    std::string description; 
    double loadFactor; 
    double gamma_f; 

    TimeSeries *theSeries; 

    // storage objects for the loads.
    LoadContainer theLoads; 

    // AddingSensitivity:BEGIN //////////////////////////////////////
    Vector randomLoads;
    bool RVisRandomProcessDiscretizer;
    // AddingSensitivity:END ////////////////////////////////////////

    void free(void);
  protected:
    bool isConstant; 
    DbTagData &getDbTagData(void) const;
    int sendData(Communicator &comm);
    int recvData(const Communicator &comm);
  public:
    LoadPattern(int tag= 0);
    LoadPattern(int tag, int classTag); // for subclasses
    virtual ~LoadPattern(void);

    // method to set the associated TimeSeries and Domain
    const TimeSeries *getTimeSeries(void) const;
    TimeSeries *getTimeSeries(void);
    virtual void setTimeSeries(TimeSeries *theSeries);
    virtual void setDomain(Domain *theDomain);
    bool addToDomain(void);
    void removeFromDomain(void);
    virtual bool isActive(void) const;

    // methods to add loads
    virtual bool addNodalLoad(NodalLoad *);
    NodalLoad *newNodalLoad(const int &,const Vector &);
    virtual bool addElementalLoad(ElementalLoad *);
    bool newElementalLoad(ElementalLoad *);
    ElementalLoad *newElementalLoad(const std::string &);
    virtual bool addSFreedom_Constraint(SFreedom_Constraint *theSp);

    inline LoadContainer &getLoads(void)
      { return theLoads; }
    inline const LoadContainer &getLoads(void) const
      { return theLoads; }
    inline int getNumNodalLoads(void) const
      { return theLoads.getNumNodalLoads(); }
    inline int getNumElementalLoads(void) const
      { return theLoads.getNumElementalLoads(); }
    inline int getNumLoads(void) const
      { return theLoads.getNumLoads(); }
    bool empty(void) const;

    // methods to remove things (loads, time_series,...)
    virtual void clearAll(void);
    virtual void clearLoads(void);
    virtual bool removeNodalLoad(int tag);
    virtual bool removeElementalLoad(int tag);

    bool actsOn(const Node *) const;
    void removeLoadsOn(const Node *);
    void copyLoads(const Node *, const Node *);
    bool actsOn(const Element *) const;
    void removeLoadsOn(const Element *);
    void copyLoads(const Element *, const Element *);
    
    // methods to apply loads
    virtual void applyLoad(double pseudoTime = 0.0);
    virtual void setLoadConstant(void);
    inline void setIsConstant(const bool &b)
      { isConstant= b; }
    inline bool getIsConstant(void) const
      { return isConstant; }

    const MapLoadPatterns *getMapLoadPatterns(void) const;
    MapLoadPatterns *getMapLoadPatterns(void);    
    const std::string &getName(void) const;
    std::string getFactoredName(void) const;
    inline const std::string &getDescription(void) const
      { return description; }
    inline void setDescription(const std::string &d)
      { description= d; }
    virtual const double &getLoadFactor(void) const;
    const double &GammaF(void) const;
    double &GammaF(void);
    void setGammaF(const double &);
    LoadPattern &operator*=(const double &fact);
    LoadPattern &operator/=(const double &fact); 
    // methods for o/p    
    boost::python::dict getPyDict(void) const;
    void setPyDict(const boost::python::dict &);
    
    virtual int sendSelf(Communicator &);
    virtual int recvSelf(const Communicator &);

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

    virtual LoadPattern *getCopy(void);

    virtual int addMotion(GroundMotion &theMotion, int tag);
    virtual GroundMotion *getMotion(int tag);

    // AddingSensitivity:BEGIN //////////////////////////////////////////
    virtual void applyLoadSensitivity(double pseudoTime = 0.0);
    virtual int  setParameter(const std::vector<std::string> &argv, Parameter &param);
    virtual int  updateParameter(int parameterID, Information &info);
    virtual int  activateParameter(int parameterID);
    virtual const Vector &getExternalForceSensitivity(int gradNumber);
    // AddingSensitivity:END ///////////////////////////////////////////
  };

} // end of XC namespace

#endif