xc
|
Time-dependent function that linear interpolates the load factor using user specified control points provided in a vector object. More...
#include <PathSeries.h>
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) |
Read path from file. | |
int | sendSelf (Communicator &) |
Sends object through the communicator argument. | |
int | recvSelf (const Communicator &) |
Receives object through the communicator argument. | |
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... | |
const MapLoadPatterns * | getMapLoadPatterns (void) const |
Returns a pointer to the container of the time series. | |
const std::string & | getName (void) const |
Returns the name of this load pattern. | |
virtual int | setParameter (const std::vector< std::string > &argv, Parameter ¶m) |
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 (Communicator &) |
Return the object identifier in the database. | |
void | setDbTag (int dbTag) |
Sets the object identifier in the database. | |
void | setDbTag (Communicator &) |
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. | |
virtual | ~DistributedBase (void) |
Destructor. | |
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. | |
Public Member Functions inherited from CommandEntity | |
CommandEntity (CommandEntity *owr=nullptr) | |
Default constructor. | |
CommandEntity * | Owner (void) |
Return a pointer to the object owner. | |
const CommandEntity * | Owner (void) const |
Return un puntero al objeto propietario de ESTE. | |
const StandardOutputWrapper & | getStandardOutputWrapper (void) const |
Return the regular output stream wrapper. | |
StandardOutputWrapper & | getStandardOutputWrapper (void) |
Return the regular output stream wrapper. | |
const std::string & | getLogFileName (void) const |
Returns log file name. | |
void | setLogFileName (const std::string &) |
Sets log file name. | |
const std::string & | getErrFileName (void) const |
Returns err file name. | |
void | setErrFileName (const std::string &) |
Sets error file name. | |
const std::string & | getOutputFileName (void) const |
Returns regular output file name. | |
void | setOutputFileName (const std::string &) |
Sets regular output file name. | |
boost::python::object | evalPy (boost::python::object dict, const std::string &) |
Return the Python object that results from evaluating the argument. | |
boost::python::object | execPy (boost::python::object dict, const std::string &) |
Return the Python objects that results from executing the code in the string argument. | |
boost::python::object | execFilePy (boost::python::object dict, const std::string &) |
Return the Python object that results from executing the code in the file. | |
Public Member Functions inherited from EntityWithProperties | |
EntityWithProperties (EntityWithProperties *owr=nullptr) | |
Default constructor. | |
virtual bool | operator== (const EntityWithProperties &) const |
Comparison operator. | |
void | clearPyProps (void) |
Clear python properties map. | |
bool | hasPyProp (const std::string &) |
Returns true if property exists. | |
boost::python::object | getPyProp (const std::string &str) |
Return the Python object with the name being passed as parameter. | |
void | setPyProp (std::string str, boost::python::object val) |
Sets/appends a value tho the Python object's dictionary. | |
void | copyPropsFrom (const EntityWithProperties &) |
Copy the properties from the argument. | |
boost::python::list | getPropNames (void) const |
Return the names of the object properties weightings. | |
const PythonDict & | getPropertiesDict (void) const |
Return a std::map container with the properties of the object. | |
boost::python::dict | getPyDict (void) const |
Return a Python dictionary containing the object members values. | |
void | setPyDict (const boost::python::dict &) |
Set the values of the object members from a Python dictionary. | |
Public Member Functions inherited from EntityWithOwner | |
EntityWithOwner (EntityWithOwner *owr=nullptr) | |
Default constructor. | |
EntityWithOwner (const EntityWithOwner &) | |
Copy constructor. | |
EntityWithOwner & | operator= (const EntityWithOwner &) |
Assignment operator. | |
virtual bool | operator== (const EntityWithOwner &) const |
Comparison operator. | |
virtual | ~EntityWithOwner (void) |
Virtual destructor. | |
virtual std::string | getClassName (void) const |
Returns demangled class name. | |
void | set_owner (EntityWithOwner *owr) |
Assigns the owner of the object. | |
EntityWithOwner * | Owner (void) |
const EntityWithOwner * | Owner (void) const |
Protected Member Functions | |
int | sendData (Communicator &comm) |
Sends object data. | |
int | recvData (const Communicator &comm) |
Receives object data. | |
Protected Member Functions inherited from XC::PathSeriesBase | |
int | sendData (Communicator &comm) |
Send members through the communicator argument. | |
int | recvData (const Communicator &comm) |
Receives members through the communicator argument. | |
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 (Communicator &comm) |
Send object members through the communicator argument. | |
int | recvData (const Communicator &comm) |
Receives object members through the communicator argument. | |
Protected Member Functions inherited from CommandEntity | |
template<class T > | |
void | string_to (T &, const std::string &) const |
Additional Inherited Members | |
Public Types inherited from EntityWithProperties | |
typedef std::map< std::string, boost::python::object > | PythonDict |
Static Public Member Functions inherited from CommandEntity | |
static void | resetStandardOutput (void) |
Reset the standard output streams to its defaults buffers. | |
Static Public Member Functions inherited from EntityWithOwner | |
static int | getVerbosityLevel (void) |
Get the value of the verbosity level. | |
static void | setVerbosityLevel (const int &) |
Set the value of the verbosity level. | |
Static Protected Member Functions inherited from XC::PathSeriesBase | |
static size_t | load_vector_from_file (Vector &v, std::istream &is) |
Read load vector from file. | |
Static Protected Member Functions inherited from CommandEntity | |
static CommandEntity * | entcmd_cast (boost::any &data) |
Protected Attributes inherited from XC::PathSeriesBase | |
Vector | thePath |
vector containing the data points | |
int | lastSendCommitTag |
Protected Attributes inherited from XC::CFactorSeries | |
double | cFactor |
factor that multiplies series values. | |
Static Protected Attributes inherited from EntityWithOwner | |
static int | verbosity = 1 |
Object that owns THIS ONE. More... | |
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.
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.
theLoadPath | vector containing the data points which are specified at theTimeIncr time intervals. |
theTimeIncr | time step. |
theFactor | constant factor used in the relation. |
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.
fileName | name of the file containing the data points. specified at theTimeIncr time intervals. |
theTimeIncr | time step. |
theFactor | constant factor used in the relation. |
|
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.