Base class for domain components (nodes, elements, constraints, loads,...). More...

#include <DomainComponent.h>

Inheritance diagram for XC::DomainComponent:

Public Member Functions
	~DomainComponent (void)
	Destructor.

size_t	getIdx (void) const
	Returns the index of the object (to be used in VTK arrays).

virtual void	setDomain (Domain *theDomain)
	Sets the pointer to the domain. More...

virtual Domain *	getDomain (void) const
	Returns a pointer to the enclosing domain. More...

const Preprocessor *	getPreprocessor (void) const
	Returns (if possible) a pointer to the preprocessor.

Preprocessor *	getPreprocessor (void)
	Return (if possible) a pointer to the preprocessor.

void	set_index (const size_t &i)
	Set the index for the object (see numera in Set). More...

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)
	Print stuff.

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 (CommParameters &)
	Return the object identifier in the database.

void	setDbTag (int dbTag)
	Sets the object identifier in the database.

void	setDbTag (CommParameters &)
	Sets the object identifier in the database if not already set. More...

virtual int	sendSelf (CommParameters &cp)=0
	Send the object. More...

virtual int	recvSelf (const CommParameters &cp)=0
	Receive the object. More...

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 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 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
	DomainComponent (int tag, int classTag)
	Constructor. More...

int	sendData (CommParameters &)
	Send object members through the channel being passed as parameter.

int	recvData (const CommParameters &)
	Receive object members through the channel being passed as parameter.

Protected Member Functions inherited from XC::TaggedObject
void	setTag (int newTag)
	Set tag. More...

Detailed Description

Base class for domain components (nodes, elements, constraints, loads,...).

Base class for the different components of a domain. Each object of these types is a component of an enclosing Domain object. The DomainComponent class provides methods to set and retrieve a pointer to the enclosing domain object.

Constructor & Destructor Documentation

§ DomainComponent()

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

protected

Constructor.

Constructs a DomainComponent. The tag of a component is some unique means of identifying the component among like components, i.e. the tag of a node would be its unique node number. No domain is associated with the object.

Parameters

tag	object identifier.
classTag	class identifier.

Member Function Documentation

§ getDomain()

XC::Domain * XC::DomainComponent::getDomain ( void ) const

virtual

Returns a pointer to the enclosing domain.

Returns a pointer to the Domain to which the component was added, or \(0\) if the setDomain() command was never called on the object.

§ set_index()

void XC::DomainComponent::set_index ( const size_t & i )

Set the index for the object (see numera in Set).

This index is used on VTK arrays.

§ setDomain()

void XC::DomainComponent::setDomain ( Domain * model )

virtual

Sets the pointer to the domain.

Sets the encompassing domain of the component to that given by {theDomain}. This method is invoked by theDomain when the component is being added to the domain, in an {addDomain..} invocation (see interface for Domain).

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

src/domain/component/DomainComponent.h
src/domain/component/DomainComponent.cpp

Public Member Functions