xc
Public Member Functions | Protected Member Functions | List of all members
XC::QzSimple1 Class Reference

Simple uniaxial q-z material for use with a zeroLength element. More...

#include <QzSimple1.h>

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

Public Member Functions

 QzSimple1 (int tag, int qzType, double Qult, double z50, double suction, double dashpot)
 
 QzSimple1 (int tag, int classtag=MAT_TAG_QzSimple1)
 Constructor.
 
 QzSimple1 (void)
 Default constructor.
 
void set_suction (const double &)
 Set the suction parameter (Uplift resistance is equal to suction*qult). More...
 
double get_suction (void) const
 Return the suction parameter (Uplift resistance is equal to suction*qult)
 
int setTrialStrain (double z, double zRate)
 Sets the value of the trial strain. More...
 
double getStress (void) const
 Return the current value of stress.
 
double getDampTangent (void) const
 default operation for damping tangent is zero
 
int commitState (void)
 
int revertToLastCommit (void)
 
int revertToStart (void)
 
UniaxialMaterialgetCopy (void) const
 Virtual constructor.
 
int sendSelf (Communicator &)
 Send the object. More...
 
int recvSelf (const Communicator &)
 Receive the object. More...
 
void Print (std::ostream &s, int flag=0) const
 Print stuff.
 
- Public Member Functions inherited from XC::PQyzBase
 PQyzBase (int tag, int classtag, int soilType, double rult, double v50, double dashpot)
 Constructor with data.
 
 PQyzBase (int tag, int classtag)
 Constructor.
 
 PQyzBase (void)
 Default constructor.
 
- Public Member Functions inherited from XC::PYBase
 PYBase (int tag, int classtag, int soilType, double mCap, double v50, double dashpot)
 Constructor with data.
 
 PYBase (int tag, int classtag)
 Default constructor.
 
 PYBase (void)
 Default constructor.
 
double getTangent (void) const
 Return the material tangent stiffness.
 
double getInitialTangent (void) const
 Return the material initial stiffness.
 
void setInitialTangent (const double &)
 Set initial stiffness.
 
double getStrain (void) const
 
double getStrainRate (void) const
 default operation for strain rate is zero
 
void setSoilType (const int &)
 Sets the soil type to represent: soilType= 1 Backbone of p-y curve approximates Matlock (1970) soft clay relation. More...
 
int getSoilType (void) const
 Gets the soil type to represent: soilType= 1 Backbone of p-y curve approximates Matlock (1970) soft clay relation. More...
 
void setUltimateCapacity (const double &)
 Set the ultimate capacity of the p-y material. More...
 
double getUltimateCapacity (void) const
 Get the ultimate capacity of the p-y material. More...
 
void setY50 (const double &)
 Set the displacement at which 50% of pult is mobilized in monotonic loading. More...
 
double getY50 (void) const
 Get the displacement at which 50% of pult is mobilized in monotonic loading. More...
 
void setDashPot (const double &)
 Set the viscous damping term (dashpot) on the far-field (elastic) component of the displacement rate (velocity). More...
 
double getDashPot (void) const
 Get the viscous damping term (dashpot) on the far-field (elastic) component of the displacement rate (velocity). More...
 
- Public Member Functions inherited from XC::UniaxialMaterial
 UniaxialMaterial (int tag, int classTag)
 Constructor. More...
 
virtual UniaxialMaterialgetCopy (SectionForceDeformation *s) const
 Virtual constructor.
 
virtual int setInitialStrain (const double &)
 Sets the initial strain value. More...
 
virtual int incrementInitialStrain (const double &)
 Increments the initial strain. More...
 
virtual void zeroInitialStrain (void)
 Zeroes the initial strain.
 
virtual int setTrial (double strain, double &stress, double &tangent, double strainRate=0.0)
 
virtual double getInitialStrain (void) const
 Return the initial strain.
 
const VectorgetGeneralizedStress (void) const
 Return the generalized stress.
 
const VectorgetGeneralizedStrain (void) const
 Return the generalized strain.
 
virtual void setInitialGeneralizedStrain (const Vector &)
 Sets the initial generalized strain to the value being passed as parameter.
 
const VectorgetInitialGeneralizedStrain (void) const
 Return the generalized initial strain.
 
virtual double getSecant (void) const
 Return secant secant stiffness of the material.
 
virtual double getFlexibility (void) const
 Return the inverse of stiffness matrix.
 
virtual double getInitialFlexibility (void) const
 Return the inverse of stiffness matrix inicial.
 
virtual double getRho (void) const
 Return the material density.
 
void setRho (const double &)
 Assigns la material density.
 
int revertToStart (void)
 Revert the material to its initial state.
 
virtual ResponsesetResponse (const std::vector< std::string > &argv, Information &matInformation)
 
virtual int getResponse (int responseID, Information &matInformation)
 Returns material response.
 
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 getStressSensitivity (int gradIndex, bool conditional)
 
virtual double getStrainSensitivity (int gradIndex)
 
virtual double getTangentSensitivity (int gradIndex)
 
virtual double getInitialTangentSensitivity (int gradIndex)
 
virtual double getDampTangentSensitivity (int gradIndex)
 
virtual double getRhoSensitivity (int gradIndex)
 
virtual int commitSensitivity (double strainGradient, int gradIndex, int numGrads)
 
