Base class for materials. More...

#include <Material.h>

Inheritance diagram for XC::Material:

Collaboration diagram for XC::Material:

Public Member Functions
	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 int	setParameter (const std::vector< std::string > &argv, Parameter &param)
	Sets the value `param` to the parameter `argv`.

virtual int	updateParameter (int responseID, Information &eleInformation)
	Updates the parameter identified by `parameterID` with `info`.

virtual Response *	setResponse (const std::vector< std::string > &argv, Information &eleInformation)

virtual int	getResponse (int responseID, Information &info)
	Returns material response.

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 const Vector &	getGeneralizedStress (void) const =0

virtual const Vector &	getGeneralizedStrain (void) const =0

virtual const Vector &	getInitialGeneralizedStrain (void) const =0

virtual void	setInitialGeneralizedStrain (const Vector &)=0

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

virtual int	revertToStart (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...

virtual TaggedObject *	getCopy (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.

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	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.

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
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 materials.

This class provides the interface that all subclasses must provide when introducing new material types. A material object is responsible for keeping track of stress, strain and the state variables for a particular integration point (Gauss point,...) in the domain.

Constructor & Destructor Documentation

◆ Material()

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

Constructor.

To construct a material whose unique identifier among materials in the domain is given by tag, and whose class identifier is given by classTag. These integers are passed to the TaggedObject and MovableObject class constructors.

Member Function Documentation

◆ getMaterialByName()

const XC::Material * XC::Material::getMaterialByName ( const std::string & matName ) const

Parameters

matName name of the material.

◆ getValues()

XC::Matrix XC::Material::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 complaint about non-existen property.

Reimplemented in XC::DruckerPrager, XC::NDMaterial, XC::SectionForceDeformation, XC::MembranePlateFiberSectionBase, and XC::PlateBase.

◆ incrementInitialGeneralizedStrain()

void XC::Material::incrementInitialGeneralizedStrain ( const Vector & incS )

virtual

Increments generalized strain.

Parameters

incS	strain increment.

◆ update()

void XC::Material::update ( void )

virtual

Update state variables for the material according to the new values of the parameters.

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

src/material/Material.h
src/material/Material.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Material()

Member Function Documentation

◆ getMaterialByName()

◆ getValues()

◆ incrementInitialGeneralizedStrain()

◆ update()