xc
Parameter.h
1 // -*-c++-*-
2 //----------------------------------------------------------------------------
3 // XC program; finite element analysis code
4 // for structural analysis and design.
5 //
6 // Copyright (C) Luis Claudio Pérez Tato
7 //
8 // This program derives from OpenSees <http://opensees.berkeley.edu>
9 // developed by the «Pacific earthquake engineering research center».
10 //
11 // Except for the restrictions that may arise from the copyright
12 // of the original program (see copyright_opensees.txt)
13 // XC is free software: you can redistribute it and/or modify
14 // it under the terms of the GNU General Public License as published by
15 // the Free Software Foundation, either version 3 of the License, or
16 // (at your option) any later version.
17 //
18 // This software is distributed in the hope that it will be useful, but
19 // WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 // GNU General Public License for more details.
22 //
23 //
24 // You should have received a copy of the GNU General Public License
25 // along with this program.
26 // If not, see <http://www.gnu.org/licenses/>.
27 //----------------------------------------------------------------------------
28 /* ****************************************************************** **
29 ** OpenSees - Open System for Earthquake Engineering Simulation **
30 ** Pacific Earthquake Engineering Research Center **
31 ** **
32 ** **
33 ** (C) Copyright 2001, The Regents of the University of California **
34 ** All Rights Reserved. **
35 ** **
36 ** Commercial use of this program without express permission of the **
37 ** University of California, Berkeley, is strictly prohibited. See **
38 ** file 'COPYRIGHT' in main directory for information on usage and **
39 ** redistribution, and for a DISCLAIMER OF ALL WARRANTIES. **
40 ** **
41 ** Developed by: **
42 ** Frank McKenna (fmckenna@ce.berkeley.edu) **
43 ** Gregory L. Fenves (fenves@ce.berkeley.edu) **
44 ** Filip C. Filippou (filippou@ce.berkeley.edu) **
45 ** **
46 ** ****************************************************************** */
47 
48 // $Revision: 1.7 $
49 // $Date: 2008/08/26 15:38:37 $
50 // $Source: /usr/local/cvs/OpenSees/SRC/domain/component/Parameter.h,v $
51 
52 #ifndef Parameter_h
53 #define Parameter_h
54 
55 #include "utility/tagged/TaggedObject.h"
56 #include "domain/mesh/element/utils/Information.h"
57 #include "utility/actor/actor/MovableObject.h"
58 
59 namespace XC {
60 
61 class DomainComponent;
62 class Channel;
63 class FEM_ObjectBroker;
64 class Domain;
65 
66 class Parameter: public TaggedObject, public MovableObject
67  {
68  private:
69  Information theInfo;
70  double currentValue;
71 
72  enum {initialSize = 64};
73  enum {expandSize = 128};
74 
75  std::vector<DomainComponent *> theComponents;
76  int numComponents;
77  int maxNumComponents;
78 
79  std::vector<MovableObject *> theObjects;
80  int numObjects;
81  int maxNumObjects;
82 
83  std::vector<int> parameterID;
84 
85  int gradIndex; // 0,...,nparam-1
86  public:
87  Parameter(int tag, DomainComponent *theObject, const std::vector<std::string> &);
88  Parameter(const Parameter &param);
89  Parameter(int tag, int classTag = PARAMETER_TAG_Parameter);
90  Parameter();
91 
92  virtual void Print(std::ostream &s, int flag =0) const;
93 
94  virtual int update(int newValue);
95  virtual int update(double newValue);
96  virtual int activate(bool active);
97  virtual double getValue(void) {return theInfo.theDouble;}
98  virtual void setValue(double newValue) {theInfo.theDouble = newValue;}
99 
100  virtual int addComponent(DomainComponent *theObject, const std::vector<std::string> &);
101  virtual int addObject(int parameterID, MovableObject *object);
102 
103  void setGradIndex(int gradInd) {gradIndex = gradInd;}
104  int getGradIndex(void) {return gradIndex;}
105 
106  virtual inline std::string getType(void)
107  { return "FEModel"; }
108 
109  virtual void setDomain(Domain *theDomain);
110  virtual int sendSelf(Communicator &);
111  virtual int recvSelf(const Communicator &);
112  };
113 } // end of XC namespace
114 
115 #endif
Base class for domain components (nodes, elements, constraints, loads,...).
Definition: DomainComponent.h:85
Information about an element.
Definition: Information.h:81
Communication parameters between processes.
Definition: Communicator.h:66
Object that can move between processes.
Definition: MovableObject.h:100
virtual int recvSelf(const Communicator &)
Receive the object.
Definition: Parameter.cpp:197
virtual int sendSelf(Communicator &)
Send the object.
Definition: Parameter.cpp:194
Object idenfied by an integer (tag).
Definition: TaggedObject.h:92
Open source finite element program for structural analysis.
Definition: ContinuaReprComponent.h:35
Definition: Parameter.h:66
virtual void Print(std::ostream &s, int flag=0) const
Print stuff.
Definition: Parameter.cpp:171
Domain (mesh and boundary conditions) of the finite element model.
Definition: Domain.h:116