XC::NDMaterial Class Reference

Base class for 2D and 3D materials. More...

#include <NDMaterial.h>

Inheritance diagram for XC::NDMaterial:

Collaboration diagram for XC::NDMaterial:

Public Member Functions
	NDMaterial ()
	Constructor.
	NDMaterial (int tag, int classTag)
	Constructor. More...
virtual double	getRho (void) const
	Get material density.
virtual void	setRho (const double &)
	Set material density.
virtual double	getE (void) const
	Return the material elastic modulus.
virtual double	getnu (void) const
	Return the material Poisson's ratio.
virtual double	getpsi (void) const
	Return the material psi??.
virtual int	setInitialStrain (const Vector &)
	Set initial strain value. More...
int	incrementInitialStrain (const Vector &)
	Increments initial strain. More...
void	zeroInitialStrain (void)
	Zeroes the initial strain.
virtual const Vector &	getInitialStrain (void) const
	Return the value of the initial strain.
virtual int	setTrialStrain (const Vector &v)
	Sets the value of the trial strain vector, that value used by {getStress()} and getTangent(), to be strain. More...
virtual int	setTrialStrain (const Vector &v, const Vector &r)
	Sets trial strain value.
virtual int	setTrialStrainIncr (const Vector &v)
	Set trial strain increment.
virtual int	setTrialStrainIncr (const Vector &v, const Vector &r)
	Set trial strain increment.
virtual const Matrix &	getTangent (void) const
	Return the tangent stiffness matrix at the current trial strain. More...
virtual const Matrix &	getInitialTangent (void) const
virtual const Vector &	getStress (void) const
	Returns the material stress vector at the current trial strain.
virtual const Vector &	getStrain (void) const
	Returns strain.
const Vector &	getGeneralizedStress (void) const
	Return the generalized stress.
const Vector &	getGeneralizedStrain (void) const
	Return the generalized strain.
virtual double	getVonMisesStress (void) const
	return the Von Mises equivalent stress. More...
virtual int	setTrialStrain (const Tensor &)
	Set trial strain value.
virtual int	setTrialStrain (const Tensor &, const Tensor &)
	Set trial strain value.
virtual int	setTrialStrainIncr (const Tensor &)
	Set trial strain increment.
virtual int	setTrialStrainIncr (const Tensor &, const Tensor &)
	Set trial strain increment.
const Tensor &	getTangentTensor (void) const
virtual const stresstensor &	getStressTensor (void) const
virtual const straintensor &	getStrainTensor (void) const
virtual const straintensor &	getPlasticStrainTensor (void) const
virtual void	setInitialGeneralizedStrain (const Vector &)
	Sets the initial strain value.
const Vector &	getInitialGeneralizedStrain (void) const
	Return the initial strain.
virtual const Vector &	getCommittedStress (void)
	Returns committed stresses.
virtual const Vector &	getCommittedStrain (void)
	Returns committed strains.
virtual NDMaterial *	getCopy (void) const =0
	Virtual constructor.
virtual NDMaterial *	getCopy (const std::string &) const =0
virtual const ResponseId &	getResponseType (void) const
	Return the ordering and type of response quantities returned by this material. More...
virtual const std::string &	getType (void) const =0
virtual int	getOrder (void) const =0
Matrix	getValues (const std::string &, bool silent=false) const
	Returns material response. More...
virtual Response *	setResponse (const std::vector< std::string > &argv, Information &matInformation)
virtual int	getResponse (int responseID, Information &matInformation)
	Returns material response.
int	revertToStart (void)
	Revert the material to its initial state.
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 &	getStressSensitivity (int gradIndex, bool conditional)
virtual const Vector &	getStrainSensitivity (int gradIndex)
virtual const Matrix &	getTangentSensitivity (int gradIndex)
virtual const Matrix &	getDampTangentSensitivity (int gradIndex)
virtual double	getRhoSensitivity (int gradIndex)
virtual int	commitSensitivity (Vector &strainGradient, int gradIndex, int numGrads)
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
virtual int	commitState (void)=0
virtual int	revertToLastCommit (void)=0
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.
virtual void	Print (std::ostream &, int flag=0) const
	Print stuff.
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	sendSelf (Communicator &comm)=0
	Send the object. More...
virtual int	recvSelf (const Communicator &comm)=0
	Receive the object. 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
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.

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

Base class for 2D and 3D materials.

NDMaterial objects represent stress-strain relationships at the integration points of continuum and force-deformation elements. NDMaterial class provides the interface that all NDMaterial writers must provide when introducing new NDMaterial subclasses. An NDMaterial object is responsible for keeping track of stress, strain and the constitution for a particular integration point in the domain.

Constructor & Destructor Documentation

NDMaterial()

XC::NDMaterial::NDMaterial	(	int	tag,
		int	classTag
	)

