#include <extforce.h>

Inheritance diagram for ExtForce:

Collaboration diagram for ExtForce:

Public Types
enum	{ COUPLING_NONE = -2, COUPLING_STAGGERED = -1, COUPLING_LOOSE = 0, COUPLING_TIGHT = 1 }

Public Types inherited from Elem
enum	Type { UNKNOWN = -1, AIRPROPERTIES = 0, INDUCEDVELOCITY, AUTOMATICSTRUCTURAL, GRAVITY, BODY, JOINT, JOINT_REGULARIZATION, BEAM, PLATE, FORCE, INERTIA, ELECTRICBULK, ELECTRIC, THERMAL, HYDRAULIC, BULK, LOADABLE, DRIVEN, EXTERNAL, AEROMODAL, AERODYNAMIC, GENEL, SOCKETSTREAM_OUTPUT, RTAI_OUTPUT = SOCKETSTREAM_OUTPUT, LASTELEMTYPE }

Public Types inherited from SimulationEntity
typedef std::vector< Hint * >	Hints

Public Types inherited from ToBeOutput
enum	{ OUTPUT = 0x1U, OUTPUT_MASK = 0xFU, OUTPUT_PRIVATE = 0x10U, OUTPUT_PRIVATE_MASK = ~OUTPUT_MASK }

Public Types inherited from Force
enum	Type { UNKNOWN = -1, ABSTRACTFORCE = 0, ABSTRACTINTERNALFORCE, ABSOLUTEDISPFORCE, ABSOLUTEINTERNALDISPFORCE, ABSOLUTEFORCE, FOLLOWERFORCE, ABSOLUTECOUPLE, FOLLOWERCOUPLE, ABSOLUTEINTERNALFORCE, FOLLOWERINTERNALFORCE, ABSOLUTEINTERNALCOUPLE, FOLLOWERINTERNALCOUPLE, TOTALFORCE, TOTALINTERNALFORCE, EXTERNALSTRUCTURAL, MODALFORCE, EXTERNALMODAL, LASTFORCETYPE }

Public Member Functions
	ExtForce (unsigned int uL, DataManager pDM, ExtFileHandlerBase pEFH, bool bSendAfterPredict, int iCoupling, flag fOut)

virtual	~ExtForce (void)

virtual void	SetValue (DataManager pDM, VectorHandler &X, VectorHandler &XP, SimulationEntity::Hints h=0)

virtual void	Update (const VectorHandler &XCurr, const VectorHandler &XPrimeCurr)

virtual void	AfterConvergence (const VectorHandler &X, const VectorHandler &XP)

virtual void	AfterPredict (VectorHandler &X, VectorHandler &XP)

virtual void	InitialWorkSpaceDim (integer piNumRows, integer piNumCols) const

virtual VariableSubMatrixHandler &	InitialAssJac (VariableSubMatrixHandler &WorkMat, const VectorHandler &XCurr)

virtual SubVectorHandler &	InitialAssRes (SubVectorHandler &WorkVec, const VectorHandler &XCurr)

Public Member Functions inherited from Elem
	Elem (unsigned int uL, flag fOut)

virtual	~Elem (void)

virtual unsigned int	iGetNumDof (void) const

virtual std::ostream &	DescribeDof (std::ostream &out, const char *prefix="", bool bInitial=false) const

virtual void	DescribeDof (std::vector< std::string > &desc, bool bInitial=false, int i=-1) const

virtual std::ostream &	DescribeEq (std::ostream &out, const char *prefix="", bool bInitial=false) const

virtual void	DescribeEq (std::vector< std::string > &desc, bool bInitial=false, int i=-1) const

virtual DofOrder::Order	GetDofType (unsigned int) const

virtual void	WorkSpaceDim (integer piNumRows, integer piNumCols) const =0

virtual void	AssMats (VariableSubMatrixHandler &WorkMatA, VariableSubMatrixHandler &WorkMatB, const VectorHandler &XCurr, const VectorHandler &XPrimeCurr)

virtual SubVectorHandler &	AssRes (SubVectorHandler &WorkVec, doublereal dCoef, const VectorHandler &XCurr, const VectorHandler &XPrimeCurr)=0

virtual bool	bInverseDynamics (void) const

void	SetInverseDynamicsFlags (unsigned uIDF)

unsigned	GetInverseDynamicsFlags (void) const

bool	bIsErgonomy (void) const

