xc
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
XC::MaterialWrapper< MatType, cTag > Class Template Reference

Encapsulates a copy to a material. More...

#include <MaterialWrapper.h>

Inheritance diagram for XC::MaterialWrapper< MatType, cTag >:
Inheritance graph
[legend]
Collaboration diagram for XC::MaterialWrapper< MatType, cTag >:
Collaboration graph
[legend]

Public Types

typedef MatType MaterialType
 

Public Member Functions

 MaterialWrapper (void)
 Default constructor.
 
 MaterialWrapper (const MatType &material)
 Constructor.
 
 MaterialWrapper (const MaterialWrapper &)
 Copy constructor.
 
MaterialWrapperoperator= (const MaterialWrapper &)
 Assignment operator.
 
const MatType * getMaterial (void) const
 Return a pointer to the wrapped material.
 
MatType * getMaterial (void)
 Return a pointer to the wrapped material.
 
virtual void setMaterial (const MatType &)
 Sets the wrapped material.
 
void Print (std::ostream &, int flag=0) const
 
int getMainClassTag (void) const
 
int sendData (Communicator &)
 
int recvData (const Communicator &)
 
int sendSelf (Communicator &)
 Send the object. More...
 
int recvSelf (const Communicator &)
 Receive the object. More...
 
- 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.
 
MovableObjectoperator= (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 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 ~DistributedBase (void)
 Destructor.
 
virtual DbTagDatagetDbTagData (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_mem (void)
 Free memory allocated for the uniaxial material.
 
void copy (const MatType *)
 brief Copy object members.
 

Protected Attributes

MatType * theMaterial
 

Detailed Description

template<typename MatType, int cTag>
class XC::MaterialWrapper< MatType, cTag >

Encapsulates a copy to a material.

Member Function Documentation

◆ recvSelf()

template<typename MatType , int cTag>
int XC::MaterialWrapper< MatType, cTag >::recvSelf ( const Communicator comm)
virtual

Receive the object.

Each object has to receive the data needed to be able to recreate itself in the new process after it has been sent through cp. If the object is an aggregation containing other objects, new objects of the correct type can be constructed using #theBroker. To return 0 if successful or a -1 if not.

Implements XC::MovableObject.

◆ sendSelf()

template<typename MatType , int cTag>
int XC::MaterialWrapper< MatType, cTag >::sendSelf ( Communicator comm)
virtual

Send the object.

Each object has to send the data needed to be able to reproduce that object in a remote process. The object uses the methods provided by cp object to send the data to another channel at the remote actor, the address of the channel is set before this method is called. An object of similar type at the remote actor is invoked with a receiveSelf() to receive the data. Returns 0 if successful (successful in that the data got to the channel), or a - if no data was sent.

Implements XC::MovableObject.


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