xc
Public Member Functions | Protected Member Functions | Friends | List of all members

Base class for load pattern combinations (1.5*selfWeight+1.0*permanentLoad+1.6*trafficLoad ...). More...

#include <LoadCombination.h>

Inheritance diagram for XC::LoadCombination:
Inheritance graph
[legend]
Collaboration diagram for XC::LoadCombination:
Collaboration graph
[legend]

Public Member Functions

const LoadCombinationGroupgetGroup (void) const
 Returns the group to which the combination belongs.
 
LoadCombinationGroupgetGroup (void)
 Returns the group to which the combination belongs.
 
LoadCombinationmultiplica (const float &)
 Multiplies the combination by the number being passed as parameter.
 
LoadCombinationdivide (const float &)
 Divides the combination by the number being passed as parameter.
 
LoadCombinationadd (const std::string &)
 Add the combination identified by the name being passed as parameter.
 
LoadCombinationsubtract (const std::string &)
 Subtracts the combination being passed as parameter.
 
LoadCombinationasigna (const std::string &)
 Assigns the combination identified by the name being passed as parameter.
 
LoadCombinationoperator+= (const LoadCombination &c)
 
LoadCombinationoperator-= (const LoadCombination &c)
 
LoadCombinationoperator*= (const float &f)
 
LoadCombinationoperator/= (const float &f)
 
LoadCombination operator+ (const LoadCombination &) const
 Addition operator.
 
LoadCombination operator- (const LoadCombination &) const
 Subtraction operator.
 
LoadCombination operator* (const float &) const
 Product by a number operator.
 
LoadCombination operator/ (const float &) const
 Division by a number operator.
 
bool operator== (const LoadCombination &) const
 Equal operator.
 
bool operator!= (const LoadCombination &) const
 Not equal operator.
 
bool dominaA (const LoadCombination &other) const
 Returns true if the factors that weight all the load patterns of this load combination are greater that those in the combination being passed as parameter. More...
 
const LoadCombinationgetPtrCombPrevia (void) const
 Returns, if possible, a pointer to the "previous" combination.
 
const std::string getNombreCombPrevia (void) const
 Returns, if possible, the name of the "previous" combination.
 
int getTagCombPrevia (void) const
 Returns, if possible, the tag of the "previous" combination.
 
const std::string getComponentsCombPrevia (void) const
 Returns, if possible, the decomposition of the "previous" combination.
 
const std::string getComponentsRestoSobrePrevia (void) const
 Returns, si puede, la diferencia entre esta y la previa.
 
int sendSelf (Communicator &)
 Sends object through the communicator argument.
 
int recvSelf (const Communicator &)
 Receives object through the communicator argument.
 
- Public Member Functions inherited from XC::LoadPatternCombination
 LoadPatternCombination (int tag=0, int classTag=LOAD_TAG_LoadPatternCombination, const std::string &nm="", LoadHandler *ll=nullptr)
 Constructor.
 
 ~LoadPatternCombination (void)
 Destructor.
 
void setHandler (LoadHandler *ll)
 
const std::string & getName (void) const
 
virtual void setDomain (Domain *theDomain)
 Assigns the domain to the combination load patterns.
 
bool addToDomain (void)
 Adds to the domain each of the load cases of the combination.
 
bool addToDomain (const std::set< std::string > &filter)
 Adds to the domain each the load cases whose name is included in the filter list. More...
 
bool addToDomain (boost::python::list &filter)
 Adds to the domain each the load cases whose name is included in the filter list. More...
 
bool isActive (void) const
 Return true if the combination is fully added to the domain. More...
 
void removeFromDomain (void)
 Removes from the domain being passed as parameter the load cases of the combination.
 
bool setDescomp (const std::string &descomp)
 
float getLoadPatternFactor (const LoadPattern *) const
 Returns the weighting factor for the load case being passed as parameter. More...
 
const_iterator begin (void) const
 
const_iterator end (void) const
 
size_t size (void) const
 
bool empty (void) const
 
std::string getString (const std::string &fmt="") const
 Returns a string that represents the load combination «1.35*G1+0.90*G1». More...
 
boost::python::dict getPyDict (void) const
 Return a Python dictionary with the object members values.
 
void setPyDict (const boost::python::dict &)
 Set the values of the object members from a Python dictionary.
 
virtual void Print (std::ostream &s, int flag=0) const
 Imprime.
 
- Public Member Functions inherited from XC::ForceReprComponent
 ForceReprComponent (int classTag)
 
 ForceReprComponent (int tag, int classTag)
 
- Public Member Functions inherited from XC::DomainComponent
 ~DomainComponent (void)
 Destructor.
 
size_t getIdx (void) const
 Returns the index of the object (to be used in VTK arrays).
 
virtual DomaingetDomain (void) const
 Returns a pointer to the enclosing domain. More...
 
const PreprocessorgetPreprocessor (void) const
 Returns (if possible) a pointer to the preprocessor.
 
PreprocessorgetPreprocessor (void)
 Return (if possible) a pointer to the preprocessor.
 
const LoadPatterngetCurrentLoadPattern (void) const
 Return the current load pattern.
 
LoadPatterngetCurrentLoadPattern (void)
 Return the current load pattern.
 
void set_index (const size_t &i)
 Set the index for the object (see numera in Set). More...
 
