Object that can move between processes. More...

#include <MovableObject.h>

Inherited by XC::MaterialVector< BaseElasticSection1d >, XC::MaterialVector< BaseElasticSection2d >, XC::MaterialVector< BaseElasticSection3d >, XC::MaterialVector< ElasticSection >, XC::MaterialVector< NDMaterial >, XC::MaterialVector< SectionForceDeformation >, XC::MaterialVector< UniaxialMaterial >, XC::MaterialVector< XC::NDMaterial >, XC::MaterialWrapper< NDMaterial, MAT_TAG_NDMaterialWrapper >, XC::MaterialWrapper< UniaxialMaterial, MAT_TAG_UniaxialMaterialWrapper >, XC::MovableContainer< std::deque< std::string > >, XC::MovableContainer< std::vector< ID > >, XC::MovableContainer< std::vector< Vector > >, XC::PhysicalProperties< BaseElasticSection1d >, XC::PhysicalProperties< BaseElasticSection2d >, XC::PhysicalProperties< BaseElasticSection3d >, XC::PhysicalProperties< ElasticSection >, XC::PhysicalProperties< NDMaterial >, XC::PhysicalProperties< SectionForceDeformation >, XC::PhysicalProperties< UniaxialMaterial >, XC::ACICreepShrinkageParameters, XC::AnalysisModel, XC::BeamIntegration, XC::BodyForces, XC::ClosedTriangleMesh, XC::ConstraintHandler, XC::ConvergenceTest, XC::CrdTransf, XC::CreepShrinkageStateBase, XC::CrossSectionKR, XC::CrossSectionProperties1d, XC::CyclicModel, XC::DamageModel, XC::DamageModelVector, XC::Damping, XC::DampingVector, XC::DataOutputHandler, XC::DeformationPlane, XC::DOF_Numberer, XC::DomainComponent, XC::DomainDecompositionAnalysis, XC::DqGroundMotions, XC::DqUniaxialMaterial, XC::EntMdlrBase, XC::EnvelopeData, XC::Fiber, XC::FiberPtrDeque, XC::FiberSets, XC::FrictionModel, XC::Graph, XC::GraphNumberer, XC::GroundMotion, XC::Information, XC::Integrator, XC::IntegratorVectors, XC::InternalParamsA, XC::LineSearch, XC::LoadContainer, XC::LoadHandlerMember, XC::MapSet, XC::Material, XC::MaterialVector< MAT >, XC::MaterialWrapper< MatType, cTag >, XC::MC10CreepShrinkageParameters, XC::MeshComponentContainer, XC::ModelComponentContainerBase, XC::MovableBJTensor, XC::MovableContainer< C >, XC::MovableID, XC::MovableMatrices, XC::MovableMatrix, XC::MovablePointerContainer< T >, XC::MovableVector, XC::MultiBlockTopology, XC::NodeLockers, XC::NodePtrsWithIDs, XC::NodeVectors, XC::Parameter, XC::PartitionedModelBuilder, XC::PhysicalProperties< MAT >, XC::PrepHandler, XC::Preprocessor, XC::PrismaticBarCrossSectionsVector, XC::PseudoTimeTracker, XC::RayleighDampingFactors, XC::Recorder, XC::ResponseQuantities, XC::SectionMatrices, XC::SetEntities, XC::ShellCrdTransf3dBase, XC::SolutionAlgorithm, XC::Solver, XC::SubdomainAnalysis, XC::SystemOfEqn, XC::T2Vector, XC::TimeSeries, XC::TimeSeriesIntegrator, XC::UniaxialHistoryVars, XC::UniaxialStateVars, XC::Vertex, XC::YieldSurface_BC, and XC::YS_Evolution.

Collaboration diagram for XC::MovableObject:

[legend]

