sofa::component::forcefield::ConstantForceField< DataTypes > Class Template Reference
Apply constant forces to given degrees of freedom. More...
#include <ConstantForceField.h>
Public Types | |
| typedef core::componentmodel::behavior::ForceField < DataTypes > | Inherit |
| typedef DataTypes::VecCoord | VecCoord |
| typedef DataTypes::VecDeriv | VecDeriv |
| typedef DataTypes::Coord | Coord |
| typedef DataTypes::Deriv | Deriv |
| typedef Coord::value_type | Real |
| typedef helper::vector< unsigned > | VecIndex |
Public Member Functions | |
| ConstantForceField () | |
| virtual void | addForce (VecDeriv &f, const VecCoord &x, const VecDeriv &v) |
| Add the forces. | |
| virtual void | addDForce (VecDeriv &, const VecDeriv &) |
| Constant force has null variation. | |
| virtual double | getPotentialEnergy (const VecCoord &x) |
| Get the potential energy associated to this ForceField. | |
| void | draw () |
| Render internal data of this object, for debugging purposes. | |
| bool | addBBox (double *minBBox, double *maxBBox) |
| template<> | |
| double | getPotentialEnergy (const VecCoord &) |
| Get the potential energy associated to this ForceField. | |
| template<> | |
| double | getPotentialEnergy (const VecCoord &) |
| Get the potential energy associated to this ForceField. | |
| template<> | |
| double | getPotentialEnergy (const VecCoord &) |
| Get the potential energy associated to this ForceField. | |
| template<> | |
| double | getPotentialEnergy (const VecCoord &) |
| Get the potential energy associated to this ForceField. | |
| template<> | |
| double | getPotentialEnergy (const VecCoord &) |
| Get the potential energy associated to this ForceField. | |
| template<> | |
| double | getPotentialEnergy (const VecCoord &) |
| Get the potential energy associated to this ForceField. | |
| template<> | |
| double | getPotentialEnergy (const VecCoord &) |
| Get the potential energy associated to this ForceField. | |
| template<> | |
| double | getPotentialEnergy (const VecCoord &) |
| Get the potential energy associated to this ForceField. | |
Data Fields | |
| Data< VecIndex > | points |
| Data< VecDeriv > | forces |
Detailed Description
template<class DataTypes>
class sofa::component::forcefield::ConstantForceField< DataTypes >
Apply constant forces to given degrees of freedom.
Definition at line 44 of file ConstantForceField.h.
Member Typedef Documentation
| typedef DataTypes::Coord sofa::component::forcefield::ConstantForceField< DataTypes >::Coord |
Reimplemented from sofa::core::componentmodel::behavior::ForceField< DataTypes >.
Definition at line 50 of file ConstantForceField.h.
| typedef DataTypes::Deriv sofa::component::forcefield::ConstantForceField< DataTypes >::Deriv |
Reimplemented from sofa::core::componentmodel::behavior::ForceField< DataTypes >.
Reimplemented in sofa::component::forcefield::BoxConstantForceField< DataTypes >.
Definition at line 51 of file ConstantForceField.h.
| typedef core::componentmodel::behavior::ForceField<DataTypes> sofa::component::forcefield::ConstantForceField< DataTypes >::Inherit |
Definition at line 47 of file ConstantForceField.h.
| typedef Coord::value_type sofa::component::forcefield::ConstantForceField< DataTypes >::Real |
Reimplemented in sofa::component::forcefield::BoxConstantForceField< DataTypes >.
Definition at line 52 of file ConstantForceField.h.
| typedef DataTypes::VecCoord sofa::component::forcefield::ConstantForceField< DataTypes >::VecCoord |
Reimplemented from sofa::core::componentmodel::behavior::ForceField< DataTypes >.
Definition at line 48 of file ConstantForceField.h.
| typedef DataTypes::VecDeriv sofa::component::forcefield::ConstantForceField< DataTypes >::VecDeriv |
Reimplemented from sofa::core::componentmodel::behavior::ForceField< DataTypes >.
Definition at line 49 of file ConstantForceField.h.
| typedef helper::vector<unsigned> sofa::component::forcefield::ConstantForceField< DataTypes >::VecIndex |
Definition at line 53 of file ConstantForceField.h.
Constructor & Destructor Documentation
| sofa::component::forcefield::ConstantForceField< DataTypes >::ConstantForceField | ( | ) | [inline] |
Definition at line 50 of file ConstantForceField.inl.
Member Function Documentation
| bool sofa::component::forcefield::ConstantForceField< DataTypes >::addBBox | ( | double * | minBBox, | |
| double * | maxBBox | |||
| ) | [inline] |
Definition at line 122 of file ConstantForceField.inl.
| virtual void sofa::component::forcefield::ConstantForceField< DataTypes >::addDForce | ( | VecDeriv & | , | |
| const VecDeriv & | ||||
| ) | [inline, virtual] |
Constant force has null variation.
Reimplemented from sofa::core::componentmodel::behavior::ForceField< DataTypes >.
Definition at line 65 of file ConstantForceField.h.
| void sofa::component::forcefield::ConstantForceField< DataTypes >::addForce | ( | VecDeriv & | f, | |
| const VecCoord & | x, | |||
| const VecDeriv & | v | |||
| ) | [inline, virtual] |
Add the forces.
Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.
Definition at line 57 of file ConstantForceField.inl.
References sofa::component::forcefield::ConstantForceField< DataTypes >::forces, and sofa::component::forcefield::ConstantForceField< DataTypes >::points.
| void sofa::component::forcefield::ConstantForceField< DataTypes >::draw | ( | ) | [inline, virtual] |
Render internal data of this object, for debugging purposes.
Reimplemented from sofa::core::objectmodel::BaseObject.
Definition at line 100 of file ConstantForceField.inl.
References sofa::component::forcefield::ConstantForceField< DataTypes >::forces, ftl::Type::get(), sofa::core::objectmodel::BaseObject::getContext(), sofa::core::componentmodel::behavior::MechanicalState< TDataTypes >::getX(), sofa::core::componentmodel::behavior::ForceField< DataTypes >::mstate, and sofa::component::forcefield::ConstantForceField< DataTypes >::points.
| double sofa::component::forcefield::ConstantForceField< defaulttype::Rigid2fTypes >::getPotentialEnergy | ( | const VecCoord & | x | ) | [inline, virtual] |
Get the potential energy associated to this ForceField.
Used to extimate the total energy of the system by some post-stabilization techniques.
This method must be implemented by the component, and is usually called by the generic ForceField::getPotentialEnergy() method.
Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.
| double sofa::component::forcefield::ConstantForceField< defaulttype::Rigid3fTypes >::getPotentialEnergy | ( | const VecCoord & | x | ) | [inline, virtual] |
Get the potential energy associated to this ForceField.
Used to extimate the total energy of the system by some post-stabilization techniques.
This method must be implemented by the component, and is usually called by the generic ForceField::getPotentialEnergy() method.
Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.
| double sofa::component::forcefield::ConstantForceField< defaulttype::Rigid2dTypes >::getPotentialEnergy | ( | const VecCoord & | x | ) | [inline, virtual] |
Get the potential energy associated to this ForceField.
Used to extimate the total energy of the system by some post-stabilization techniques.
This method must be implemented by the component, and is usually called by the generic ForceField::getPotentialEnergy() method.
Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.
| double sofa::component::forcefield::ConstantForceField< defaulttype::Rigid3dTypes >::getPotentialEnergy | ( | const VecCoord & | x | ) | [inline, virtual] |
Get the potential energy associated to this ForceField.
Used to extimate the total energy of the system by some post-stabilization techniques.
This method must be implemented by the component, and is usually called by the generic ForceField::getPotentialEnergy() method.
Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.
| double sofa::component::forcefield::ConstantForceField< Rigid2fTypes >::getPotentialEnergy | ( | const VecCoord & | x | ) | [inline, virtual] |
Get the potential energy associated to this ForceField.
Used to extimate the total energy of the system by some post-stabilization techniques.
This method must be implemented by the component, and is usually called by the generic ForceField::getPotentialEnergy() method.
Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.
Definition at line 101 of file ConstantForceField.cpp.
| double sofa::component::forcefield::ConstantForceField< Rigid3fTypes >::getPotentialEnergy | ( | const VecCoord & | x | ) | [inline, virtual] |
Get the potential energy associated to this ForceField.
Used to extimate the total energy of the system by some post-stabilization techniques.
This method must be implemented by the component, and is usually called by the generic ForceField::getPotentialEnergy() method.
Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.
Definition at line 94 of file ConstantForceField.cpp.
| double sofa::component::forcefield::ConstantForceField< Rigid2dTypes >::getPotentialEnergy | ( | const VecCoord & | x | ) | [inline, virtual] |
Get the potential energy associated to this ForceField.
Used to extimate the total energy of the system by some post-stabilization techniques.
This method must be implemented by the component, and is usually called by the generic ForceField::getPotentialEnergy() method.
Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.
Definition at line 85 of file ConstantForceField.cpp.
| double sofa::component::forcefield::ConstantForceField< Rigid3dTypes >::getPotentialEnergy | ( | const VecCoord & | x | ) | [inline, virtual] |
Get the potential energy associated to this ForceField.
Used to extimate the total energy of the system by some post-stabilization techniques.
This method must be implemented by the component, and is usually called by the generic ForceField::getPotentialEnergy() method.
Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.
Definition at line 79 of file ConstantForceField.cpp.
| double sofa::component::forcefield::ConstantForceField< DataTypes >::getPotentialEnergy | ( | const VecCoord & | x | ) | [inline, virtual] |
Get the potential energy associated to this ForceField.
Used to extimate the total energy of the system by some post-stabilization techniques.
This method must be implemented by the component, and is usually called by the generic ForceField::getPotentialEnergy() method.
Implements sofa::core::componentmodel::behavior::ForceField< DataTypes >.
Definition at line 71 of file ConstantForceField.inl.
References sofa::component::forcefield::ConstantForceField< DataTypes >::forces, and sofa::component::forcefield::ConstantForceField< DataTypes >::points.
Field Documentation
| Data< VecDeriv > sofa::component::forcefield::ConstantForceField< DataTypes >::forces |
Definition at line 57 of file ConstantForceField.h.
Referenced by sofa::component::forcefield::ConstantForceField< DataTypes >::addForce(), sofa::component::forcefield::ConstantForceField< DataTypes >::draw(), sofa::component::forcefield::ConstantForceField< DataTypes >::getPotentialEnergy(), and sofa::component::forcefield::BoxConstantForceField< DataTypes >::init().
| Data< VecIndex > sofa::component::forcefield::ConstantForceField< DataTypes >::points |
Definition at line 56 of file ConstantForceField.h.
Referenced by sofa::component::forcefield::ConstantForceField< DataTypes >::addForce(), sofa::component::forcefield::ConstantForceField< DataTypes >::draw(), sofa::component::forcefield::ConstantForceField< DataTypes >::getPotentialEnergy(), and sofa::component::forcefield::BoxConstantForceField< DataTypes >::init().
The documentation for this class was generated from the following files:
- modules/sofa/component/forcefield/ConstantForceField.h
- modules/sofa/component/forcefield/ConstantForceField.inl
