Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

PathSeries Class Reference

#include <PathSeries.h>

Inheritance diagram for PathSeries::

TimeSeries MovableObject List of all members.

Public Methods

 PathSeries (const Vector &thePath, double pathTimeIncr=1.0, double cfactor=1.0)
 constructors. More...

 PathSeries (char *fileName, double pathTimeIncr=1.0, double cfactor=1.0)
 PathSeries ()
 ~PathSeries ()
 destructor. More...

double getFactor (double pseudoTime)
 method to get factor. More...

double getDuration ()
double getPeakFactor ()
double getTimeIncr (double pseudoTime)
int sendSelf (int commitTag, Channel &theChannel)
 methods for output. More...

int recvSelf (int commitTag, Channel &theChannel, FEM_ObjectBroker &theBroker)
void Print (ostream &s, int flag=0)

Detailed Description

The PathSeries class is a concrete subclass of TimeSeries. The relationship between the pseudo time and the load factor follows a user specified path. The path points are specified at constant time intervals. For a pseudo time not at a path point, linear interpolation is performed to determine the load factor. If the time specified is beyond the last path point a load factor of will be returned.\

}

Definition at line 59 of file PathSeries.h.

Constructor & Destructor Documentation

PathSeries::PathSeries ( const Vector & thePath,
double pathTimeIncr = 1.0,
double cfactor = 1.0 )
 

constructors.

Definition at line 56 of file PathSeries.cpp.

PathSeries::PathSeries ( char * fileName,
double pathTimeIncr = 1.0,
double cfactor = 1.0 )
 

Used to construct a PathSeries when the data points are specified in a Vector. The tag TSERIES\_TAG\_PathSeries is passed to the TimeSeries The tag TSERIES\_TAG\_PathSeries is passed to the TimeSeries constructor. Sets the constant factor used in the relation to {cFactor}. Constructs a new Vector equal to {thePath} containing the data points which are specified at {dT} time intervals. Prints a warning message if no space is available for the Vector.

Definition at line 76 of file PathSeries.cpp.

PathSeries::PathSeries ( )
 

Used to construct a PathSeries when the data points are specified in a file. The tag TSERIES\_TAG\_PathSeries is passed to the TimeSeries constructor. Sets the constant factor used in the relation to {cFactor}. Opens the file containing and reads in the data points into a new Vector which are specified at {dT} time intervals. Prints a warning message if no space is available for the Vector or if the file could not be found.

Definition at line 48 of file PathSeries.cpp.

PathSeries::~PathSeries ( )
 

destructor.

Definition at line 137 of file PathSeries.cpp.

Member Function Documentation

void PathSeries::Print ( ostream & s,
int flag = 0 ) [virtual]
 

Prints the string 'PathSeries', the factor{cFactor}, and the time increment {dT}. If {flag} is equal to the load path Vector is also printed.

Reimplemented from TimeSeries.

Definition at line 275 of file PathSeries.cpp.

double PathSeries::getDuration ( ) [virtual]
 

For a FEM\_ObjectBroker to instantiate an empty PathSeries, recvSelf() must be invoked on this object. The tag TSERIES\_TAG\_PathSeries is passed to the TimeSeries constructor.

Reimplemented from TimeSeries.

Definition at line 166 of file PathSeries.cpp.

double PathSeries::getFactor ( double pseudoTime ) [virtual]
 

method to get factor.

Reimplemented from TimeSeries.

Definition at line 144 of file PathSeries.cpp.

double PathSeries::getPeakFactor ( ) [virtual]
 

Invokes the destructor on the Vector created to hold the data points.

Reimplemented from TimeSeries.

Definition at line 177 of file PathSeries.cpp.

double PathSeries::getTimeIncr ( double pseudoTime ) [inline, virtual]
 

Determines the load factor based on the {pseudoTime} and the data points. Returns if {pseudoTime} is greater than time of last data point, otherwise returns a linear interpolation of the data points times the factor {cFactor}.

Reimplemented from TimeSeries.

Definition at line 115 of file PathSeries.h.

int PathSeries::recvSelf ( int commitTag,
Channel & theChannel,
FEM_ObjectBroker & theBroker ) [virtual]
 

Does the mirror image of {sendSelf()}.

Reimplemented from MovableObject.

Definition at line 235 of file PathSeries.cpp.

int PathSeries::sendSelf ( int commitTag,
Channel & theChannel ) [virtual]
 

methods for output.

Reimplemented from MovableObject.

Definition at line 200 of file PathSeries.cpp.

The documentation for this class was generated from the following files:
Copyright Contact Us