Inheritance diagram for ModuleTemplate:

Collaboration diagram for ModuleTemplate:

Public Member Functions
	ModuleTemplate (unsigned uLabel, const DofOwner pDO, DataManager pDM, MBDynParser &HP)

virtual	~ModuleTemplate (void)

virtual void	Output (OutputHandler &OH) const

virtual void	WorkSpaceDim (integer piNumRows, integer piNumCols) const

VariableSubMatrixHandler &	AssJac (VariableSubMatrixHandler &WorkMat, doublereal dCoef, const VectorHandler &XCurr, const VectorHandler &XPrimeCurr)

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

unsigned int	iGetNumPrivData (void) const

int	iGetNumConnectedNodes (void) const

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

void	SetValue (DataManager pDM, VectorHandler &X, VectorHandler &XP, SimulationEntity::Hints ph)

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

virtual unsigned int	iGetInitialNumDof (void) const

virtual void	InitialWorkSpaceDim (integer piNumRows, integer piNumCols) const

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

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	AssMats (VariableSubMatrixHandler &WorkMatA, VariableSubMatrixHandler &WorkMatB, const VectorHandler &XCurr, const VectorHandler &XPrimeCurr)

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

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	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 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 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 UserDefinedElem
	UserDefinedElem (unsigned uLabel, const DofOwner *pDO)

virtual	~UserDefinedElem (void)

bool	NeedsAirProperties (void) const

void	NeedsAirProperties (bool yesno)

virtual Elem::Type	GetElemType (void) const

virtual AerodynamicElem::Type	GetAerodynamicElemType (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)

Public Member Functions inherited from AerodynamicElem
	AerodynamicElem (unsigned int uL, const DofOwner *pDO, flag fOut)

virtual	~AerodynamicElem (void)

virtual const InducedVelocity *	pGetInducedVelocity (void) const

Public Member Functions inherited from ElemWithDofs
	ElemWithDofs (unsigned int uL, const DofOwner *pDO, flag fOut)

virtual	~ElemWithDofs (void)

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 AirPropOwner
	AirPropOwner (void)

virtual	~AirPropOwner (void)

virtual void	PutAirProperties (const AirProperties *pAP)

virtual flag	fGetAirVelocity (Vec3 &Velocity, const Vec3 &X) const

virtual doublereal	dGetAirDensity (const Vec3 &X) const

virtual doublereal	dGetAirPressure (const Vec3 &X) const

virtual doublereal	dGetAirTemperature (const Vec3 &X) const

virtual doublereal	dGetSoundSpeed (const Vec3 &X) const

virtual bool	GetAirProps (const Vec3 &X, doublereal &rho, doublereal &c, doublereal &p, doublereal &T) const

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

virtual	~ElemGravityOwner (void)

virtual doublereal	dGetM (void) const

Vec3	GetS (void) const

Mat3x3	GetJ (void) const

Vec3	GetB (void) const

Vec3	GetG (void) const

Public Member Functions inherited from GravityOwner
	GravityOwner (void)

virtual	~GravityOwner (void)

void	PutGravity (const Gravity *pG)

virtual bool	bGetGravity (const Vec3 &X, Vec3 &Acc) const

Additional Inherited Members
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 AerodynamicElem
enum	Type { UNKNOWN = -1, INDUCEDVELOCITY = 0, AEROMODAL, AERODYNAMICBODY, AERODYNAMICBEAM, AERODYNAMICEXTERNAL, AERODYNAMICEXTERNALMODAL, AERODYNAMICLOADABLE, AIRCRAFTINSTRUMENTS, GENERICFORCE, LASTAEROTYPE }

Protected Member Functions inherited from ElemGravityOwner
virtual Vec3	GetS_int (void) const

virtual Mat3x3	GetJ_int (void) const

virtual Vec3	GetB_int (void) const

virtual Vec3	GetG_int (void) const

Protected Attributes inherited from WithLabel
unsigned int	uLabel

std::string	sName

Protected Attributes inherited from ToBeOutput
flag	fOutput

Protected Attributes inherited from UserDefinedElem
bool	needsAirProperties

Protected Attributes inherited from AirPropOwner
const AirProperties *	pAirProperties

Protected Attributes inherited from GravityOwner
Gravity *	pGravity

Detailed Description

Definition at line 39 of file module-template2.cc.

Constructor & Destructor Documentation

ModuleTemplate::ModuleTemplate	(	unsigned	uLabel,
		const DofOwner *	pDO,
		DataManager *	pDM,
		MBDynParser &	HP
	)

Definition at line 77 of file module-template2.cc.

