Container for FE_Element and DOF_Group objects created by the constraint handler. More...

#include <AnalysisModel.h>

Inheritance diagram for XC::AnalysisModel:

Public Member Functions
virtual	~AnalysisModel (void)
	Destructor. More...

virtual DOF_Group *	createDOF_Group (const int &, Node *)

virtual LagrangeDOF_Group *	createLagrangeDOF_Group (const int &, SFreedom_Constraint *)
	Appends to the model the Lagrange DOFs for the single freedom constraint being passed as parameter. More...

virtual LagrangeDOF_Group *	createLagrangeDOF_Group (const int &, MFreedom_Constraint *)
	Appends to the model the Lagrange DOFs for the multi-freedom constraint being passed as parameter. More...

virtual LagrangeDOF_Group *	createLagrangeDOF_Group (const int &, MRMFreedom_Constraint *)
	Appends to the model the Lagrange DOFs for the multi-freedom constraint being passed as parameter. More...

virtual TransformationDOF_Group *	createTransformationDOF_Group (const int &, Node , MFreedom_ConstraintBase , TransformationConstraintHandler *)

virtual TransformationDOF_Group *	createTransformationDOF_Group (const int &, Node , TransformationConstraintHandler )

virtual FE_Element *	createFE_Element (const int &, Element *)
	Creates a FE_Element and appends it to the model.

virtual LagrangeSFreedom_FE *	createLagrangeSFreedom_FE (const int &, SFreedom_Constraint &, DOF_Group &, const double &)
	Create an LagrangeSFreedom_FE object and append it to the model.

virtual LagrangeMFreedom_FE *	createLagrangeMFreedom_FE (const int &, MFreedom_Constraint &, DOF_Group &, const double &)
	Method to create a LagrangeMFreedom_FE object and append it to the model. More...

virtual LagrangeMRMFreedom_FE *	createLagrangeMRMFreedom_FE (const int &, MRMFreedom_Constraint &, DOF_Group &, const double &)
	Method to create a LagrangeMRMFreedom_FE object and append it to the model. More...

virtual PenaltySFreedom_FE *	createPenaltySFreedom_FE (const int &, SFreedom_Constraint &, const double &)
	Method to create a PenaltySFreedom_FE object and append it to the model. More...

virtual PenaltyMFreedom_FE *	createPenaltyMFreedom_FE (const int &, MFreedom_Constraint &, const double &)
	Create a PenaltyMFreedom_FE object and append it to the model.

virtual PenaltyMRMFreedom_FE *	createPenaltyMRMFreedom_FE (const int &, MRMFreedom_Constraint &, const double &)
	Create a PenaltyMRMFreedom_FE object and append it to the model.

virtual FE_Element *	createTransformationFE (const int &, Element , const std::set< int > &, std::set< FE_Element > &)
	Create a TransformationFE_Element object and append it to the model.

virtual void	clearAll (void)
	Clears from the model all FE_Element and DOF_Group objects. More...

virtual int	getNumDOF_Groups (void) const
	Returns the umber of DOF_Group objects added to the model.

virtual DOF_Group *	getDOF_GroupPtr (int tag)
	Returns a pointer to the DEF group with the tag beign passed as parameter. More...

virtual const DOF_Group *	getDOF_GroupPtr (int tag) const
	Returns a pointer to the DOF group which the tag being passed as parameter. More...

virtual FE_EleIter &	getFEs ()
	Returns an {FE_EleIter} for the FE_Elements of the model.

virtual DOF_GrpIter &	getDOFGroups ()

virtual FE_EleConstIter &	getConstFEs () const
	Returns a {FE_EleConstIter} for the FE_Elements of the model.

virtual DOF_GrpConstIter &	getConstDOFs () const

virtual void	setNumEqn (int)
	Sets the value of the number of equations in the model. More...

virtual int	getNumEqn (void) const
	Returns the number of DOFs in the model which have been assigned an equation number. More...

virtual Graph &	getDOFGraph (void)

virtual Graph &	getDOFGroupGraph (void)
	Returns the connectivity of the DOF_Group objects in the model. More...

virtual const Graph &	getDOFGraph (void) const
	Returns the DOF connectivity graph for the individual dofs in the model. More...

virtual const Graph &	getDOFGroupGraph (void) const

virtual void	setResponse (const Vector &, const Vector &, const Vector &)
	Sets the values of the displacement, velocity and acceleration of the nodes. More...

virtual void	setDisp (const Vector &disp)
	Sets the values of the displacement of the nodes. More...

