Node Class Reference

#include <node.h>

Inheritance diagram for Node:

Collaboration diagram for Node:

Classes
class	ErrGeneric

Public Types
enum	Type {   UNKNOWN = -1, ABSTRACT = 0, STRUCTURAL, ELECTRIC,   THERMAL, PARAMETER, HYDRAULIC, LASTNODETYPE }
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 Member Functions
	Node (unsigned int uL, const DofOwner *pDO, flag fOut)
virtual	~Node (void)
const Node *	GetNode (void) const
virtual Node::Type	GetNodeType (void) const =0
virtual std::ostream &	Restart (std::ostream &out) const =0
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 integer	iGetFirstRowIndex (void) const
virtual integer	iGetFirstColIndex (void) const
virtual const doublereal &	dGetDofValue (int iDof, int iOrder=0) const =0
virtual const doublereal &	dGetDofValuePrev (int iDof, int iOrder=0) const =0
virtual void	SetDofValue (const doublereal &dValue, unsigned int iDof, unsigned int iOrder=0)=0
virtual unsigned int	iGetNumPrivData (void) const
virtual unsigned int	iGetPrivDataIdx (const char *s) const
virtual doublereal	dGetPrivData (unsigned int i) 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 unsigned int	iGetNumDof (void) const =0
virtual bool	bIsValidIndex (unsigned int i) const
virtual DofOrder::Order	GetDofType (unsigned int i) const =0
virtual DofOrder::Order	GetEqType (unsigned int i) const
virtual void	SetValue (DataManager *pDM, VectorHandler &X, VectorHandler &XP, SimulationEntity::Hints *h=0)
virtual Hint *	ParseHint (DataManager *pDM, const char *s) const
virtual void	BeforePredict (VectorHandler &, VectorHandler &, VectorHandler &, VectorHandler &) const
virtual void	AfterPredict (VectorHandler &X, VectorHandler &XP)
virtual void	Update (const VectorHandler &XCurr, const VectorHandler &XPrimeCurr)
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)
virtual void	AfterConvergence (const VectorHandler &X, const VectorHandler &XP, const VectorHandler &XPP)
virtual std::ostream &	OutputAppend (std::ostream &out) const
virtual void	ReadInitialState (MBDynParser &HP)
Public Member Functions inherited from DofOwnerOwner
	DofOwnerOwner (const DofOwner *pDO)
virtual	~DofOwnerOwner ()
virtual const DofOwner *	pGetDofOwner (void) const
virtual integer	iGetFirstIndex (void) const
virtual void	SetInitialValue (VectorHandler &X)
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))

Additional Inherited Members
Protected Attributes inherited from WithLabel
unsigned int	uLabel
std::string	sName
Protected Attributes inherited from ToBeOutput
flag	fOutput

Detailed Description

Definition at line 67 of file node.h.

Member Enumeration Documentation

enum Node::Type

Enumerator
UNKNOWN
ABSTRACT
STRUCTURAL
ELECTRIC
THERMAL
PARAMETER
HYDRAULIC
LASTNODETYPE

Definition at line 71 of file node.h.

                  {
                UNKNOWN = -1,

                /* Should be Node::SCALAR; keep using Node::ABSTRACT
                 * for backward compatibility */
                ABSTRACT = 0,

                STRUCTURAL,
                ELECTRIC,
                THERMAL,
                PARAMETER,
                HYDRAULIC,

                LASTNODETYPE
        };

Constructor & Destructor Documentation

Node::Node	(	unsigned int	uL,
		const DofOwner *	pDO,
		flag	fOut
	)

Definition at line 42 of file node.cc.

References NO_OP.

: WithLabel(uL), DofOwnerOwner(pDO), ToBeOutput(fOut)
{
        NO_OP;
}

Node::~Node ( void  )

virtual

Definition at line 49 of file node.cc.

References NO_OP.

{
        NO_OP;
}

Member Function Documentation

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

virtual

Implements SimulationEntity.

Reimplemented in ModalNode, DynamicStructNode, StructNode, DynamicStructDispNode, and StructDispNode.

Definition at line 55 of file node.cc.

{
        return out;
}

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

virtual

Implements SimulationEntity.

Reimplemented in ModalNode, DynamicStructNode, StructNode, DynamicStructDispNode, and StructDispNode.

Definition at line 61 of file node.cc.

References ASSERT.

{
        ASSERT(i <= 0);
        desc.resize(0);
}

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

