xc
CFactorSeries.h
1 // -*-c++-*-
2 //----------------------------------------------------------------------------
3 // XC program; finite element analysis code
4 // for structural analysis and design.
5 //
6 // Copyright (C) Luis C. 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 // CFactorSeries.h
29 
30 #ifndef CFactorSeries_h
31 #define CFactorSeries_h
32 
33 #include <domain/load/pattern/TimeSeries.h>
34 
35 namespace XC {
37 //
40  {
41  protected:
42  double cFactor;
43 
44  DbTagData &getDbTagData(void) const;
45  int sendData(Communicator &comm);
46  int recvData(const Communicator &comm);
47 
48  public:
49  CFactorSeries(int classTag,double cf= 1.0);
50 
51  int sendSelf(Communicator &);
52  int recvSelf(const Communicator &);
53 
55  inline double getFactor(double pseudoTime) const
56  { return cFactor; }
58  void setFactor(const double &d)
59  { cFactor= d; }
60  };
61 } // end of XC namespace
62 
63 #endif
int recvData(const Communicator &comm)
Receives object members through the communicator argument.
Definition: CFactorSeries.cc:89
int recvSelf(const Communicator &)
Receives object through the communicator argument.
Definition: CFactorSeries.cc:107
Communication parameters between processes.
Definition: Communicator.h:66
double getFactor(double pseudoTime) const
Return load factor at specified time.
Definition: CFactorSeries.h:55
CFactorSeries(int classTag, double cf=1.0)
Constructor.
Definition: CFactorSeries.cc:73
Vector that stores the dbTags of the class members.
Definition: DbTagData.h:44
DbTagData & getDbTagData(void) const
Returns a vector to store the dbTags of the class members.
Definition: CFactorSeries.cc:78
void setFactor(const double &d)
Sets factor value.
Definition: CFactorSeries.h:58
Base class for constant factor time series.
Definition: CFactorSeries.h:39
Open source finite element program for structural analysis.
Definition: ContinuaReprComponent.h:35
Time variation of loads.
Definition: TimeSeries.h:85
int sendSelf(Communicator &)
Sends object through the communicator argument.
Definition: CFactorSeries.cc:93
int sendData(Communicator &comm)
Send object members through the communicator argument.
Definition: CFactorSeries.cc:85
double cFactor
factor that multiplies series values.
Definition: CFactorSeries.h:42