- Public Member Functions inherited from XC::TaggedObject
 TaggedObject (int tag, CommandEntity *owr=nullptr)
 Constructor. More...
 
virtual TaggedObjectgetCopy (void) const
 Virtual constructor.
 
void assignTag (int newTag)
 Set tag (to be called from Python interface).
 
int getTag (void) const
 Returns the tag associated with the object.
 
boost::python::dict getPyDict (void) const
 Return a Python dictionary with 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 CommandEntity
 CommandEntity (CommandEntity *owr=nullptr)
 Default constructor.
 
CommandEntityOwner (void)
 Return a pointer to the object owner.
 
const CommandEntityOwner (void) const
 Return un puntero al objeto propietario de ESTE.
 
const StandardOutputWrappergetStandardOutputWrapper (void) const
 Return the regular output stream wrapper.
 
StandardOutputWrappergetStandardOutputWrapper (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.
 
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.
 
- Public Member Functions inherited from EntityWithOwner
 EntityWithOwner (EntityWithOwner *owr=nullptr)
 Default constructor.
 
 EntityWithOwner (const EntityWithOwner &)
 Copy constructor.
 
EntityWithOwneroperator= (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.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (void) const
 
- 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.
 
MovableObjectoperator= (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 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 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.
 

Protected Member Functions

LoadCombinationadd (const LoadCombination &)
 Sums the combination being passed as parameter.
 
LoadCombinationsubtract (const LoadCombination &)
 Subtracts the combination being passed as parameter.
 
int recvDescomp (void)
 Returns the combination decomposition (it must be called only after setting un the object's owner and the pointer to the load handler -LoadHandler-). More...
 
 LoadCombination (LoadCombinationGroup *owr=nullptr, const std::string &nm="", int tag=0, LoadHandler *ll=nullptr)
 Constructor.
 
- Protected Member Functions inherited from XC::LoadPatternCombination
void set_gamma_f (TDescomp &)
 Assigns the weightings for each load case of the combination.
 
void set_domain (void)
 Assigns the domain to each domain.
 
void clear (void)
 Deletes the components of the load combination.
 
void add_component (const summand &)
 Adds a component to the combination.
 
bool interpreta_descomp (const std::string &str)
 Computes the combination from the string being passed as parameter. More...
 
void limpia_ceros (void)
 Deletes the null weighted load combinations.
 
const_iterator findLoadPattern (const LoadPattern *) const
 Returns a const iterator pointing to the load pattern being passed as parameter.
 
iterator findLoadPattern (const LoadPattern *)
 Returns an iterator pointing to the load pattern being passed as parameter.
 
DbTagDatagetDbTagData (void) const
 Returns a vector to store the dbTags de los miembros of the clase. More...
 
int sendData (Communicator &comm)
 Send members through the communicator argument.
 
int recvData (const Communicator &comm)
 Receives members through the communicator argument.
 
iterator begin (void)
 
iterator end (void)
 
void setNombre (const std::string &nm)
 
bool add_to_domain (TDescomp &)
 Adds to the domain the load patterns in the argument deque.
 
- Protected Member Functions inherited from XC::DomainComponent
 DomainComponent (int tag, int classTag)
 Constructor. More...
 
int sendData (Communicator &)
 Send object members through the communicator argument.
 
int recvData (const Communicator &)
 Receive object members through the communicator argument.
 
- Protected Member Functions inherited from XC::TaggedObject
void setTag (int newTag)
 Set tag. More...
 
bool isEqual (const TaggedObject &) const
 Return true if both objects are equal.
 
- Protected Member Functions inherited from CommandEntity
template<class T >
void string_to (T &, const std::string &) const
 
- Protected Member Functions inherited from EntityWithProperties
bool isEqual (const EntityWithProperties &) const
 Return true if both objects are equal.
 
- Protected Member Functions inherited from EntityWithOwner
virtual bool isEqual (const EntityWithOwner &) const
 Return true if both objects are equal.
 

Friends

class Domain
 
class FEM_ObjectBroker
 
class LoadCombinationGroup
 

Additional Inherited Members

- Public Types inherited from XC::LoadPatternCombination
typedef std::deque< summandTDescomp
 Container type for the combination expression (1.5*PP+1.0*CP+1.6*SC ...).
 
typedef TDescomp::iterator iterator
 
typedef TDescomp::const_iterator const_iterator
 
- 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 CommandEntity
static CommandEntityentcmd_cast (boost::any &data)
 
- Protected Attributes inherited from XC::LoadPatternCombination
std::string name
 
LoadHandlerhandler
 Pointer to the load case manager.
 
TDescomp descomp
 
- Static Protected Attributes inherited from XC::LoadPatternCombination
static std::map< int, std::string > map_str_descomp
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

Base class for load pattern combinations (1.5*selfWeight+1.0*permanentLoad+1.6*trafficLoad ...).

Member Function Documentation

◆ dominaA()

bool XC::LoadCombination::dominaA ( const LoadCombination other) const

Returns true if the factors that weight all the load patterns of this load combination are greater that those in the combination being passed as parameter.

◆ recvDescomp()

int XC::LoadCombination::recvDescomp ( void  )
protected

Returns the combination decomposition (it must be called only after setting un the object's owner and the pointer to the load handler -LoadHandler-).


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