XC::GenericSectionNd Class Reference

GenericSectionND provides a wrapper around a NDMaterial. More...

#include <GenericSectionNd.h>

Inheritance diagram for XC::GenericSectionNd:

Collaboration diagram for XC::GenericSectionNd:

Public Member Functions
	GenericSectionNd (int tag, const NDMaterial &m, const ResponseId &mCode)
	Constructor. More...
	GenericSectionNd (int tag=0)
	Constructor.
	GenericSectionNd (const GenericSectionNd &)
	Copy constructor.
GenericSectionNd &	operator= (const GenericSectionNd &)
	Assignment operator.
	~GenericSectionNd (void)
	Destructor.
int	setInitialSectionDeformation (const Vector &)
	Set initial generalized strain.
int	setTrialSectionDeformation (const Vector &)
	Set trial generalized strain.
void	zeroInitialSectionDeformation (void)
	Zeroes initial generalized strain.
const Vector &	getInitialSectionDeformation (void) const
	Return the initial generalized strain.
const Vector &	getSectionDeformation (void) const
	Returns material's trial generalized deformation.
double	getStrain (const double &, const double &) const
	Returns strain at position being passed as parameter.
const Vector &	getStressResultant (void) const
	Return the the generalized stress vector.
const Matrix &	getSectionTangent (void) const
	Return the stiffness matrix.
const Matrix &	getInitialTangent (void) const
	Return the initial stiffness matrix.
int	commitState (void)
	Commits the current state.
int	revertToLastCommit (void)
	Returns the material to its last committed state.
int	revertToStart (void)
	Returns the material to its initial state.
SectionForceDeformation *	getCopy (void) const
	Virtual constructor.
const ResponseId &	getResponseType (void) const
	Returns the section ID code that indicates the type of response quantities returned by this instance of GenericSectionND. More...
int	getOrder (void) const
	Returns the result of invoking getOrder() on the NDMaterial.
int	sendSelf (Communicator &)
	Sends the object.
int	recvSelf (const Communicator &)
	Receives the object.
void	Print (std::ostream &s, int flag=0) const
	Print stuff.
Public Member Functions inherited from XC::SectionForceDeformation
	SectionForceDeformation (int tag, int classTag, MaterialHandler *mat_ldr=nullptr)
	Constructor. More...
MaterialHandler *	getMaterialHandler (void)
virtual int	incrementInitialSectionDeformation (const Vector &)
	Adds to the generalized initial strains vector inicial the vector being passed as parameter. More...
void	setInitialGeneralizedStrain (const Vector &iS)
const Vector &	getInitialGeneralizedStrain (void) const
Vector	getTrialSectionDeformation (void) const
	Return the trial section deformation vector, \(e_{trial}\). More...
double	getSectionDeformation (const int &) const
	Returns 'defID' component of the generalized strain vector.
double	getSectionDeformationByName (const std::string &) const
	Returns section's trial deformation component by its name.
double	getStressResultant (const int &) const
	Returns 'defID' component of the generalized stress vector.
double	getStressResultantByName (const std::string &) const
	Returns the esfuerzos de la placa.
virtual const Matrix &	getSectionFlexibility (void) const
	Returns the tangent flexibility matrix of the section. More...
virtual const Matrix &	getInitialFlexibility (void) const
	Returns the initial flexibility matrix of the section.
const Vector &	getGeneralizedStress (void) const
	Return generalized stress.
virtual const Vector &	getGeneralizedStrain (void) const
	Return generalized strain.
virtual Matrix	getValues (const std::string &, bool silent=false) const
	Return values of internal forces, deformations... More...
virtual double	getRho (void) const
	Returns the density (mass per unit length/area/volume) of the section. More...
virtual double	getLinearRho (void) const
	Returns the mass per unit length of the section.
virtual double	getArealRho (void) const
	Returns the mass per unit area of the section.
virtual double	getVolumetricRho (void) const
	Returns the mass per unit volume of the section.
std::string	getResponseTypeString (void) const
	Comma separated internal forces names to with the section contributes with stiffness.
virtual Response *	setResponse (const std::vector< std::string > &argv, Information &info)
	Returns the respuesta of the section.
virtual int	getResponse (int responseID, Information &info)
	Returns section response.
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 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 const Vector &	getStressResultantSensitivity (int gradNumber, bool conditional)
virtual const Vector &	getSectionDeformationSensitivity (int gradNumber)
virtual const Matrix &	getSectionTangentSensitivity (int gradNumber)
virtual const Matrix &	getSectionFlexibilitySensitivity (int gradIndex)
virtual const Matrix &	getInitialTangentSensitivity (int gradIndex)
virtual const Matrix &	getInitialFlexibilitySensitivity (int gradIndex)
virtual double	getRhoSensitivity (int gradNumber)
virtual int	commitSensitivity (const Vector &sectionDeformationGradient, int gradNumber, 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 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.
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.

Protected Member Functions
void	free (void)
	Frees memory.
void	alloc (const NDMaterial *, const ResponseId *)
	Allocates memory.
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::SectionForceDeformation
int	sendData (Communicator &comm)
	Send object members through the communicator argument.
int	recvData (const Communicator &comm)
	Receives object members through the communicator argument.
bool	isEqual (const SectionForceDeformation &) const
	Return true if both objects are equal.
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.

Protected Attributes
NDMaterial *	theModel
ResponseId *	code
int	order
Protected Attributes inherited from XC::SectionForceDeformation
Matrix	fDefault
	Default flexibility matrix.
MaterialHandler *	material_handler
	Material definition handler (search,...).

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 CommandEntity *	entcmd_cast (boost::any &data)
Static Protected Attributes inherited from EntityWithOwner
static int	verbosity = 1
	Object that owns THIS ONE. More...

Detailed Description

GenericSectionND provides a wrapper around a NDMaterial.

GenericSectionND provides a wrapper around a NDMaterial so that any NDMaterial may be used to model section response. The design of this class follows the Object Adapter pattern in {Design Patterns} by Gamma et al.

Constructor & Destructor Documentation

GenericSectionNd()

XC::GenericSectionNd::GenericSectionNd	(	int	tag,
		const NDMaterial &	m,
		const ResponseId &	mCode
	)

Constructor.

Parameters

tag	object identifier.
m	ND material.
mCode	material response identifiers.

Member Function Documentation

getResponseType()

const XC::ResponseId & XC::GenericSectionNd::getResponseType ( void  ) const

virtual

Returns the section ID code that indicates the type of response quantities returned by this instance of GenericSectionND.

Implements XC::SectionForceDeformation.

---

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

• src/material/section/GenericSectionNd.h
• src/material/section/GenericSectionNd.cpp