virtual void	setVel (const Vector &vel)
	Sets the values of the velocity of the nodes. More...

virtual void	setAccel (const Vector &vel)
	Sets the values of the acceleration of the nodes. More...

virtual void	incrDisp (const Vector &disp)
	Sets the values of the displacement increment of the nodes. More...

virtual void	incrVel (const Vector &vel)
	Sets the values of the velocity increment of the nodes. More...

virtual void	incrAccel (const Vector &vel)
	Sets the values of the acceleration increment of the nodes. More...

virtual void	setNumEigenvectors (int numEigenvectors)

virtual void	setEigenvector (int mode, const Vector &)

virtual void	setEigenvalues (const Vector &)
	Informs the domain of the obtained eigenvalues.

virtual void	setModalParticipationFactors (const Vector &)
	Informs the domain of the obtained modal participation factors.

virtual int	sendSelf (CommParameters &)
	Returns \(0\). More...

virtual int	recvSelf (const CommParameters &)
	Returns \(0\).

Domain *	getDomainPtr (void)
	Returns a pointer to the associated Domain, that is the Domain set when the links were set. More...

const Domain *	getDomainPtr (void) const
	Returns a const pointer to the associated Domain, that is the Domain set when the links were set. More...

ConstraintHandler *	getHandlerPtr (void)