virtual

Implements SimulationEntity.

Reimplemented in ModalNode, DynamicStructNode, StructNode, DynamicStructDispNode, and StructDispNode.

Definition at line 68 of file node.cc.

{
        return out;
}

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

virtual

Implements SimulationEntity.

Reimplemented in ModalNode, DynamicStructNode, StructNode, DynamicStructDispNode, and StructDispNode.

Definition at line 74 of file node.cc.

References ASSERT.

{
        ASSERT(i <= 0);
        desc.resize(0);
}

virtual const doublereal& Node::dGetDofValue ( int  iDof, int  iOrder = 0  ) const

pure virtual

Implemented in DummyStructNode, DynamicStructNode, StructNode, Node2Scalar, DynamicStructDispNode, ScalarAlgebraicNode, ScalarDifferentialNode, StructDispNode, StrainGageParam, and Elem2Param.

Referenced by GenelClamp::AssRes(), BulkSpringSupport::AssRes(), GenelDistance::AssRes(), GenelSpring::AssRes(), DofDriveCaller::dGet(), Node2Scalar::dGetDofValue(), dGetPrivData(), ScalarDof::dGetValue(), and GenelDistance::SetValue().

virtual const doublereal& Node::dGetDofValuePrev ( int  iDof, int  iOrder = 0  ) const

pure virtual

Implemented in DummyStructNode, DynamicStructNode, StructNode, Node2Scalar, DynamicStructDispNode, ScalarAlgebraicNode, ScalarDifferentialNode, and StructDispNode.

Referenced by Node2Scalar::dGetDofValuePrev(), and ScalarDof::dGetValuePrev().

virtual doublereal Node::dGetPrivData ( unsigned int  i ) const

inlinevirtual

Reimplemented from SimulationEntity.

Reimplemented in StructNode, ScalarDifferentialNode, and StructDispNode.

Definition at line 201 of file node.h.

References dGetDofValue().

                                                              {
                return dGetDofValue(i);
        };

Here is the call graph for this function:

const Node* Node::GetNode ( void  ) const

inline

Definition at line 111 of file node.h.

Referenced by DataManager::DofOwnerInit().

{ return this; };

virtual Node::Type Node::GetNodeType ( void  ) const

pure virtual

Implemented in Node2Scalar, ParameterNode, ScalarAlgebraicNode, ScalarDifferentialNode, StructDispNode, ElectricNode, PressureNode, and ThermalNode.

Referenced by DataManager::DofOwnerInit(), NodePrivPlugIn::Err(), GetDofOrder(), Node2Scalar::GetNodeType(), DofPlugIn::Read(), DofDCR::Read(), DofPlugIn::ReadDofOrder(), ReadGenel(), DofPlugIn::ReadIndex(), DofDriveCaller::Restart(), PrivDriveCaller::Restart(), AbstractForce::Restart(), AbstractInternalForce::Restart(), and ScalarDof::RestartScalarDofCaller().

integer Node::iGetFirstColIndex ( void  ) const

virtual

Reimplemented in Node2Scalar.

Definition at line 88 of file node.cc.

References DofOwnerOwner::iGetFirstIndex().

Referenced by ThermalCapacitance::AssJac(), ThermalSource::AssJac(), ThermalResistance::AssJac(), LinearAccelerationJoint::AssJac(), GenelClamp::AssJac(), MinorLoss::AssJac(), Pipe::AssJac(), Control_valve::AssJac(), GenelStateSpaceSISO::AssJac(), Actuator::AssJac(), Accumulator::AssJac(), BulkSpringSupport::AssJac(), RotorTrimBase::AssJac(), TranslAccel::AssJac(), GenelDistance::AssJac(), ThreeWayMinorLoss::AssJac(), AngularAccelerationJoint::AssJac(), Dynamic_pipe::AssJac(), GenelStateSpaceMIMO::AssJac(), Tank::AssJac(), RotAccel::AssJac(), GenelSpring::AssJac(), Orifice::AssJac(), GenelSpringSupport::AssJac(), DynamicPipe::AssJac(), Dynamic_control_valve::AssJac(), GenelCrossSpringSupport::AssJac(), GenelCrossSpringDamperSupport::AssJac(), Pressure_flow_control_valve::AssJac(), GenelSpringDamperSupport::AssJac(), GenelMass::AssJac(), Pressure_valve::AssJac(), Flow_valve::AssJac(), and Node2Scalar::iGetFirstColIndex().

