sofa::simulation::MechanicalComputeEnergyVisitor Class Reference

Compute the amount of mechanical energy. More...

#include <MechanicalComputeEnergyVisitor.h>

Inheritance diagram for sofa::simulation::MechanicalComputeEnergyVisitor:

[legend]

Collaboration diagram for sofa::simulation::MechanicalComputeEnergyVisitor:

[legend]

Public Member Functions
	MechanicalComputeEnergyVisitor ()
	~MechanicalComputeEnergyVisitor ()
double	getKineticEnergy ()
double	getPotentialEnergy ()
virtual Result	fwdMass (simulation::Node *, core::componentmodel::behavior::BaseMass *mass)
	Process the BaseMass.
virtual Result	fwdForceField (simulation::Node *, core::componentmodel::behavior::BaseForceField *f)
	Process the BaseForceField.
Private Attributes
SReal	m_kineticEnergy
SReal	m_potentialEnergy

---

Detailed Description

Compute the amount of mechanical energy.

Author:

Francois Faure

Definition at line 53 of file MechanicalComputeEnergyVisitor.h.

---

Constructor & Destructor Documentation

sofa::simulation::MechanicalComputeEnergyVisitor::MechanicalComputeEnergyVisitor

(

)

Definition at line 45 of file MechanicalComputeEnergyVisitor.cpp.

sofa::simulation::MechanicalComputeEnergyVisitor::~MechanicalComputeEnergyVisitor

(

)

Definition at line 53 of file MechanicalComputeEnergyVisitor.cpp.

---

Member Function Documentation

Visitor::Result sofa::simulation::MechanicalComputeEnergyVisitor::fwdForceField	(	simulation::Node *	,
		core::componentmodel::behavior::BaseForceField *	f
	)			[virtual]

Process the BaseForceField.

Reimplemented from sofa::simulation::MechanicalVisitor.

Definition at line 75 of file MechanicalComputeEnergyVisitor.cpp.

References sofa::core::componentmodel::behavior::BaseForceField::getPotentialEnergy(), m_potentialEnergy, and sofa::simulation::Visitor::RESULT_CONTINUE.

Visitor::Result sofa::simulation::MechanicalComputeEnergyVisitor::fwdMass	(	simulation::Node *	,
		core::componentmodel::behavior::BaseMass *	mass
	)			[virtual]

Process the BaseMass.

Reimplemented from sofa::simulation::MechanicalVisitor.

Definition at line 69 of file MechanicalComputeEnergyVisitor.cpp.

References sofa::core::componentmodel::behavior::BaseMass::getKineticEnergy(), m_kineticEnergy, and sofa::simulation::Visitor::RESULT_CONTINUE.

double sofa::simulation::MechanicalComputeEnergyVisitor::getKineticEnergy

(

)

Definition at line 57 of file MechanicalComputeEnergyVisitor.cpp.

References m_kineticEnergy.

double sofa::simulation::MechanicalComputeEnergyVisitor::getPotentialEnergy

(

)

Definition at line 62 of file MechanicalComputeEnergyVisitor.cpp.

References m_potentialEnergy.

---

Field Documentation

SReal sofa::simulation::MechanicalComputeEnergyVisitor::m_kineticEnergy [private]

Definition at line 55 of file MechanicalComputeEnergyVisitor.h.

Referenced by fwdMass(), and getKineticEnergy().

SReal sofa::simulation::MechanicalComputeEnergyVisitor::m_potentialEnergy [private]

Definition at line 56 of file MechanicalComputeEnergyVisitor.h.

Referenced by fwdForceField(), and getPotentialEnergy().

---

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

• modules/sofa/simulation/common/MechanicalComputeEnergyVisitor.h
• modules/sofa/simulation/common/MechanicalComputeEnergyVisitor.cpp