XC::EyBasic Class Reference

Lateral reaction of soil. More...

#include <EyBasic.h>

Inheritance diagram for XC::EyBasic:

Collaboration diagram for XC::EyBasic:

Public Member Functions
	EyBasic (int tag=0)
	Constructor.
	EyBasic (int tag, double E, double eyp, double eyn, double ezero)
	Constructor. More...
UniaxialMaterial *	getCopy (void) const
	Virtual constructor.
int	setTrialStrain (double strain, double strainRate=0.0)
	Sets trial strain.
int	commitState (void)
	Commit material state.
void	set_fyp (const double &)
	Sets the less negative yield stress value (tension).
void	set_fyn (const double &)
	Set the yield stress a compression value.
double	getLowerYieldStress (void)
void	setLowerYieldStress (const double &d)
double	getUpperYieldStress (void)
void	setUpperYieldStress (const double &d)
void	setParameters (const double &, const double &, const double &)
	Set the values of the parameters that define the material response.
Public Member Functions inherited from XC::ElasticPPMaterialBase
	ElasticPPMaterialBase (int tag, int classTag, double E, double eyp)
	Constructor. More...
	ElasticPPMaterialBase (int tag, int classTag, double E, double eyp, double eyn, double ezero)
	Constructor. More...
	ElasticPPMaterialBase (int tag, int classTag)
	Constructor.
void	set_eyp (const double &)
	Sets the positive yield strain value (tension).
void	set_eyn (const double &)
	Asigna el yield stress a compression value.
double	get_fyp (void) const
double	get_eyp (void) const
double	get_fyn (void) const
double	get_eyn (void) const
virtual double	getEnergy (void)
int	revertToLastCommit (void)
	Returns the material state to its last commit.
int	revertToStart (void)
	Returns the material to its initial state.
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::EPPBaseMaterial
	EPPBaseMaterial (int tag, int classtag, double E=0.0, double e0=0.0)
	Constructor. More...
double	getStress (void) const
	Return the current value of stress.
double	getTangent (void) const
	Return the current value of the tangent for the trial strain.
void	setTangent (const double &)
	Set the value of the material tangent modulus.
int	revertToLastCommit (void)
	Revert to the last commited state.
int	revertToStart (void)
	Returns the material to its initial state.
Public Member Functions inherited from XC::ElasticBaseMaterial
	ElasticBaseMaterial (int tag=0, int classtag=0, double E=0.0, double e0=0.0)
	Constructor.
double	getE (void) const
void	setE (const double &e)
int	setInitialStrain (const double &)
	Sets initial stress.
int	incrementInitialStrain (const double &)
	Increments the initial strain.
void	zeroInitialStrain (void)
	Zeroes the initial strain.
double	getStrain (void) const
double	getInitialStrain (void) const
	Return the initial strain.
double	getInitialTangent (void) const
Public Member Functions inherited from XC::UniaxialMaterial
	UniaxialMaterial (int tag, int classTag)
	Constructor. More...
virtual UniaxialMaterial *	getCopy (SectionForceDeformation *s) const
	Virtual constructor.
virtual int	setTrial (double strain, double &stress, double &tangent, double strainRate=0.0)
virtual double	getStrainRate (void) const
	default operation for strain rate is zero
const Vector &	getGeneralizedStress (void) const
	Return the generalized stress.
const Vector &	getGeneralizedStrain (void) const
	Return the generalized strain.
virtual void	setInitialGeneralizedStrain (const Vector &)
	Sets the initial generalized strain to the value being passed as parameter.
const Vector &	getInitialGeneralizedStrain (void) const
	Return the generalized initial strain.
virtual double	getDampTangent (void) const
	default operation for damping tangent is zero
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 Response *	setResponse (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 MaterialHandler *	getMaterialHandler (void) const
	Returns (if possible) a pointer to the material handler (owner).
MaterialHandler *	getMaterialHandler (void)
	Returns a pointer to the material handler (if possible).
const Domain *	getDomain (void) const
	Returns (if possible) a pointer to the material handler (owner).
Domain *	getDomain (void)
	Returns a pointer to the material handler (if possible).
std::string	getName (void) const
	Returns the name of the material.
const Material *	getMaterialByName (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
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 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.
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.
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.
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
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.
virtual DbTagData &	getDbTagData (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.

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.
Protected Member Functions inherited from XC::ElasticPPMaterialBase
double	yield_function (const double &sigtrial) const
	Computes yield function value.
double	get_total_strain (void)
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::EPPBaseMaterial
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::ElasticBaseMaterial
int	sendData (Communicator &)
	Send object members through the communicator argument.
int	recvData (const Communicator &)
	Receives object members through the communicator argument.
virtual double	get_total_strain (void) const
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::Material
bool	isEqual (const Material &) const
	Return true if both objects are equal.
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.
Static Protected Member Functions inherited from CommandEntity
static CommandEntity *	entcmd_cast (boost::any &data)
Protected Attributes inherited from XC::ElasticPPMaterialBase
double	fyp
double	fyn
	positive and negative yield stress
double	ep
	plastic strain at last commit
double	commitStress
	last committed stress
double	EnergyP
	Energy stored in the material by SAJalali.
Protected Attributes inherited from XC::EPPBaseMaterial
double	commitStrain
	plastic strain at last commit
double	trialStress
	current trial stress
double	trialTangent
	current trial tangent
Protected Attributes inherited from XC::ElasticBaseMaterial
double	trialStrain
	Material trial strain.
double	E
	Elastic modulus.
Static Protected Attributes inherited from EntityWithOwner
static int	verbosity = 1
	Object that owns THIS ONE. More...

Detailed Description

Lateral reaction of soil.

This class provides the abstraction of an elastic perfectly plastic uniaxial material, addapted for its use to model the lateral reaction of soil.

Constructor & Destructor Documentation

EyBasic()

XC::EyBasic::EyBasic	(	int	tag,
		double	e,
		double	eyp,
		double	eyn,
		double	ez
	)

Constructor.

Parameters

[in]	tag	material identifier.
[in]	e	material elastic modulus.
[in]	eyp	upper yield strain value (decompression).
[in]	eyn	lower yield strain value (compression).
[in]	ez	initial strain.

---

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

• src/material/uniaxial/soil_structure_interaction/EyBasic.h
• src/material/uniaxial/soil_structure_interaction/EyBasic.cc