xc
PeriodSeries.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 // PeriodSeries.h
29 
30 #ifndef PeriodSeries_h
31 #define PeriodSeries_h
32 
33 #include "PulseBaseSeries.h"
34 
35 namespace XC {
37 //
40  {
41  protected:
42  double period;
43  double shift;
44 
45  int sendData(Communicator &comm);
46  int recvData(const Communicator &comm);
47 
48  public:
49  // constructors
50  PeriodSeries(int classTag,double tStart,double tFinish,double period,double shift,double cFactor = 1.0);
51  PeriodSeries(int classTag);
52 
53  inline double getPeriod(void) const
54  { return period; }
55  inline void setPeriod(const double &d)
56  { period= d; }
57  inline double getShift(void) const
58  { return shift; }
59  inline void setShift(const double &d)
60  { shift= d; }
61 
62  void Print(std::ostream &s, int flag =0) const;
63 
64  };
65 } // end of XC namespace
66 
67 #endif
double period
period of pulse series (sec)
Definition: PeriodSeries.h:42
int recvData(const Communicator &comm)
Receives object members through the communicator argument.
Definition: PeriodSeries.cc:92
Communication parameters between processes.
Definition: Communicator.h:66
double shift
phase shift of pulse series (sec)
Definition: PeriodSeries.h:43
int sendData(Communicator &comm)
Send object members through the communicator argument.
Definition: PeriodSeries.cc:84
Periodic function over time.
Definition: PeriodSeries.h:39
void Print(std::ostream &s, int flag=0) const
Print stuff.
Definition: PeriodSeries.cc:100
Base class for pulse type time series.
Definition: PulseBaseSeries.h:39
PeriodSeries(int classTag, double tStart, double tFinish, double period, double shift, double cFactor=1.0)
Constructor.
Definition: PeriodSeries.cc:68
Open source finite element program for structural analysis.
Definition: ContinuaReprComponent.h:35
double cFactor
factor that multiplies series values.
Definition: CFactorSeries.h:42