bool	bIsRightHandSide (void) const

virtual VariableSubMatrixHandler &	AssJac (VariableSubMatrixHandler &WorkMat, const VectorHandler &XCurr)

virtual SubVectorHandler &	AssRes (SubVectorHandler &WorkVec, const VectorHandler &XCurr, const VectorHandler &XPrimeCurr, const VectorHandler &XPrimePrimeCurr, InverseDynamics::Order iOrder=InverseDynamics::INVERSE_DYNAMICS)

virtual int	GetNumConnectedNodes (void) const

virtual void	GetConnectedNodes (std::vector< const Node * > &connectedNodes) const

Public Member Functions inherited from WithLabel
	WithLabel (unsigned int uL=0, const std::string &sN="")

virtual	~WithLabel (void)

void	PutLabel (unsigned int uL)

void	PutName (const std::string &sN)

unsigned int	GetLabel (void) const

const std::string &	GetName (void) const

Public Member Functions inherited from SimulationEntity
	SimulationEntity (void)

virtual	~SimulationEntity (void)

virtual bool	bIsValidIndex (unsigned int i) const

virtual DofOrder::Order	GetEqType (unsigned int i) const

virtual Hint *	ParseHint (DataManager pDM, const char s) const

virtual void	BeforePredict (VectorHandler &, VectorHandler &, VectorHandler &, VectorHandler &) const

virtual void	DerivativesUpdate (const VectorHandler &XCurr, const VectorHandler &XPrimeCurr)

virtual void	Update (const VectorHandler &XCurr, InverseDynamics::Order iOrder)

virtual void	AfterConvergence (const VectorHandler &X, const VectorHandler &XP, const VectorHandler &XPP)

virtual unsigned int	iGetNumPrivData (void) const

virtual unsigned int	iGetPrivDataIdx (const char *s) const

virtual doublereal	dGetPrivData (unsigned int i) const

virtual std::ostream &	OutputAppend (std::ostream &out) const

virtual void	ReadInitialState (MBDynParser &HP)

Public Member Functions inherited from ToBeOutput
	ToBeOutput (flag fOut=fDefaultOut)

virtual	~ToBeOutput (void)

virtual void	OutputPrepare (OutputHandler &OH)

virtual void	Output (OutputHandler &OH) const

virtual void	Output (OutputHandler &OH, const VectorHandler &X, const VectorHandler &XP) const

virtual flag	fToBeOutput (void) const

virtual bool	bToBeOutput (void) const

virtual void	SetOutputFlag (flag f=flag(1))

Public Member Functions inherited from Force
	Force (unsigned int uL, flag fOut)

virtual	~Force (void)

virtual Elem::Type	GetElemType (void) const

virtual Force::Type	GetForceType (void) const =0

virtual VariableSubMatrixHandler &	AssJac (VariableSubMatrixHandler &WorkMat, doublereal, const VectorHandler &, const VectorHandler &)

virtual std::ostream &	Restart (std::ostream &out) const

virtual unsigned int	iGetInitialNumDof (void) const

Public Member Functions inherited from InitialAssemblyElem
	InitialAssemblyElem (unsigned int uL, flag fOut)

virtual	~InitialAssemblyElem (void)

Public Member Functions inherited from SubjectToInitialAssembly
	SubjectToInitialAssembly (void)

virtual	~SubjectToInitialAssembly (void)

Protected Member Functions
void	Send (ExtFileHandlerBase::SendWhen when)

void	Recv (void)

virtual bool	Prepare (ExtFileHandlerBase *pEFH)=0

virtual void	Send (ExtFileHandlerBase *pEFH, ExtFileHandlerBase::SendWhen when)=0

virtual void	Recv (ExtFileHandlerBase *pEFH)=0

Protected Attributes
Converged	c

ExtFileHandlerBase *	pEFH

bool	bSendAfterPredict

int	iCoupling

int	iCouplingCounter

bool	bFirstSend

bool	bFirstRecv

Protected Attributes inherited from WithLabel
unsigned int	uLabel

std::string	sName

Protected Attributes inherited from ToBeOutput
flag	fOutput

Detailed Description

Definition at line 190 of file extforce.h.

Member Enumeration Documentation

anonymous enum

Enumerator
COUPLING_NONE
COUPLING_STAGGERED
COUPLING_LOOSE
COUPLING_TIGHT

