MULTIBODY SIMULATION SOFTWARE - API documentation

chrono::ChForce Class Reference

#include <CHforce.h>

Inheritance diagram for chrono::ChForce:

[legend]

Collaboration diagram for chrono::ChForce:

[legend]

List of all members.

Public Member Functions
void	Copy (ChForce *source)
ChBody *	GetBody ()
void	SetBody (ChBody *newRB)
void	SetMode (int m_mode)
int	GetMode ()
void	SetAlign (int m_align)
int	GetAlign ()
void	SetFrame (int m_frame)
int	GetFrame ()
Vector	GetVpoint ()
Vector	GetVrelpoint ()
void	SetVpoint (Vector mypoint)
void	SetVrelpoint (Vector myrelpoint)
Vector	GetDir ()
Vector	GetRelDir ()
void	SetDir (Vector newf)
void	SetRelDir (Vector newf)
void	SetMforce (double newf)
double	GetMforce ()
void	SetModulation (ChFunction *m_funct)
ChFunction *	GetModulation ()
void	SetMove_x (ChFunction *m_funct)
ChFunction *	GetMove_x ()
void	SetMove_y (ChFunction *m_funct)
ChFunction *	GetMove_y ()
void	SetMove_z (ChFunction *m_funct)
ChFunction *	GetMove_z ()
void	SetF_x (ChFunction *m_funct)
ChFunction *	GetF_x ()
void	SetF_y (ChFunction *m_funct)
ChFunction *	GetF_y ()
void	SetF_z (ChFunction *m_funct)
ChFunction *	GetF_z ()
Vector	GetForce ()
Vector	GetRelForce ()
double	GetForceMod ()
ChMatrix *	GetQf ()
void	GetBodyForceTorque (Vector *body_force, Vector *body_torque)
void	UpdateTime (double mytime)
void	UpdateState ()
void	Update (double mytime)
void	UpdateExternalGeometry ()
void	StreamOUT (ChStreamOutAscii &mstream)
void	StreamIN (ChStreamInBinary &mstream)
void	StreamOUT (ChStreamOutBinary &mstream)

---

Detailed Description

Forces are objects which must be attached to rigid bodies in order to apply torque or force to such body. ChForce objects are able to represent either forces and torques, depending on a flag.

---

Member Function Documentation

ChBody* chrono::ChForce::GetBody

(

)

Return the parent body (the force belongs to this rigid body).

void chrono::ChForce::SetBody

(

ChBody *

newRB

)

Sets the parent body (the force belongs to this rigid body).

void chrono::ChForce::SetMode

(

int

m_mode

)

Sets the mode: FTYPE_FORCE or FTYPE_TORQUE.

void chrono::ChForce::SetAlign

(

int

m_align

)

Sets the alignment method: FDIR_BODY or FDIR_WORLD. (the force will rotate together with this reference.

void chrono::ChForce::SetFrame

(

int

m_frame

)

Sets the alignment method: FPOS_BODY or FPOS_WORLD. (the force application point will follow this reference)

Vector chrono::ChForce::GetVpoint

(

)

Gets the application point, in absolute coordinates.

Vector chrono::ChForce::GetVrelpoint

(

)

Gets the application point, in rigid body coordinates.

void chrono::ChForce::SetVpoint

(

Vector

mypoint

)

Gets the application point, in absolute coordinates.

void chrono::ChForce::SetVrelpoint

(

Vector

myrelpoint

)

Gets the application point, in rigid body coordinates.

Vector chrono::ChForce::GetDir

(

)

Gets the force (or torque) direction, in absolute coordinates.

Vector chrono::ChForce::GetRelDir

(

)

Gets the force (or torque) direction, in rigid body coordinates.

void chrono::ChForce::SetDir

(

Vector

newf

)

Sets the force (or torque) direction, in absolute coordinates.

void chrono::ChForce::SetRelDir

(

Vector

newf

)

Sets the force (or torque) direction, in rigid body coordinates.

void chrono::ChForce::SetMforce

(

double

newf

)

Sets force (or torque) modulus.

double chrono::ChForce::GetMforce

(

)

Gets force (or torque) modulus.

void chrono::ChForce::SetModulation

(

ChFunction *

m_funct

)

Sets a f(t) function for time-modulation of the force.

void chrono::ChForce::SetMove_x

(

ChFunction *

m_funct

)

Sets a f(t) function for time dependency of position (on x axis).

void chrono::ChForce::SetMove_y

(

ChFunction *

m_funct

)

Sets a f(t) function for time dependency of position (on y axis).

void chrono::ChForce::SetMove_z

(

ChFunction *

m_funct

)

Sets a f(t) function for time dependency of position (on z axis).

void chrono::ChForce::SetF_x

(

ChFunction *

m_funct

)

Sets a f(t) function for time dependency of force X component.

void chrono::ChForce::SetF_y

(

ChFunction *

m_funct

)

Sets a f(t) function for time dependency of force Y component.

void chrono::ChForce::SetF_z

(

ChFunction *

m_funct

)

Sets a f(t) function for time dependency of force Z component.

Vector chrono::ChForce::GetForce

(

)

Gets the instant force vector -or torque vector- in absolute coordinates.

Vector chrono::ChForce::GetRelForce

(

)

Gets the instant force vector -or torque vector- in rigid body coordinates.

double chrono::ChForce::GetForceMod

(

)

Gets the instant force vector -or torque vector- modulus.

ChMatrix* chrono::ChForce::GetQf

(

)

Gets force-torque applied to rigid body, as lagrangian generalized force (7x1 matrix).

void chrono::ChForce::GetBodyForceTorque	(	Vector *	body_force,
		Vector *	body_torque
	)

Gets force-torque applied to rigid body, as force vector (in absol.coords) and torque vector (in body coords).

void chrono::ChForce::UpdateExternalGeometry

(

)

Tells to the associated external object ChExternalObject() ,if any, that its 3D shape must be updated in order to syncronize to ChForce coordinates

void chrono::ChForce::StreamOUT

(

ChStreamOutAscii &

mstream

)

[virtual]

Method to allow serialization of transient data in ascii, as a readable item, for example "chrono::GetLog() << myobject;"

Reimplemented from chrono::ChObj.

void chrono::ChForce::StreamIN

(

ChStreamInBinary &

mstream

)

[virtual]

Method to allow deserializing a persistent binary archive (ex: a file) into transient data.

Reimplemented from chrono::ChObj.

void chrono::ChForce::StreamOUT

(

ChStreamOutBinary &

mstream

)

[virtual]

Method to allow serializing transient data into a persistent binary archive (ex: a file).

Reimplemented from chrono::ChObj.

---

CHRONO::ENGINE
C++ library for multibody simulation, (C) Alessandro Tasora
This API documentation has been generated on 17 Jul 2009 by Doxygen