Time-dependent function that linear interpolates the load factor using user specified control points provided in a vector object. More...

#include <PathSeries.h>

Inheritance diagram for XC::PathSeries:

Public Member Functions
	PathSeries (const Vector &thePath, double pathTimeIncr=1.0, double cf=1.0)
	Constructor. More...

	PathSeries (const std::string &fileName, double pathTimeIncr=1.0, double cf=1.0)
	Constructor. More...

	PathSeries (void)
	Default constructor.

TimeSeries *	getCopy (void) const
	Virtual constructor.

double	getFactor (double pseudoTime) const
	Returns the value of the factor at the pseudo-time. More...

double	getDuration (void) const
	Returns series duration.

void	setTimeIncr (const double &d)

double	getTimeIncr (double) const

void	readFromFile (const std::string &fileName)
	Lee el path desde archivo.

int	sendSelf (CommParameters &)
	Sends object through the channel being passed as parameter.

int	recvSelf (const CommParameters &)
	Receives object through the channel being passed as parameter.

void	Print (std::ostream &s, int flag=0) const
	Print stuff.

Public Member Functions inherited from XC::PathSeriesBase
	PathSeriesBase (int classTag, const double &cf=1.0)
	Constructor.

	PathSeriesBase (int classTag, const Vector &thePath, const double &cf=1.0)
	Constructor.

size_t	getNumDataPoints (void) const
	Return the number of points that define the path.

size_t	getNumDataPointsOnFile (const std::string &) const
	Return the number of data en on the file with the name being passed as parameter.

double	getPeakFactor (void) const
	Return the peak value of the factor.

Vector	getPath (void) const

void	setPath (const Vector &d)

int	getLastSendCommitTag (void) const

void	setLastSendCommitTag (const int &d)

void	Print (std::ostream &s, int flag=0) const
	Printing stuff.

Public Member Functions inherited from XC::CFactorSeries
	CFactorSeries (int classTag, double cf=1.0)
	Constructor. More...

void	setFactor (const double &d)
	Sets factor value.

Public Member Functions inherited from XC::TimeSeries
	TimeSeries (int classTag)
	Constructor. More...

virtual int	setParameter (const std::vector< std::string > &argv, Parameter &param)
	Sets the value `param` to the parameter `argv`.

virtual int	updateParameter (int parameterID, Information &info)
	Updates the parameter identified by `parameterID` with `info`.

virtual int	activateParameter (int parameterID)
	Activates the parameter identified by `parameterID`.

virtual double	getFactorSensitivity (double pseudoTime)

Public Member Functions inherited from XC::MovableObject
	MovableObject (int classTag, int dbTag)
	Constructor. More...

	MovableObject (int classTag)
	Constructor. More...

	MovableObject (const MovableObject &)
	Copy constructor. Doesn't copy the dbTag.

MovableObject &	operator= (const MovableObject &)
	Assignment operator. Doesn't copy the dbTag.

int	getClassTag (void) const
	Return the class identifier.

int	getDbTag (void) const
	Return the object identifier in the database.

int	getDbTag (CommParameters &)
	Return the object identifier in the database.

void	setDbTag (int dbTag)
	Sets the object identifier in the database.

void	setDbTag (CommParameters &)
	Sets the object identifier in the database if not already set. More...

virtual int	setVariable (const std::string &variable, Information &)
	Set the value of the variable idenfified by `var`.

virtual int	getVariable (const std::string &variable, Information &)
	Return the value of the variable idenfified by `var`.

Public Member Functions inherited from XC::DistributedBase
	DistributedBase (void)
	Constructor.

const int &	getDbTagDataPos (const int &i) const
	Returns the data at the i-th position.

void	setDbTagDataPos (const int &i, const int &v)
	Sets the data at the i-th position.

void	inicComm (const int &dataSize) const
	Initializes communication.

Protected Member Functions
int	sendData (CommParameters &cp)
	Sends object data.

int	recvData (const CommParameters &cp)
	Receives object data.

Protected Member Functions inherited from XC::PathSeriesBase
int	sendData (CommParameters &cp)
	Send members through the channel being passed as parameter.

int	recvData (const CommParameters &cp)
	Receives members through the channel being passed as parameter.

Protected Member Functions inherited from XC::CFactorSeries
DbTagData &	getDbTagData (void) const
	Returns a vector to store the dbTags of the class members. More...

int	sendData (CommParameters &cp)
	Send object members through the channel being passed as parameter.

int	recvData (const CommParameters &cp)
	Receives object members through the channel being passed as parameter.

Additional Inherited Members
Static Protected Member Functions inherited from XC::PathSeriesBase
static size_t	load_vector_from_file (Vector &v, std::istream &is)
	Lee desde archivo.

Protected Attributes inherited from XC::PathSeriesBase
Vector	thePath
	vector containg the data points

int	lastSendCommitTag

Protected Attributes inherited from XC::CFactorSeries
double	cFactor
	factor that multiplies series values.

Detailed Description

Time-dependent function that linear interpolates the load factor using user specified control points provided in a vector object.

the points in the vector are given at regular time increments pathTimeIncr apart.

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 \(0.0\) will be returned.

Constructor & Destructor Documentation

§ PathSeries() [1/2]

XC::PathSeries::PathSeries	(	const Vector &	theLoadPath,
		double	theTimeIncr = `1.0`,
		double	theFactor = `1.0`
	)

Constructor.

Used to construct a PathSeries when the data points are specified in a Vector.

Parameters

theLoadPath	vector containing the data points which are specified at `theTimeIncr` time intervals.
theTimeIncr	time step.
theFactor	constant factor used in the relation.

§ PathSeries() [2/2]

XC::PathSeries::PathSeries	(	const std::string &	fileName,
		double	theTimeIncr = `1.0`,
		double	theFactor = `1.0`
	)

Constructor.

Used to construct a PathSeries when the data points are specified in a file.

Parameters

fileName	name of the file containing the data points. specified at `theTimeIncr` time intervals.
theTimeIncr	time step.
theFactor	constant factor used in the relation.

Member Function Documentation

§ getFactor()

double XC::PathSeries::getFactor ( double pseudoTime ) const

virtual

Returns the value of the factor at the pseudo-time.

Determines the load factor based on the pseudoTime and the data points. Returns \(0.0\) 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 XC::CFactorSeries.

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

src/domain/load/pattern/time_series/PathSeries.h
src/domain/load/pattern/time_series/PathSeries.cpp

Public Member Functions