Public Member Functions
	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 (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	sendSelf (Communicator &comm)=0
	Send the object. More...

virtual int	recvSelf (const Communicator &comm)=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	~DistributedBase (void)
	Destructor.

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.

Detailed Description

Object that can move between processes.

Objects which are able to send/receive themselves through Channel objects. With each movable object is associated a unique class identifier, it is this id which will allow object brokers in remote processes to create an object of the correct type. In addition when databases are being used, each MovableObject will have a unique database tag, it is this integer which will allow the objects to retrieve their own data from the database.

Constructor & Destructor Documentation

◆ MovableObject() [1/2]

XC::MovableObject::MovableObject	(	int	cTag,
		int	dTag
	)

Constructor.

Sets the class tag and the database tag.

Sets the objects class identifier to cTag: this is a unique id for each class of instantiable movable objects. The identifier will allow an object broker to recognize the object type to be instantiated. Sets the objects database tag to dTag: this is a unique id for identifying the object in a database.

◆ MovableObject() [2/2]

XC::MovableObject::MovableObject ( int theTag )

Constructor.

Sets the objects class identifier to theTag and sets the objects database tag to 0.

Member Function Documentation

◆ recvSelf()

virtual int XC::MovableObject::recvSelf ( const Communicator & comm )

pure 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.

Implemented in XC::Node, XC::FiberPtrDeque, XC::SetMeshComp, XC::ASDShellQ4, XC::ReinforcingSteel, XC::SetEntities, XC::BarSlipMaterial, XC::MultiaxialCyclicPlasticity, XC::PressureDependMultiYieldBase, XC::AnalysisModel, XC::TwentyNodeBrick, XC::ShadowSubdomain, XC::Template3Dep, XC::Pinching4Material, XC::Subdomain, XC::Mesh, XC::Metis, XC::Set, XC::PlasticDamageConcretePlaneStress, XC::PressureDependMultiYield02, XC::LoadPattern, XC::ConstrContainer, XC::EightNodeBrick, XC::ZeroLength, XC::ZeroLengthContact3D, XC::ElasticTimoshenkoBeam3d, XC::TwentyEightNodeBrickUP, XC::BeamContact3D, XC::BeamColumnJoint3d, XC::Joint2D, XC::BeamContact2D, XC::ZeroLengthContact2D, XC::ZeroLengthSection, XC::J2Plasticity, XC::DruckerPrager, XC::HystereticMaterial, XC::BeamColumnJoint2d, XC::Preprocessor, XC::TDConcrete, XC::Joint3D, XC::fElement, XC::TwentyNodeBrick_u_p_U, XC::PressureIndependMultiYield, XC::ElasticTimoshenkoBeam2d, XC::CorotCrdTransf3d, XC::Twenty_Node_Brick, XC::EnhancedQuad, XC::Mehanny, XC::J2PlateFiber, XC::SparseGenColLinSOE, XC::MFreedom_Constraint, XC::Truss, XC::Brick, XC::ElasticIsotropicMaterial, XC::FiniteDeformationEP3D, XC::J2PlaneStress, XC::J2AxiSymm, XC::ShellNLDKGQ, XC::NineFourNodeQuadUP, XC::J2PlateFibre, XC::BeamWithHinges2d, XC::BeamWithHinges3d, XC::TwentySevenNodeBrick, XC::FDdecoupledElastic3D, XC::DomainDecompositionAnalysis, XC::ForceBeamColumn3d, XC::SectionAggregator, XC::CrossSectionProperties3d, XC::NineNodeMixedQuad, XC::MapLoadPatterns, XC::MultiBlockTopology, XC::ConvergenceTest, XC::FlatSliderSimple2d, XC::ProfileSPDLinSOE, XC::FatigueMaterial, XC::DisplacementControl, XC::LoadControl, XC::Tri31, XC::EightNodeBrick_u_p_U, XC::FourNodeQuad, XC::BrickUP, XC::CreepMaterial, XC::Steel02, XC::LoadContainer, XC::NLBeamColumn2d, XC::Bidirectional, XC::SuperLU, XC::CorotCrdTransf2d, XC::PressureDependMultiYield, XC::EPPGapMaterial, XC::OneRowMFreedom_Constraint, XC::ForceBeamColumn2d, XC::CrossSectionKR, XC::DummyNode, XC::Concrete02, XC::SubdomainAnalysis, XC::BandSPDLinSOE, XC::PBowlLoading, XC::DispBeamColumn3d, XC::CorotTruss, XC::TotalLagrangianFD20NodeBrick, XC::ElasticCrossAnisotropic, XC::CableMaterial, XC::Steel03, XC::ElasticBeam2d, XC::ElasticBeam3d, XC::BbarBrick, XC::DamageModel, XC::NormalizedPeak, XC::BandGenLinSOE, XC::TrussSection, XC::TotalLagrangianFD8NodeBrick, XC::Isolator2spring, XC::Graph, XC::FullGenLinSOE, XC::DispBeamColumn2dBase, XC::Concrete01, XC::Pinching, XC::ConstantPressureVolumeQuad, XC::BrickSurfaceLoad, XC::BoucWenMaterial, XC::TDConcreteMC10Base, XC::PathSeries, XC::FluidSolidPorousMaterial, XC::DrainMaterial, XC::HardeningMaterial, XC::DOF_Numberer, XC::SFreedom_Constraint, XC::CloughDamage, XC::Spring, XC::CrossSectionProperties2d, XC::Concrete04, XC::FourNodeQuadUP, XC::MembranePlateFiberSection, XC::MapSet, XC::PathTimeSeries, XC::InitialStateAnalysisWrapper, XC::ElasticPPMaterialBase, XC::PlateFromPlaneStressMaterial, XC::PlateRebarMaterial, XC::GenericSection1d, XC::CreepShrinkageStateBase, XC::UniformExcitation, XC::beam2d02, XC::MultiLinear, XC::Clough, XC::PinchingDamage, XC::PyLiq1, XC::TzLiq1, XC::NLBeamColumn3d, XC::KrylovNewton, XC::ShadowPetscSOE, XC::DistributedSuperLU, XC::NodalLoad, XC::CorotTrussSection, XC::PlaneStressMaterial, XC::TDConcreteBase, XC::EigenIntegrator, XC::MRMFreedom_Constraint, XC::RayleighDampingFactors, XC::ContactMaterial3D, XC::Bilinear, XC::LoadPath, XC::ItpackLinSolver, XC::SeriesMaterial, XC::ShellMITC9, XC::MaterialVector< MAT >, XC::GenericSectionNd, XC::MaterialVector< ElasticSection >, XC::MaterialVector< XC::NDMaterial >, XC::MaterialVector< BaseElasticSection1d >, XC::MaterialVector< UniaxialMaterial >, XC::MaterialVector< SectionForceDeformation >, XC::MaterialVector< BaseElasticSection2d >, XC::MaterialVector< BaseElasticSection3d >, XC::MaterialVector< NDMaterial >, XC::Kratzig, XC::ParkAng, XC::Beam3dUniformLoad, XC::PetscSOE, XC::DriftRecorder, XC::SimulatedRandomProcessSeries, XC::FlatSliderSimple3d, XC::Information, XC::NeoHookeanCompressible3D, XC::AutoConstraintHandler, XC::Parameter, XC::Steel01, XC::Vertex, XC::BandArpackSolver, XC::ProfileSPDLinDirectSkypackSolver, XC::HystereticEnergy, XC::TransformationConstraintHandler, XC::GroundMotion, XC::beam2d04, XC::CrossSectionProperties1d, XC::MC10CreepShrinkageState, XC::LineSearch, XC::StaticDomainDecompositionAnalysis, XC::MinUnbalDispNorm, XC::NewElement, XC::MeshRegion, XC::UniaxialFiber3d, XC::FiberSection2d, XC::NewtonLineSearch, XC::Linear, XC::MFreedom_Joint3D, XC::DiscretizedRandomProcessSeries, XC::DqUniaxialMaterial, XC::TransientDomainDecompositionAnalysis, XC::ProfileSPDLinSubstrSolver, XC::UniformDamping, XC::ContactMaterial2D, XC::DistributedSparseGenRowLinSOE, XC::InterpolatedGroundMotion, XC::EarthquakePattern, XC::ElasticMaterial, XC::FedeasMaterial, XC::Beam3dPointLoad, XC::LinearSeries, XC::PressureDependentElastic3D, XC::T2Vector, XC::UniaxialFiber2d, XC::FiberSectionGJ, XC::PetscSparseSeqSolver, XC::ProfileSPDLinDirectThreadSolver, XC::ThreadedSuperLU, XC::ElasticSection2d, XC::FiberSectionShear3d, XC::ParallelMaterial, XC::PetscSolver, XC::beam2d03, XC::PDeltaCrdTransf2d, XC::ElasticSection1d, XC::FiberSection3d, XC::SingleFPSimple2d, XC::ElasticSection3d, XC::ViscousMaterial, XC::LoadHandler, XC::ParallelNumberer, XC::BeamFiberMaterial, XC::PlateFiberMaterial, XC::PySimple1, XC::QzSimple1, XC::FullGenEigenSolver, XC::UmfpackGenLinSolver, XC::VPDependentFriction, XC::PDeltaCrdTransf3d, XC::ElasticShearSection3d, XC::ClosedTriangleMesh, XC::BFGS, XC::DistributedDisplacementControl, XC::ArpackSolver, XC::MumpsParallelSOE, XC::ProfileSPDLinDirectBlockSolver, XC::ProfileSPDLinDirectSolver, XC::NodeRecorder, XC::Recorder, XC::GroundMotionRecord, XC::SingleFPSimple3d, XC::DomainDecompAlgo, XC::PlainNumberer, XC::ItpackLinSOE, XC::ShellUniformLoad, XC::VDependentFriction, XC::MinMaxMaterial, XC::IntegratorVectors, XC::MyRCM, XC::FullGenEigenSOE, XC::SymBandEigenSolver, XC::MumpsSOE, XC::Beam2dPointLoad, XC::PulseSeries, XC::PhysicalProperties< MAT >, XC::FeapMaterial, XC::MembranePlateFiberSectionBase, XC::ENTNCBaseMaterial, XC::DistributedDiagonalSOE, XC::EnvelopeNodeRecorder, XC::PhysicalProperties< ElasticSection >, XC::PhysicalProperties< BaseElasticSection1d >, XC::PhysicalProperties< UniaxialMaterial >, XC::PhysicalProperties< SectionForceDeformation >, XC::PhysicalProperties< BaseElasticSection2d >, XC::PhysicalProperties< BaseElasticSection3d >, XC::PhysicalProperties< NDMaterial >, XC::NodeLocker, XC::InitStressMaterial, XC::RCM, XC::MFreedom_Joint2D, XC::CoulombFriction, XC::Broyden, XC::UmfpackGenLinSOE, XC::QuadSurfaceLoad, XC::SymBandEigenSOE, XC::EnvelopeElementRecorder, XC::Beam2dUniformLoad, XC::ElasticShearSection2d, XC::YieldSurfaceSection2d, XC::PathIndependentMaterial, XC::LoadCombination, XC::TrigSeries, XC::InitStrainMaterial, XC::SymArpackSOE, XC::DistributedBandGenLinSOE, XC::BandSPDLinLapackSolver, XC::FullGenLinLapackSolver, XC::DistributedSparseGenColLinSOE, XC::ImposedMotionSP1, XC::MultiSupportPattern, XC::TriangleSeries, XC::NodePtrsWithIDs, XC::NewUniaxialMaterial, XC::LinearBucklingAlgo, XC::PlainHandler, XC::BandGenLinLapackSolver, XC::DiagonalSOE, XC::ElementRecorder, XC::NodeVectors, XC::FiberSectionShear2d, XC::DeformationPlane, XC::BandSPDLinThreadSolver, XC::DistributedBandSPDLinSOE, XC::DistributedProfileSPDLinSOE, XC::SymSparseLinSOE, XC::SurfaceLoad, XC::SparseGenRowLinSOE, XC::DqGroundMotions, XC::InvertMaterial, XC::DistributedDiagonalSolver, XC::Beam2dPartialUniformLoad, XC::UserDefinedHingeIntegration3d, XC::SecStifDamping, XC::ACICreepShrinkageState, XC::TzSimple1, XC::FrequencyAlgo, XC::PeriodicNewton, XC::ResponseQuantities, XC::SimpleNumberer, XC::DiagonalDirectSolver, XC::InelasticYS2DGNL, XC::PrismaticBarCrossSectionsVector, XC::MC10CreepShrinkageParameters, XC::HalfDiagramMaterial, XC::ZeroLengthMaterials, XC::AMD, XC::SimpsonTimeSeriesIntegrator, XC::beam3d02, XC::ElasticMembranePlateSection, XC::MatParameter, XC::LobattoBeamIntegration, XC::LowOrderBeamIntegration, XC::Elastic2dGNL, XC::InternalParamsA, XC::StaticSensitivityIntegrator, XC::LegendreBeamIntegration, XC::DampingVector, XC::YieldSurface_BC2D, XC::TrapezoidalTimeSeriesIntegrator, XC::HingeMidpointBeamIntegration2d, XC::HingeRadauBeamIntegration, XC::HingeRadauBeamIntegration2d, XC::ElasticPlateSection, XC::HSConstraint, XC::EQPath, XC::DataOutputFileHandler, XC::LoadCombinationGroup, XC::RadauBeamIntegration, XC::KEigenAlgo, XC::SpectraSOE, XC::SymArpackSolver, XC::ShellMITC4, XC::InternalParamsLRIn, XC::beam3d01, XC::NewtonCotesBeamIntegration, XC::HingeRadauTwoBeamIntegration2d, XC::SectionMatrices, XC::NodeLockers, XC::StandardEigenAlgo, XC::MidDistanceBeamIntegration, XC::CyclicModel, XC::URDDamping, XC::ZeroLengthContact, XC::NullEvolution, XC::PlasticHardeningMaterial, XC::DataOutputDatabaseHandler, XC::BidimStrainLoad, XC::ThreedimStrainLoad, XC::ACICreepShrinkageParameters, XC::EntMdlrBase, XC::DataOutputStreamHandler, XC::ElasticBaseMaterial, XC::EnvelopeData, XC::CompositeSimpsonBeamIntegration, XC::TrapezoidalBeamIntegration, XC::Concrete02IS, XC::BandArpackppSOE, XC::BandArpackSOE, XC::BeamStrainLoad, XC::SymSparseLinSolver, XC::ImposedMotionBase, XC::TrussStrainLoad, XC::SolidMech2D, XC::MaterialWrapper< MatType, cTag >, XC::MaterialWrapper< UniaxialMaterial, MAT_TAG_UniaxialMaterialWrapper >, XC::MaterialWrapper< NDMaterial, MAT_TAG_NDMaterialWrapper >, XC::TrussPrestressLoad, XC::ElementRecorderBase, XC::PulseBaseSeries, XC::AggregatorAdditions, XC::InternalParamsIn, XC::Joint2DPhysicalProperties, XC::UniaxialHistoryVars, XC::SelfWeight, XC::UniaxialStateVars, XC::FactorsConstraintHandler, XC::PseudoTimeTracker, XC::SmallDispCrdTransf3d, XC::MumpsSolverBase, XC::ShellRawLoad, XC::BodyForces, XC::URDDampingbeta, XC::ModelComponentContainerBase, XC::BandArpackppSolver, XC::SpectraSolver, XC::ProtoArcLength, XC::BrickRawLoad, XC::DamageModelVector, XC::QuadRawLoad, XC::CFactorSeries, XC::ShellLinearCrdTransf3d, XC::ShellNLCrdTransf3d, XC::YS_Evolution2D, XC::HingeBeamIntegration3d, XC::PlasticLengthsBeamIntegration, XC::MovableContainer< C >, XC::MovableContainer< std::vector< Vector > >, XC::MovableContainer< std::vector< ID > >, XC::MovableContainer< std::deque< std::string > >, XC::UserDefinedBeamIntegrationBase, XC::ConvergenceTestTol, XC::ArcLengthBase, XC::InternalParamsLR, XC::MovableID, XC::BrickSelfWeight, XC::FiberSets, XC::MovableMatrix, XC::NewtonBased, XC::MovableMatrices, XC::MovablePointerContainer< T >, XC::MovableVector, XC::PrepHandler, XC::SmallDispCrdTransf2d, XC::ChebyshevBeamIntegration, and XC::MovableBJTensor.

◆ sendSelf()

virtual int XC::MovableObject::sendSelf ( Communicator & comm )

pure 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.

◆ setDbTag()

void XC::MovableObject::setDbTag ( Communicator & comm )

Sets the object identifier in the database if not already set.

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

src/utility/actor/actor/MovableObject.h
src/utility/actor/actor/MovableObject.cpp

Public Member Functions