References HighParser::IsArg(), HighParser::IsKeyWord(), and MBDYN_EXCEPT_ARGS.

 : Elem(uLabel, flag(0)),
 UserDefinedElem(uLabel, pDO)
 {
         // help
         if (HP.IsKeyWord("help")) {
                 silent_cout(
 "                                                                       \n"
 "Module:        template2                                               \n"
 "Author:        Pierangelo Masarati <masarati@aero.polimi.it>           \n"
 "Organization:  Dipartimento di Ingegneria Aerospaziale                 \n"
 "               Politecnico di Milano                                   \n"
 "               http://www.aero.polimi.it/                              \n"
 "                                                                       \n"
 "       All rights reserved                                             \n"
                         << std::endl);
 
                 if (!HP.IsArg()) {
                         /*
                          * Exit quietly if nothing else is provided
                          */
                         throw NoErr(MBDYN_EXCEPT_ARGS);
                 }
         }
 
         // do something useful
 }

Here is the call graph for this function:

ModuleTemplate::~ModuleTemplate ( void )

virtual

Definition at line 107 of file module-template2.cc.

References NO_OP.

 {
         // destroy private data
         NO_OP;
 }

Member Function Documentation

VariableSubMatrixHandler & ModuleTemplate::AssJac	(	VariableSubMatrixHandler &	WorkMat,
		doublereal	dCoef,
		const VectorHandler &	XCurr,
		const VectorHandler &	XPrimeCurr
	)

virtual

Implements Elem.

Definition at line 128 of file module-template2.cc.

References VariableSubMatrixHandler::SetNullMatrix().

 {
         // should do something useful
         WorkMat.SetNullMatrix();
 
         return WorkMat;
 }

Here is the call graph for this function:

SubVectorHandler & ModuleTemplate::AssRes	(	SubVectorHandler &	WorkVec,
		doublereal	dCoef,
		const VectorHandler &	XCurr,
		const VectorHandler &	XPrimeCurr
	)

virtual

Implements Elem.

Definition at line 140 of file module-template2.cc.

References VectorHandler::ResizeReset().

 {
         // should do something useful
         WorkVec.ResizeReset(0);
 
         return WorkVec;
 }

Here is the call graph for this function:

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

virtual

Reimplemented from Elem.

Definition at line 164 of file module-template2.cc.

 {
         connectedNodes.resize(0);
 }

unsigned int ModuleTemplate::iGetInitialNumDof ( void ) const

virtual

Implements SubjectToInitialAssembly.

Definition at line 184 of file module-template2.cc.

 {
         return 0;
 }

int ModuleTemplate::iGetNumConnectedNodes ( void ) const

Definition at line 158 of file module-template2.cc.

 {
         return 0;
 }

unsigned int ModuleTemplate::iGetNumPrivData ( void ) const

virtual

Reimplemented from SimulationEntity.

Definition at line 152 of file module-template2.cc.

 {
         return 0;
 }

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

virtual

Implements SubjectToInitialAssembly.

Definition at line 199 of file module-template2.cc.

References ASSERT, and VariableSubMatrixHandler::SetNullMatrix().

 {
         // should not be called, since initial workspace is empty
         ASSERT(0);
 
         WorkMat.SetNullMatrix();
 
         return WorkMat;
 }

Here is the call graph for this function:

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

virtual

Implements SubjectToInitialAssembly.

Definition at line 212 of file module-template2.cc.

References ASSERT, and VectorHandler::ResizeReset().

 {
         // should not be called, since initial workspace is empty
         ASSERT(0);
 
         WorkVec.ResizeReset(0);
 
         return WorkVec;
 }

Here is the call graph for this function:

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

virtual

Implements SubjectToInitialAssembly.

Definition at line 190 of file module-template2.cc.

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

void ModuleTemplate::Output ( OutputHandler & OH ) const

virtual

Reimplemented from ToBeOutput.

Definition at line 114 of file module-template2.cc.

References NO_OP.

 {
         // should do something useful
         NO_OP;
 }

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

virtual

Implements Elem.

Definition at line 178 of file module-template2.cc.

 {
         return out << "# ModuleTemplate: not implemented" << std::endl;
 }

void ModuleTemplate::SetValue	(	DataManager *	pDM,
		VectorHandler &	X,
		VectorHandler &	XP,
		SimulationEntity::Hints *	ph
	)

virtual

Reimplemented from SimulationEntity.

Definition at line 170 of file module-template2.cc.

References NO_OP.

 {
         NO_OP;
 }

void ModuleTemplate::WorkSpaceDim	(	integer *	piNumRows,
		integer *	piNumCols
	)		const

virtual

Implements Elem.

Definition at line 121 of file module-template2.cc.

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

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

module-template2.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation