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

PathTimeSeries Class Reference

#include <PathTimeSeries.h>

Inheritance diagram for PathTimeSeries::

TimeSeries MovableObject List of all members.

Public Methods

 PathTimeSeries (const Vector &thePath, const Vector &theTime, double cfactor=1.0)
 constructors. More...

 PathTimeSeries (char *fileNamePath, char *fileNameTime, double cfactor=1.0)
 PathTimeSeries (char *fileName, double cfactor=1.0)
 PathTimeSeries ()
 ~PathTimeSeries ()
 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 PathTimeSeries 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 user specified time values. 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 PathTimeSeries.h.


Constructor & Destructor Documentation

PathTimeSeries::PathTimeSeries ( const Vector & thePath,
const Vector & theTime,
double cfactor = 1.0 )
 

constructors.

Definition at line 56 of file PathTimeSeries.cpp.

PathTimeSeries::PathTimeSeries ( char * fileNamePath,
char * fileNameTime,
double cfactor = 1.0 )
 

Used to construct a PathTimeSeries when the data points and time values are specified in a Vectors. The tag TSERIES\_TAG\_PathTimeSeries is passed to the TimeSeries constructor. Sets the constant factor used in the relation to {cFactor}. Constructs two new Vectors equal to {thePath} and {time}. Prints a warning message if no space is available for the Vectors or if the two Vectors are not of the same size.

Definition at line 90 of file PathTimeSeries.cpp.

PathTimeSeries::PathTimeSeries ( char * fileName,
double cfactor = 1.0 )
 

Used to construct a PathTimeSeries when the data points and time values are specified in files. The tag TSERIES\_TAG\_PathTimeSeries is passed to the TimeSeries constructor. Sets the constant factor used in the relation to {cFactor}. Opens the two files and counts the number of entries in each, if different prints a warning message and returns. Constructs the two vectors for the data and reads the data from the files into the two vectors. Prints a warning message if no space is available for the Vectors.

Definition at line 194 of file PathTimeSeries.cpp.

PathTimeSeries::PathTimeSeries ( )
 

Definition at line 47 of file PathTimeSeries.cpp.

PathTimeSeries::~PathTimeSeries ( )
 

destructor.

Definition at line 265 of file PathTimeSeries.cpp.


Member Function Documentation

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

Prints the string 'PathTimeSeries', the factor{cFactor}, and the time increment {dT}. If {flag} is equal to {thePath} and {time} Vector are also printed

Reimplemented from TimeSeries.

Definition at line 468 of file PathTimeSeries.cpp.

double PathTimeSeries::getDuration ( ) [virtual]
 

{\bf Destructor}

Reimplemented from TimeSeries.

Definition at line 334 of file PathTimeSeries.cpp.

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

method to get factor.

Reimplemented from TimeSeries.

Definition at line 281 of file PathTimeSeries.cpp.

double PathTimeSeries::getPeakFactor ( ) [virtual]
 

Invokes the destructor on the two Vectors created to hold the data.

Reimplemented from TimeSeries.

Definition at line 347 of file PathTimeSeries.cpp.

double PathTimeSeries::getTimeIncr ( double pseudoTime ) [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 274 of file PathTimeSeries.cpp.

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

Does the mirror image of {sendSelf()}.

Reimplemented from MovableObject.

Definition at line 415 of file PathTimeSeries.cpp.

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

methods for output.

Reimplemented from MovableObject.

Definition at line 370 of file PathTimeSeries.cpp.


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