xc
Public Member Functions | Protected Member Functions | List of all members
XC::MatParameter Class Reference
Inheritance diagram for XC::MatParameter:
XC::Parameter XC::TaggedObject XC::MovableObject XC::DistributedBase

Public Member Functions

 MatParameter (int tag, int materialTag, const std::string &)
 
virtual void Print (std::ostream &s, int flag=0) const
 Print stuff.
 
virtual int sendSelf (Communicator &)
 Send the object. More...
 
virtual int recvSelf (const Communicator &)
 Receive the object. More...
 
virtual void setDomain (Domain *theDomain)
 
- Public Member Functions inherited from XC::Parameter
 Parameter (int tag, DomainComponent *theObject, const std::vector< std::string > &)
 
 Parameter (const Parameter &param)
 
 Parameter (int tag, int classTag=PARAMETER_TAG_Parameter)
 
virtual int update (int newValue)
 
virtual int update (double newValue)
 
virtual int activate (bool active)
 
virtual double getValue (void)
 
virtual void setValue (double newValue)
 
virtual int addComponent (DomainComponent *theObject, const std::vector< std::string > &)
 
virtual int addObject (int parameterID, MovableObject *object)
 
void setGradIndex (int gradInd)
 
int getGradIndex (void)
 
virtual std::string getType (void)
 
- Public Member Functions inherited from XC::TaggedObject
 TaggedObject (int tag, CommandEntity *owr=nullptr)
 Constructor. More...
 
virtual TaggedObjectgetCopy (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.
 
- 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

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::TaggedObject
void setTag (int newTag)
 Set tag. More...
 

Member Function Documentation

§ recvSelf()

int XC::MatParameter::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.

Reimplemented from XC::Parameter.

§ sendSelf()

int XC::MatParameter::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.

Reimplemented from XC::Parameter.


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