Definition at line 204 of file extforce.h.

              {
                 COUPLING_NONE = -2,
                 COUPLING_STAGGERED = -1,
                 COUPLING_LOOSE = 0,
                 COUPLING_TIGHT = 1
         };

Constructor & Destructor Documentation

ExtForce::ExtForce	(	unsigned int	uL,
		DataManager *	pDM,
		ExtFileHandlerBase *	pEFH,
		bool	bSendAfterPredict,
		int	iCoupling,
		flag	fOut
	)

Definition at line 677 of file extforce.cc.

References NO_OP.

 : Elem(uL, fOut), 
 Force(uL, fOut),
 c(iCoupling > COUPLING_LOOSE ? pDM : NULL),
 pEFH(pEFH),
 bSendAfterPredict(bSendAfterPredict),
 iCoupling(iCoupling),
 iCouplingCounter(0),
 bFirstSend(true),
 bFirstRecv(true)
 {
         NO_OP;
 }

ExtForce::~ExtForce ( void )

virtual

Definition at line 696 of file extforce.cc.

References pEFH, and SAFEDELETE.

 {
         if (pEFH) {
                 SAFEDELETE(pEFH);
         }
 }

Member Function Documentation

void ExtForce::AfterConvergence	(	const VectorHandler &	X,
		const VectorHandler &	XP
	)

virtual

Reimplemented from SimulationEntity.

Definition at line 770 of file extforce.cc.

References bSendAfterPredict, COUPLING_TIGHT, iCoupling, Send(), and ExtFileHandlerBase::SEND_AFTER_CONVERGENCE.

 {
         /* If not running tight coupling, send kinematics only at convergence */
         if (iCoupling != COUPLING_TIGHT && !bSendAfterPredict) {
                 Send(ExtFileHandlerBase::SEND_AFTER_CONVERGENCE);
 #if 0
                 if (bRemoveIn) {
                         Unlink();
                 }
 #endif
         }
 }

Here is the call graph for this function:

void ExtForce::AfterPredict	(	VectorHandler &	X,
		VectorHandler &	XP
	)

virtual

Reimplemented from SimulationEntity.

Definition at line 751 of file extforce.cc.

References ExtFileHandlerBase::AfterPredict(), bFirstRecv, bFirstSend, bSendAfterPredict, iCouplingCounter, pEFH, and Update().

 {
         /* After prediction, mark next residual as first */
         iCouplingCounter = 0;
         bFirstSend = true;
         bFirstRecv = true;
 
         pEFH->AfterPredict();
 
         /* needed to send predicted data */
         if (bSendAfterPredict) {
                 Update(X, XP);
         }
 }

Here is the call graph for this function:

VariableSubMatrixHandler & ExtForce::InitialAssJac	(	VariableSubMatrixHandler &	WorkMat,
		const VectorHandler &	XCurr
	)

virtual

Reimplemented from Force.

Definition at line 828 of file extforce.cc.

References VariableSubMatrixHandler::SetNullMatrix().

 {
         WorkMat.SetNullMatrix();
         return WorkMat;
 }

Here is the call graph for this function:

SubVectorHandler & ExtForce::InitialAssRes	(	SubVectorHandler &	WorkVec,
		const VectorHandler &	XCurr
	)

virtual

Implements SubjectToInitialAssembly.

Definition at line 837 of file extforce.cc.

References VectorHandler::ResizeReset().

 {
         WorkVec.ResizeReset(0);
         return WorkVec;
 }

Here is the call graph for this function:

void ExtForce::InitialWorkSpaceDim	(	integer *	piNumRows,
		integer *	piNumCols
	)		const

virtual

Implements SubjectToInitialAssembly.

Definition at line 820 of file extforce.cc.

 {
         *piNumRows = 0; 
         *piNumCols = 0; 
 }

virtual bool ExtForce::Prepare ( ExtFileHandlerBase * pEFH )

protectedpure virtual

Implemented in ModalExt, StructMappingExtForce, StructExtForce, and ModalMappingExt.

Referenced by SetValue().

void ExtForce::Recv ( void )

protected

Definition at line 798 of file extforce.cc.

References bFirstRecv, bFirstSend, c, Converged::CONVERGED, COUPLING_LOOSE, COUPLING_NONE, COUPLING_STAGGERED, COUPLING_TIGHT, iCoupling, iCouplingCounter, pEFH, ExtFileHandlerBase::Recv_post(), ExtFileHandlerBase::Recv_pre(), and Converged::Set().

