xc
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
XC::FactorsConstraintHandler Class Reference

Base class for penalty and Lagrange constraints handlers. More...

#include <FactorsConstraintHandler.h>

Inheritance diagram for XC::FactorsConstraintHandler:
XC::ConstraintHandler XC::MovableObject XC::DistributedBase XC::LagrangeConstraintHandler XC::PenaltyConstraintHandler

Public Member Functions

void setAlphaSP (const double &a)
 Set the factor used with single freedom constraints.
 
double getAlphaSP (void) const
 Return the factor used with single freedom constraints.
 
void setAlphaMP (const double &a)
 Set the factor used with multi-freedom constraints.
 
double getAlphaMP (void) const
 Return the factor used with multi-freedom constraints.
 
virtual int sendSelf (CommParameters &)
 Send object through the channel passed as parameter.
 
virtual int recvSelf (const CommParameters &)
 Receive object through the channel passed as parameter.
 
- Public Member Functions inherited from XC::ConstraintHandler
virtual int handle (const ID *nodesNumberedLast=0)=0
 Invoked to handle the constraints imposed on the domain by the constraints. More...
 
virtual int update (void)
 Update the state of the constraints.
 
virtual int applyLoad (void)
 ??
 
virtual int doneNumberingDOF (void)
 Numbering of degrees of freedom.
 
virtual void clearAll (void)
 Reset the DOF_Group pointers to nullptr for all the nodes. 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 (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 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 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 (CommParameters &)
 Send object members through the channel passed as parameter.
 
int recvData (const CommParameters &)
 Receive object members through the channel passed as parameter.
 
 FactorsConstraintHandler (ModelWrapper *, int classTag, const double &alphaSP, const double &alphaMP)
 Constructor. More...
 
- Protected Member Functions inherited from XC::ConstraintHandler
const DomaingetDomainPtr (void) const
 Return a const pointer to the domain object associated with the ConstraintHandler.
 
const AnalysisModelgetAnalysisModelPtr (void) const
 Return a const pointer to the analysis model object associated with the ConstraintHandler.
 
const IntegratorgetIntegratorPtr (void) const
 Return a pointer to the Integrator object associated with the ConstraintHandler.
 
DomaingetDomainPtr (void)
 Return a pointer to the Domain object associated with the ConstraintHandler.
 
AnalysisModelgetAnalysisModelPtr (void)
 Returns a pointer to the AnalysisModel object associated with the ConstraintHandler.
 
IntegratorgetIntegratorPtr (void)
 Returns a pointer to the Integrator object associated with the ConstraintHandler.
 
int sendData (CommParameters &)
 Send object members through the channel passed as parameter.
 
int recvData (const CommParameters &)
 Receive object members through the channel passed as parameter.
 
 ConstraintHandler (ModelWrapper *, int classTag)
 Constructor. More...
 
virtual ConstraintHandlergetCopy (void) const =0
 

Protected Attributes

double alphaSP
 Factor used with the single freedom constraints.
 
double alphaMP
 Factor used with the multi-freedom constraints.
 

Detailed Description

Base class for penalty and Lagrange constraints handlers.

Constructor & Destructor Documentation

§ FactorsConstraintHandler()

XC::FactorsConstraintHandler::FactorsConstraintHandler ( ModelWrapper owr,
int  classTag,
const double &  sp,
const double &  mp 
)
protected

Constructor.

Parameters
owrpointer to the model wrapper that owns the handler.
classTagidentifier of the class.
spfactor to be used with the single freedom constraints.
mpfactor to be used with the multi-freedom constraints.

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