{
        return iGetFirstIndex();
}

Here is the call graph for this function:

integer Node::iGetFirstRowIndex ( void  ) const

virtual

Reimplemented in ModalNode, DynamicStructNode, Node2Scalar, and DynamicStructDispNode.

Definition at line 82 of file node.cc.

References DofOwnerOwner::iGetFirstIndex().

Referenced by ThermalCapacitance::AssJac(), ThermalSource::AssJac(), ThermalResistance::AssJac(), LinearAccelerationJoint::AssJac(), GenelClamp::AssJac(), MinorLoss::AssJac(), Pipe::AssJac(), Control_valve::AssJac(), GenelStateSpaceSISO::AssJac(), Actuator::AssJac(), Accumulator::AssJac(), BulkSpringSupport::AssJac(), Motor::AssJac(), RotorTrimBase::AssJac(), GenelDistance::AssJac(), ThreeWayMinorLoss::AssJac(), AngularAccelerationJoint::AssJac(), Dynamic_pipe::AssJac(), GenelStateSpaceMIMO::AssJac(), Tank::AssJac(), GenelSpring::AssJac(), Orifice::AssJac(), GenelSpringSupport::AssJac(), DynamicPipe::AssJac(), Dynamic_control_valve::AssJac(), GenelCrossSpringSupport::AssJac(), GenelCrossSpringDamperSupport::AssJac(), Pressure_flow_control_valve::AssJac(), GenelSpringDamperSupport::AssJac(), GenelMass::AssJac(), Pressure_valve::AssJac(), Flow_valve::AssJac(), ThermalCapacitance::AssRes(), ThermalSource::AssRes(), ThermalResistance::AssRes(), LinearAccelerationJoint::AssRes(), MinorLoss::AssRes(), GenelClamp::AssRes(), Pipe::AssRes(), Control_valve::AssRes(), GenelStateSpaceSISO::AssRes(), Actuator::AssRes(), Accumulator::AssRes(), Motor::AssRes(), BulkSpringSupport::AssRes(), GenelDistance::AssRes(), ThreeWayMinorLoss::AssRes(), AngularAccelerationJoint::AssRes(), AbstractForce::AssRes(), Dynamic_pipe::AssRes(), GenelStateSpaceMIMO::AssRes(), Tank::AssRes(), Control_valve2::AssRes(), GenelSpring::AssRes(), Orifice::AssRes(), AbstractInternalForce::AssRes(), GenelSpringSupport::AssRes(), DynamicPipe::AssRes(), Dynamic_control_valve::AssRes(), GenelCrossSpringSupport::AssRes(), GenelCrossSpringDamperSupport::AssRes(), Pressure_flow_control_valve::AssRes(), GenelSpringDamperSupport::AssRes(), GenelMass::AssRes(), Pressure_valve::AssRes(), Flow_valve::AssRes(), Node2Scalar::iGetFirstRowIndex(), GenelClamp::SetValue(), and GenelDistance::SetValue().

{
        return iGetFirstIndex();
}

Here is the call graph for this function:

virtual unsigned int Node::iGetNumPrivData ( void  ) const

inlinevirtual

Reimplemented from SimulationEntity.

Reimplemented in StructNode, ParameterNode, ScalarDifferentialNode, and StructDispNode.

Definition at line 184 of file node.h.

References SimulationEntity::iGetNumDof().

                                                         {
                return iGetNumDof();
        };

Here is the call graph for this function:

virtual unsigned int Node::iGetPrivDataIdx ( const char *  s ) const

inlinevirtual

Reimplemented from SimulationEntity.

Reimplemented in StructNode, ScalarAlgebraicNode, ScalarDifferentialNode, and StructDispNode.

Definition at line 193 of file node.h.

                                                                  {
                return 0;
        };

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

pure virtual

Implemented in StructNode, Node2Scalar, ScalarAlgebraicNode, ScalarDifferentialNode, StructDispNode, StrainGageParam, SampleAndHold, and Elem2Param.

virtual void Node::SetDofValue ( const doublereal &  dValue, unsigned int  iDof, unsigned int  iOrder = 0  )

pure virtual

Implemented in DummyStructNode, DynamicStructNode, StructNode, Node2Scalar, DynamicStructDispNode, ScalarAlgebraicNode, ScalarDifferentialNode, StructDispNode, and Elem2Param.

---

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

• node.h
• node.cc