virtual double getEnergy (void) const
 Return the energy stored in the material.
 
- Public Member Functions inherited from XC::Material
 Material (int tag, int classTag)
 Constructor. More...
 
const MaterialHandlergetMaterialHandler (void) const
 Returns (if possible) a pointer to the material handler (owner).
 
MaterialHandlergetMaterialHandler (void)
 Returns a pointer to the material handler (if possible).
 
const DomaingetDomain (void) const
 Returns (if possible) a pointer to the material handler (owner).
 
DomaingetDomain (void)
 Returns a pointer to the material handler (if possible).
 
std::string getName (void) const
 Returns the name of the material.
 
const MaterialgetMaterialByName (const std::string &) const
 
virtual int setVariable (const std::string &argv)
 
virtual int getVariable (int variableID, double &info)
 
virtual Matrix getValues (const std::string &, bool silent=false) const
 Returns material response. More...
 
virtual void update (void)
 Update state variables for the material according to the new values of the parameters. More...
 
virtual void incrementInitialGeneralizedStrain (const Vector &)
 Increments generalized strain. More...
 
virtual void zeroInitialGeneralizedStrain (void)
 zeroes initial generalized strain
 
- Public Member Functions inherited from XC::TaggedObject
 TaggedObject (int tag, CommandEntity *owr=nullptr)
 Constructor. More...
 
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.
 
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.
 
- 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 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.
 
virtual DbTagDatagetDbTagData (void) const
 Returns a vector to store class dbTags.
 
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 (Communicator &)
 Send object members through the communicator argument.
 
int recvData (const Communicator &)
 Receives object members through the communicator argument.
 
- Protected Member Functions inherited from XC::PQyzBase
int sendData (Communicator &)
 Send object members through the communicator argument.
 
int recvData (const Communicator &)
 Receives object members through the communicator argument.
 
- Protected Member Functions inherited from XC::PYBase
void getFarField (const double &y)
 
int sendData (Communicator &)
 Send object members through the communicator argument.
 
int recvData (const Communicator &)
 Receives object members through the communicator argument.
 
- Protected Member Functions inherited from XC::UniaxialMaterial
int sendData (Communicator &)
 Send object members through the communicator argument.
 
int recvData (const Communicator &)
 Receives object members through the communicator argument.
 
- Protected Member Functions inherited from XC::TaggedObject
void setTag (int newTag)
 Set tag. More...
 
- 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 CommandEntity
static CommandEntityentcmd_cast (boost::any &data)
 
- Protected Attributes inherited from XC::PQyzBase
double NFkrig
 stiffness of the "rigid" portion of Near Field spring
 
InternalParamsLRIn CNF
 Committed internal parameters for the NearField rigid-plastic component.
 
InternalParamsLRIn TNF
 Trial internal parameters for the NearField rigid-plastic component.
 
InternalParamsA CGap
 Committed internal parameters for the Gap (Drag + Closure)
 
InternalParamsA TGap
 Trial internal parameters for the Gap (Drag + Closure)
 
double Elast
 (p/matCapacity) when yielding first occurs in virgin loading
 
double nd
 exponent for hardening shape of drag component
 
- Protected Attributes inherited from XC::PYBase
InternalParamsA C
 Committed history variables for entire Q-z material.
 
InternalParamsA T
 Trial history variables for entire p-y material.
 
double TvRate
 Trial velocity.
 
InternalParamsA CFar
 Committed internal parameters for the Far Field component.
 
InternalParamsA TFar
 Trial internal parameters for the Far Field component.
 
double initialTangent
 
int soilType
 Soil type.
 
double matCapacity
 Material capacity.
 
double v50
 y (or z) at 50% of matCapacity.
 
double vRef
 (y or z) reference point for Near Field component
 
double np
 exponent for hardening shape of Near Field component
 
double dashpot
 dashpot on the far-field (elastic) component
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

Simple uniaxial q-z material for use with a zeroLength element.

Member Function Documentation

◆ recvSelf()

int XC::QzSimple1::recvSelf ( const Communicator comm)
virtual

Receive the object.

Each object has to receive the data needed to be able to recreate itself in the new process after it has been sent through cp. If the object is an aggregation containing other objects, new objects of the correct type can be constructed using #theBroker. To return 0 if successful or a -1 if not.

Implements XC::MovableObject.

◆ sendSelf()

int XC::QzSimple1::sendSelf ( Communicator comm)
virtual

Send the object.

Each object has to send the data needed to be able to reproduce that object in a remote process. The object uses the methods provided by cp object to send the data to another channel at the remote actor, the address of the channel is set before this method is called. An object of similar type at the remote actor is invoked with a receiveSelf() to receive the data. Returns 0 if successful (successful in that the data got to the channel), or a - if no data was sent.

Implements XC::MovableObject.

◆ set_suction()

void XC::QzSimple1::set_suction ( const double &  s)

Set the suction parameter (Uplift resistance is equal to suction*qult).

The value of suction must be 0.0 to 0.1.

◆ setTrialStrain()

int XC::QzSimple1::setTrialStrain ( double  strain,
double  strainRate 
)
virtual

Sets the value of the trial strain.

Sets the value of the trial strain return 0 if successful, a negative number if not.

Implements XC::UniaxialMaterial.


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