const ConstraintHandler *	getHandlerPtr (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 (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 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
virtual void	applyLoadDomain (double newTime)
	Method which invokes {applyLoad(timeStep, loadFactor)} on the domain. More...

virtual int	updateDomain (void)
	Method which invokes update() on the domain. More...

virtual int	updateDomain (double newTime, double dT)

virtual int	newStepDomain (double dT=0.0)

virtual int	commitDomain (void)
	Commits domain state. More...

virtual int	revertDomainToLastCommit (void)
	Returns to the last commited state. More...

virtual double	getCurrentDomainTime (void)
	To get the current time in the Domain. More...

virtual void	setCurrentDomainTime (double newTime)
	To set the current time in the Domain to be `newTime`. More...

virtual void	setRayleighDampingFactors (const RayleighDampingFactors &rF)

virtual bool	addDOF_Group (DOF_Group *theDOF_Grp)
	Method to add an DOF to the model. More...

virtual bool	addFE_Element (FE_Element *theFE_Ele)
	Adds the FE_Element pointed to by `theElement` to the model. More...

	AnalysisModel (ModelWrapper *owr=nullptr)
	Constructor. More...

	AnalysisModel (int classTag, CommandEntity *owr)
	Constructor. More...

	AnalysisModel (const AnalysisModel &)
	Copy constructor.

AnalysisModel &	operator= (const AnalysisModel &)
	Assignment operator.

AnalysisModel *	getCopy (void) const
	Virtual constructor.

Friends
class	Integrator

class	Analysis

class	ModelWrapper

class	FEM_ObjectBroker

Detailed Description

Container for FE_Element and DOF_Group objects created by the constraint handler.

AnalysisModel is a container class. This class is responsible for holding and providing access to the FE_Element and DOF_Group objects that the ConstraintHandler creates. It is also responsible for updating the response quantities at the DOF_Groups and for triggering methods in the associated Domain. It provides operations for the following:

Population: methods so that the ConstraintHandler can add the FE_Element and DOF_Group objects to the analysis model.
Access: methods so that other classes in the analysis aggregation can access the components of the AnalysisModel.
Connectivity: methods such that the SysOfEqn can determine the connectivity of the dof, which is needed for storage, sparsity, etc.
Update: methods for updating the individual DOFs with the response quantities given by the AnalysisMethod.
Trigger: methods which trigger events in the domain.

Each subclass of AnalysisModel must have its own subclasses of FE_ELEIter and DOF_GrpIter.

Constructor & Destructor Documentation

§ AnalysisModel() [1/2]

XC::AnalysisModel::AnalysisModel ( ModelWrapper * owr = nullptr )

protected

Constructor.

Constructs an empty AnalysisModel. The constructor allocates space for two arrays of 256 pointers to FE_Elements and DOF_Groups. If not enough memory is available for these arrays, an error message is printed and the program is terminated. Note these arrays grow automatically if the problem needs it.

§ AnalysisModel() [2/2]

XC::AnalysisModel::AnalysisModel	(	int	theClassTag,
		CommandEntity *	owr
	)

protected

Constructor.

Provided for subclasses to be used. The storage of the FE_Elements and DOF_Groups and iters to access them must be provided by the subclass.

§ ~AnalysisModel()

XC::AnalysisModel::~AnalysisModel ( void )

virtual

Destructor.

Is responsible for returning to memory the arrays used for storing pointers to the FE_Element and DOF_Groups which have been added to the AnalysisModel. It is not responsible for deleting the individual DOF_Group and FE_Element objects, that is the responsibility of the ConstraintHandler. If the Graphs have been requested their destructor is invoked.

Member Function Documentation

§ addDOF_Group()

bool XC::AnalysisModel::addDOF_Group ( DOF_Group * theGroup )

protectedvirtual

Method to add an DOF to the model.

Adds the DOF_Group pointed to by theGroup to the domain. If the array for the DOF_Groups is large enough, it adds this pointer to the array and increments the number of DOF_Groups in the array. If the array is not large enough, a new one double in size is constructed, all the old pointers are copied to this new array and the new pointer is then added. If not enough room is available for this array, an error message is printed and the program is terminated. Returns true, otherwise false if {theGroup} is \(0\) or derived class used which does not implement the method.

§ addFE_Element()

bool XC::AnalysisModel::addFE_Element ( FE_Element * theElement )

protectedvirtual

Adds the FE_Element pointed to by theElement to the model.

Adds the FE_Element pointed to by theElement to the domain and invokes {setAnalysisModel(*this)} on the FE_Element. If the array for the FE_Elements is large enough, it adds this pointer to the array and increments the number of FE_Elements in the array. If the array is not large enough, a new one double in size is constructed, all the old pointers are copied to this new array and the new pointer is then added. If not enough room is available for this array, an error message is printed and the program is terminated. Returns true, otherwise false if {theElement} is \(0\) or derived class used which does not implement the method.

§ applyLoadDomain()

void XC::AnalysisModel::applyLoadDomain ( double pseudoTime )

protectedvirtual

Method which invokes {applyLoad(timeStep, loadFactor)} on the domain.

Method which invokes {applyLoad(timeStep, loadFactor)} on the domain. This method causes the domain ask the loads in the currently set to apply themselves. If no Domain has been set nothing is done and an error message is printed.

§ clearAll()

void XC::AnalysisModel::clearAll ( void )

virtual

Clears from the model all FE_Element and DOF_Group objects.

Clears from the model all FE_Element and DOF_Group objects that have been added to the analysis model using the above two methods. It does this by setting the components in the two arrays of pointers equal to \(0\) and setting the number of components to \(0\). If the Graphs have been created their destructor is invoked. Also sets numEqn to \(0\).

§ commitDomain()

int XC::AnalysisModel::commitDomain ( void )

protectedvirtual

Commits domain state.

Method which invokes commit() on the domain: this is an operation which causes all nodes in the domain to take the current values of response quantities and copy them into the accepted values. Returns \(0\) if successful , a negative number if not: \(-1\) if no Domain has been set and \(-2\) if commit() fails on the Domain.

§ createLagrangeDOF_Group() [1/3]

XC::LagrangeDOF_Group * XC::AnalysisModel::createLagrangeDOF_Group	(	const int &	tag,
		SFreedom_Constraint *	spPtr
	)

virtual

Appends to the model the Lagrange DOFs for the single freedom constraint being passed as parameter.

Parameters

tag	identifier for the new Lagrange DOFs group.
spPtr	single freedom constraint to introduce.

§ createLagrangeDOF_Group() [2/3]

XC::LagrangeDOF_Group * XC::AnalysisModel::createLagrangeDOF_Group	(	const int &	tag,
		MFreedom_Constraint *	mpPtr
	)

virtual

Appends to the model the Lagrange DOFs for the multi-freedom constraint being passed as parameter.

Parameters

tag	identifier for the new Lagrange DOFs group.
mpPtr	multi-freedom constraint to introduce.

§ createLagrangeDOF_Group() [3/3]

XC::LagrangeDOF_Group * XC::AnalysisModel::createLagrangeDOF_Group	(	const int &	tag,
		MRMFreedom_Constraint *	mrmpPtr
	)

virtual

Appends to the model the Lagrange DOFs for the multi-freedom constraint being passed as parameter.

Parameters

tag	identifier for the new Lagrange DOFs group.
mrmpPtr	multi-row, multi-freedom constraint to introduce.

§ createLagrangeMFreedom_FE()

XC::LagrangeMFreedom_FE * XC::AnalysisModel::createLagrangeMFreedom_FE	(	const int &	tag,
		MFreedom_Constraint &	theMP,
		DOF_Group &	theDofGrp,
		const double &	alpha
	)

virtual

Method to create a LagrangeMFreedom_FE object and append it to the model.

§ createLagrangeMRMFreedom_FE()

XC::LagrangeMRMFreedom_FE * XC::AnalysisModel::createLagrangeMRMFreedom_FE	(	const int &	tag,
		MRMFreedom_Constraint &	theMRMP,
		DOF_Group &	theDofGrp,
		const double &	alpha
	)

virtual

Method to create a LagrangeMRMFreedom_FE object and append it to the model.

§ createPenaltySFreedom_FE()

XC::PenaltySFreedom_FE * XC::AnalysisModel::createPenaltySFreedom_FE	(	const int &	tag,
		SFreedom_Constraint &	theSP,
		const double &	alpha
	)

virtual

Method to create a PenaltySFreedom_FE object and append it to the model.

§ getCurrentDomainTime()

double XC::AnalysisModel::getCurrentDomainTime ( void )

protectedvirtual

To get the current time in the Domain.

To get the current time in the Domain. If no Domain has been set a warning message is printed and \(0.0\) is returned, otherwise the result of invoking getCurrentTime() on the Domain is returned.

§ getDOF_GroupPtr() [1/2]

XC::DOF_Group * XC::AnalysisModel::getDOF_GroupPtr ( int tag )

virtual

Returns a pointer to the DEF group with the tag beign passed as parameter.

Returns a pointer to the DOF_Group object whose tag is given by {tag}. It first checks to see if the DOF_Group object is at the location in the array given by tag; if not it searches through the array to find the DOF_Group object. Returns a pointer to the object if found, otherwise \(0\) is returned.

§ getDOF_GroupPtr() [2/2]

const XC::DOF_Group * XC::AnalysisModel::getDOF_GroupPtr ( int tag ) const

virtual

Returns a pointer to the DOF group which the tag being passed as parameter.

§ getDOFGraph()

const XC::Graph & XC::AnalysisModel::getDOFGraph ( void ) const

virtual

Returns the DOF connectivity graph for the individual dofs in the model.

This graph is used by the system of equation object to determine its size. If no graph has yet been constructed it creates a new DOF_Graph object using itself as the argument, otherwise it returns a pointer to this graph. THIS WILL CHANGE WHEN I REMOVE DOF_Graph CLASS - will go through and construct the Graph.

§ getDOFGroupGraph()

XC::Graph & XC::AnalysisModel::getDOFGroupGraph ( void )

virtual

Returns the connectivity of the DOF_Group objects in the model.

Returns the connectivity of the DOF_Group objects in the model. This graph is used by the DOF_Numberer to assign equation numbers to the dofs. If no graph has yet been constructed it creates a new DOF_GroupGraph object using itself as the argument, otherwise it returns a pointer to this graph. AGAIN WILL CHANGE.

§ getDomainPtr() [1/2]

XC::Domain * XC::AnalysisModel::getDomainPtr ( void )

Returns a pointer to the associated Domain, that is the Domain set when the links were set.

§ getDomainPtr() [2/2]

const XC::Domain * XC::AnalysisModel::getDomainPtr ( void ) const

Returns a const pointer to the associated Domain, that is the Domain set when the links were set.

§ getNumEqn()

int XC::AnalysisModel::getNumEqn ( void ) const

virtual

Returns the number of DOFs in the model which have been assigned an equation number.

Returns the number of DOFs in the model which have been assigned an equation number. Returns the value passed in setNumEqn(), if setNumEqn() was not invoked \(0\) is returned.

§ incrAccel()

void XC::AnalysisModel::incrAccel ( const Vector & accel )

virtual

Sets the values of the acceleration increment of the nodes.

The model is responsible for invoking {incrNodeAccel(accel)} on each DOF_Group in the model. It does this by getting an iter to the DOF_Group objects and iterating through them invoking {incrNodeAccel(accel)} on each DOF_Group.

§ incrDisp()

void XC::AnalysisModel::incrDisp ( const Vector & disp )

virtual

Sets the values of the displacement increment of the nodes.

The model is responsible for invoking {incrNodeDisp(disp)} on each DOF_Group in the model. It does this by getting an iter to the DOF_Group objects and iterating through them invoking {incrNodeDisp(disp)} on each DOF_Group.

§ incrVel()

void XC::AnalysisModel::incrVel ( const Vector & vel )

virtual

Sets the values of the velocity increment of the nodes.

The model is responsible for invoking {incrNodeVel(vel)} on each DOF_Group in the model. It does this by getting an iter to the DOF_Group objects and iterating through them invoking {incrNodeVel(vel)} on each DOF_Group.

§ revertDomainToLastCommit()

int XC::AnalysisModel::revertDomainToLastCommit ( void )

protectedvirtual

Returns to the last commited state.

Method which invokes revertToLastCommit() on the domain: this is an operation which causes all nodes in the domain to set the trial response quantities equal to the last committed response quantities. Returns \(0\) if successful , a negative number if not: \(-1\) if no Domain has been set and \(-2\) if revertToLastCommit() fails on the Domain.

§ sendSelf()

int XC::AnalysisModel::sendSelf ( CommParameters & cp )

virtual

Returns \(0\).

Note the FE_Elements and DOF_Group objects are not sent as they are not MovableObjects. AnalysisModel objects are only sent when setting up a DomainDecompAnalysis on a remote process; only type info and whatever subclasses might need need to be sent.

Implements XC::MovableObject.

§ setAccel()

void XC::AnalysisModel::setAccel ( const Vector & accel )

virtual

Sets the values of the acceleration of the nodes.

The model is responsible for invoking {setAccel(accel)} on each DOF_Group in the model. It does this by getting an iter to the DOF_Group objects and iterating through them invoking {setNodeAccel(accel)} on each DOF_Group.

§ setCurrentDomainTime()

void XC::AnalysisModel::setCurrentDomainTime ( double newTime )

protectedvirtual

To set the current time in the Domain to be newTime.

To set the current time in the Domain to be newTime. If no Domain has been set a warning message is printed, otherwise {setCurrentTime(newTime)} is invoked on the Domain.

§ setDisp()

void XC::AnalysisModel::setDisp ( const Vector & disp )

virtual

Sets the values of the displacement of the nodes.

The model is responsible for invoking {setDisp(disp)} on each DOF_Group in the model. It does this by getting an iter to the DOF_Group objects and iterating through them invoking {setNodeDisp(disp)} on each DOF_Group.

§ setNumEqn()

void XC::AnalysisModel::setNumEqn ( int theNumEqn )

virtual

Sets the value of the number of equations in the model.

Invoked by the DOF_Numberer when it is numbering the dofs.

§ setResponse()

void XC::AnalysisModel::setResponse	(	const Vector &	disp,
		const Vector &	vel,
		const Vector &	accel
	)

virtual

Sets the values of the displacement, velocity and acceleration of the nodes.

The model is responsible for invoking {setNodeDisp(disp)}, {setNodeVel(vel)} and {setNodeAccel(accel)} on each DOF_Group in the model. It does this by iterating over the DOF_Group objects using the iter.

§ setVel()

void XC::AnalysisModel::setVel ( const Vector & vel )

virtual

Sets the values of the velocity of the nodes.

The model is responsible for invoking {setVel(vel)} on each DOF_Group in the model. It does this by getting an iter to the DOF_Group objects and iterating through them invoking {setNodeVel(vel)} on each DOF_Group.

§ updateDomain()

int XC::AnalysisModel::updateDomain ( void )

protectedvirtual

Method which invokes update() on the domain.

If no Domain has been set nothing is done and an error message is printed.

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

src/solution/analysis/model/AnalysisModel.h
src/solution/analysis/model/AnalysisModel.cpp

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

§ AnalysisModel() [1/2]

§ AnalysisModel() [2/2]

§ ~AnalysisModel()

Member Function Documentation

§ addDOF_Group()

§ addFE_Element()

§ applyLoadDomain()

§ clearAll()

§ commitDomain()

§ createLagrangeDOF_Group() [1/3]

§ createLagrangeDOF_Group() [2/3]

§ createLagrangeDOF_Group() [3/3]

§ createLagrangeMFreedom_FE()

§ createLagrangeMRMFreedom_FE()

§ createPenaltySFreedom_FE()

§ getCurrentDomainTime()

§ getDOF_GroupPtr() [1/2]

§ getDOF_GroupPtr() [2/2]

§ getDOFGraph()

§ getDOFGroupGraph()

§ getDomainPtr() [1/2]

§ getDomainPtr() [2/2]

§ getNumEqn()

§ incrAccel()

§ incrDisp()

§ incrVel()

§ revertDomainToLastCommit()

§ sendSelf()

§ setAccel()

§ setCurrentDomainTime()

§ setDisp()

§ setNumEqn()

§ setResponse()

§ setVel()

§ updateDomain()