Constructor.

To construct a NDMaterial whose unique integer among NDMaterials in the domain is given by tag, and whose class identifier is given by classTag. These integers are passed to the Material class constructor.

Parameters

tag	material identifier.
classTag	identifier of the material class.

Member Function Documentation

getResponseType()

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

virtual

Return the ordering and type of response quantities returned by this material.

Return the section ResponseId code that indicates the ordering and type of response quantities returned by the material. Lets the calling object (e.g. an Element) know how to interpret the quantites returned by this object.

Reimplemented in XC::DruckerPragerPlaneStrain, and XC::ElasticIsotropic2D.

getTangent()

const XC::Matrix & XC::NDMaterial::getTangent ( void  ) const

virtual

Return the tangent stiffness matrix at the current trial strain.

Reimplemented in XC::PlasticDamageConcretePlaneStress, XC::Template3Dep, XC::PressureDependMultiYield02, XC::J2PlateFiber, XC::J2PlaneStress, XC::J2AxiSymm, XC::J2ThreeDimensional, XC::J2PlaneStrain, XC::J2PlateFibre, XC::ElasticIsotropicMaterial, XC::MultiaxialCyclicPlasticityAxiSymm, XC::PressureIndependMultiYield, XC::MultiaxialCyclicPlasticityPlaneStrain, XC::MultiaxialCyclicPlasticity3D, XC::PressureDependMultiYield, XC::PlateFromPlaneStressMaterial, XC::PlateRebarMaterial, XC::PlaneStressMaterial, XC::InitialStateAnalysisWrapper, XC::ElasticCrossAnisotropic, XC::FluidSolidPorousMaterial, XC::PlateFiberMaterial, XC::PressureDependentElastic3D, XC::DruckerPrager3D, XC::DruckerPragerPlaneStrain, XC::ContactMaterial3D, XC::BeamFiberMaterial, XC::ElasticIsotropicPlaneStress2D, XC::ElasticIsotropicPlaneStrain2D, XC::ElasticIsotropicPlateFiber, XC::ElasticIsotropicAxiSymm, XC::ContactMaterial2D, XC::FeapMaterial, XC::ElasticIsotropicBeamFiber, and XC::ElasticIsotropic3D.

getValues()

XC::Matrix XC::NDMaterial::getValues ( const std::string &  cod, bool  silent = false  ) const

virtual

Returns material response.

Parameters

cod	name of the requested value.
silent	if true don't complain about non-existen property.

Reimplemented from XC::Material.

Reimplemented in XC::DruckerPrager.

getVonMisesStress()

double XC::NDMaterial::getVonMisesStress ( void  ) const

virtual

return the Von Mises equivalent stress.

Von Mises yield criterion.

Reimplemented in XC::J2PlateFibre, XC::PlaneStressMaterial, XC::ElasticIsotropicPlaneStress2D, and XC::ElasticIsotropicPlateFiber.

incrementInitialStrain()

int XC::NDMaterial::incrementInitialStrain

(

const Vector &

)

Increments initial strain.

Parameters

strainIncrement

value of the strain increment.

setInitialStrain()

int XC::NDMaterial::setInitialStrain ( const Vector &  v )

virtual

Set initial strain value.

Parameters

strain

strain value.

Reimplemented in XC::J2PlateFibre, and XC::ElasticIsotropicMaterial.

setTrialStrain()

int XC::NDMaterial::setTrialStrain ( const Vector &  v )

virtual

Sets the value of the trial strain vector, that value used by {getStress()} and getTangent(), to be strain.

To return \(0\) if successful and a negative number if not.

Reimplemented in XC::PressureDependMultiYieldBase, XC::PlasticDamageConcretePlaneStress, XC::Template3Dep, XC::J2PlateFiber, XC::J2PlaneStress, XC::J2PlateFibre, XC::ElasticIsotropicMaterial, XC::J2AxiSymm, XC::J2ThreeDimensional, XC::J2PlaneStrain, XC::PressureIndependMultiYield, XC::MultiaxialCyclicPlasticityAxiSymm, XC::MultiaxialCyclicPlasticityPlaneStrain, XC::MultiaxialCyclicPlasticity3D, XC::PlaneStressMaterial, XC::PlateFromPlaneStressMaterial, XC::PlateRebarMaterial, XC::ElasticCrossAnisotropic, XC::FluidSolidPorousMaterial, XC::InitialStateAnalysisWrapper, XC::PlateFiberMaterial, XC::BeamFiberMaterial, XC::ContactMaterial3D, XC::DruckerPrager3D, XC::DruckerPragerPlaneStrain, XC::FeapMaterial, and XC::ContactMaterial2D.

---

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

• src/material/nD/NDMaterial.h
• src/material/nD/NDMaterial.cpp