Referenced by ModalMappingExt::AssRes(), StructExtForce::AssRes(), StructMappingExtForce::AssRes(), and ModalExt::AssRes().

 {
         if ((iCoupling >= COUPLING_TIGHT && !bFirstSend && !(iCouplingCounter%iCoupling))
                 || ((iCoupling == COUPLING_LOOSE || iCoupling == COUPLING_STAGGERED) && bFirstRecv))
         {
                 if (pEFH->Recv_pre()) {
                         Recv(pEFH);
                         bFirstRecv = false;
                 }
 
                 if (pEFH->Recv_post()) {
                         // TODO: need to handle requests for end of simulation
                         c.Set(Converged::CONVERGED);
                 }
         }
 
         if (iCoupling == COUPLING_NONE) {
                 c.Set(Converged::CONVERGED);
         }
 }

Here is the call graph for this function:

virtual void ExtForce::Recv ( ExtFileHandlerBase * pEFH )

protectedpure virtual

Implemented in ModalExt, StructMappingExtForce, StructExtForce, and ModalMappingExt.

void ExtForce::Send ( ExtFileHandlerBase::SendWhen when )

protected

Definition at line 788 of file extforce.cc.

References bFirstSend, pEFH, ExtFileHandlerBase::Send_post(), and ExtFileHandlerBase::Send_pre().

Referenced by AfterConvergence(), SetValue(), and Update().

 {
         if (pEFH->Send_pre(when)) {
                 Send(pEFH, when);
                 bFirstSend = false;
         }
         pEFH->Send_post(when);
 }

Here is the call graph for this function:

virtual void ExtForce::Send	(	ExtFileHandlerBase *	pEFH,
		ExtFileHandlerBase::SendWhen	when
	)

protectedpure virtual

Implemented in ModalExt, StructMappingExtForce, StructExtForce, and ModalMappingExt.

void ExtForce::SetValue	(	DataManager *	pDM,
		VectorHandler &	X,
		VectorHandler &	XP,
		SimulationEntity::Hints *	h = `0`
	)

virtual

Reimplemented from SimulationEntity.

Definition at line 704 of file extforce.cc.

References bFirstRecv, bFirstSend, COUPLING_TIGHT, iCoupling, MBDYN_EXCEPT_ARGS, pEFH, Prepare(), ExtFileHandlerBase::Prepare_post(), ExtFileHandlerBase::Prepare_pre(), Send(), and ExtFileHandlerBase::SEND_AFTER_CONVERGENCE.

 {
         bFirstSend = true;
         bFirstRecv = true;
 
         bool ok = false;
         if (pEFH->Prepare_pre()) {
                 ok = Prepare(pEFH);
         }
         pEFH->Prepare_post(ok);
         if (!ok) {
                 throw ErrGeneric(MBDYN_EXCEPT_ARGS);
         }
 
         if (iCoupling < COUPLING_TIGHT) {
                 Send(ExtFileHandlerBase::SEND_AFTER_CONVERGENCE);
         }
 }

Here is the call graph for this function:

void ExtForce::Update	(	const VectorHandler &	XCurr,
		const VectorHandler &	XPrimeCurr
	)

virtual

Reimplemented from SimulationEntity.

Definition at line 726 of file extforce.cc.

References bFirstSend, bSendAfterPredict, COUPLING_LOOSE, COUPLING_TIGHT, iCoupling, iCouplingCounter, Send(), ExtFileHandlerBase::SEND_AFTER_CONVERGENCE, ExtFileHandlerBase::SEND_FIRST_TIME, and ExtFileHandlerBase::SEND_REGULAR.

Referenced by AfterPredict().

 {
         /* If running tight coupling, send kinematics every iteration */
         /* NOTE: tight coupling may need relaxation */
         if ((iCoupling >= COUPLING_TIGHT && !((++iCouplingCounter)%iCoupling))
                 || (iCoupling == COUPLING_LOOSE && bSendAfterPredict))
         {
                 ExtFileHandlerBase::SendWhen when;
                 if (iCoupling == COUPLING_LOOSE) {
                         when = ExtFileHandlerBase::SEND_AFTER_CONVERGENCE;
                 } else if (bFirstSend) {
                         when = ExtFileHandlerBase::SEND_FIRST_TIME;
                 } else {
                         when = ExtFileHandlerBase::SEND_REGULAR;
                 }
 
                 Send(when);
         }
 }