sofa::core::componentmodel::behavior::BaseMechanicalState::VecId Class Reference

Identify one vector stored in MechanicalState. More...

#include <BaseMechanicalState.h>

Collaboration diagram for sofa::core::componentmodel::behavior::BaseMechanicalState::VecId:

[legend]

Public Types
enum	{ V_FIRST_DYNAMIC_INDEX = 8 }
enum	Type { V_NULL = 0, V_COORD, V_DERIV, V_CONST }
Public Member Functions
	VecId (Type t, unsigned int i)
	VecId ()
bool	isNull () const
bool	operator== (const VecId &v) const
	Test if two VecId identify the same vector.
Static Public Member Functions
static VecId	null ()
static VecId	position ()
static VecId	restPosition ()
static VecId	velocity ()
static VecId	restVelocity ()
static VecId	force ()
static VecId	dx ()
static VecId	freePosition ()
static VecId	freeVelocity ()
static VecId	holonomicC ()
static VecId	nonHolonomicC ()
Data Fields
Type	type
unsigned int	index

---

Detailed Description

Identify one vector stored in MechanicalState.

Definition at line 146 of file BaseMechanicalState.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

V_FIRST_DYNAMIC_INDEX

Definition at line 149 of file BaseMechanicalState.h.

enum sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::Type

Enumerator:

V_NULL
V_COORD
V_DERIV
V_CONST

Definition at line 150 of file BaseMechanicalState.h.

---

Constructor & Destructor Documentation

sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::VecId	(	Type	t,
		unsigned int	i
	)			[inline]

Definition at line 159 of file BaseMechanicalState.h.

sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::VecId

(

)

[inline]

Definition at line 160 of file BaseMechanicalState.h.

Referenced by dx(), force(), freePosition(), freeVelocity(), holonomicC(), nonHolonomicC(), null(), position(), restPosition(), restVelocity(), and velocity().

---

Member Function Documentation

static VecId sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::dx

(

)

[inline, static]

Definition at line 168 of file BaseMechanicalState.h.

References V_DERIV, and VecId().

Referenced by sofa::component::MechanicalObject< DataTypes >::MechanicalObject(), sofa::component::odesolver::EulerSolver::solve(), and sofa::component::odesolver::MasterContactSolver::step().

static VecId sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::force

(

)

[inline, static]

Definition at line 167 of file BaseMechanicalState.h.

References V_DERIV, and VecId().

Referenced by sofa::simulation::OdeSolverImpl::computeAcc(), sofa::simulation::OdeSolverImpl::computeContactAcc(), sofa::component::MechanicalObject< DataTypes >::MechanicalObject(), sofa::component::odesolver::EulerSolver::solve(), sofa::component::odesolver::EulerImplicitSolver::solve(), and sofa::component::odesolver::CGImplicitSolver::solve().

static VecId sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::freePosition

(

)

[inline, static]

Definition at line 169 of file BaseMechanicalState.h.

References V_COORD, and VecId().

Referenced by sofa::component::MechanicalObject< DataTypes >::MechanicalObject(), and sofa::component::MechanicalObject< DataTypes >::reset().

static VecId sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::freeVelocity

(

)

[inline, static]

Definition at line 170 of file BaseMechanicalState.h.

References V_DERIV, and VecId().

Referenced by sofa::component::MechanicalObject< DataTypes >::MechanicalObject(), and sofa::component::MechanicalObject< DataTypes >::reset().

static VecId sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::holonomicC

(

)

[inline, static]

Definition at line 171 of file BaseMechanicalState.h.

References V_CONST, and VecId().

bool sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::isNull

(

)

const [inline]

Definition at line 161 of file BaseMechanicalState.h.

References type, and V_NULL.

Referenced by sofa::simulation::MechanicalAddMDxVisitor::fwdMechanicalMapping(), sofa::simulation::MechanicalAddMDxVisitor::fwdMechanicalState(), sofa::simulation::MatrixLinearSolver< Matrix, Vector >::solveSystem(), and sofa::component::MechanicalObject< DataTypes >::vOp().

static VecId sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::nonHolonomicC

(

)

[inline, static]

Definition at line 172 of file BaseMechanicalState.h.

References V_CONST, and VecId().

static VecId sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::null

(

)

[inline, static]

Definition at line 162 of file BaseMechanicalState.h.

References V_NULL, and VecId().

Referenced by sofa::core::componentmodel::behavior::PairInteractionForceField< TDataTypes >::addDForce(), sofa::simulation::SolverImpl::v_teq(), and sofa::core::componentmodel::behavior::BaseMechanicalState::vMultiOp().

bool sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::operator==

(

const VecId &

v

)

const [inline]

Test if two VecId identify the same vector.

Definition at line 175 of file BaseMechanicalState.h.

References index, and type.

static VecId sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::position

(

)

[inline, static]

Definition at line 163 of file BaseMechanicalState.h.

References V_COORD, and VecId().

Referenced by sofa::simulation::MechanicalIntegrationVisitor::fwdOdeSolver(), sofa::component::MechanicalObject< DataTypes >::MechanicalObject(), sofa::simulation::AnimateVisitor::processNodeTopDown(), sofa::component::MechanicalObject< DataTypes >::reset(), sofa::component::odesolver::StaticSolver::solve(), sofa::component::odesolver::RungeKutta4Solver::solve(), sofa::component::odesolver::RungeKutta2Solver::solve(), sofa::component::odesolver::EulerSolver::solve(), sofa::component::odesolver::EulerImplicitSolver::solve(), and sofa::component::odesolver::CGImplicitSolver::solve().

static VecId sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::restPosition

(

)

[inline, static]

Definition at line 164 of file BaseMechanicalState.h.

References V_COORD, and VecId().

Referenced by sofa::component::MechanicalObject< DataTypes >::MechanicalObject().

static VecId sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::restVelocity

(

)

[inline, static]

Definition at line 166 of file BaseMechanicalState.h.

References V_DERIV, and VecId().

static VecId sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::velocity

(

)

[inline, static]

Definition at line 165 of file BaseMechanicalState.h.

References V_DERIV, and VecId().

Referenced by sofa::simulation::MechanicalIntegrationVisitor::fwdOdeSolver(), sofa::component::MechanicalObject< DataTypes >::MechanicalObject(), sofa::simulation::AnimateVisitor::processNodeTopDown(), sofa::component::MechanicalObject< DataTypes >::reset(), sofa::component::odesolver::RungeKutta4Solver::solve(), sofa::component::odesolver::RungeKutta2Solver::solve(), sofa::component::odesolver::EulerSolver::solve(), sofa::component::odesolver::EulerImplicitSolver::solve(), sofa::component::odesolver::DampVelocitySolver::solve(), and sofa::component::odesolver::CGImplicitSolver::solve().

---

Field Documentation

unsigned int sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::index

Definition at line 158 of file BaseMechanicalState.h.

Referenced by sofa::component::MechanicalObject< DataTypes >::addBaseVectorToState(), sofa::core::componentmodel::behavior::PairInteractionForceField< TDataTypes >::addDForce(), sofa::core::componentmodel::behavior::MixedInteractionForceField< TDataTypes1, TDataTypes2 >::addDForce(), sofa::core::componentmodel::behavior::ForceField< TDataTypes >::addDForce(), sofa::component::MechanicalObject< DataTypes >::loadInBaseVector(), sofa::core::componentmodel::behavior::operator<<(), operator==(), sofa::component::MechanicalObject< DataTypes >::printDOF(), sofa::component::MechanicalObject< DataTypes >::printDOFWithElapsedTime(), sofa::component::MechanicalObject< DataTypes >::setC(), sofa::component::MechanicalObject< DataTypes >::setDx(), sofa::component::MechanicalObject< DataTypes >::setF(), sofa::component::MechanicalObject< DataTypes >::setV(), sofa::component::MechanicalObject< DataTypes >::setVfree(), sofa::component::MechanicalObject< DataTypes >::setX(), sofa::component::MechanicalObject< DataTypes >::setXfree(), sofa::component::MechanicalObject< DataTypes >::vAlloc(), sofa::component::MechanicalObject< DataTypes >::vAvail(), sofa::component::MechanicalObject< DataTypes >::vDot(), sofa::component::MechanicalObject< DataTypes >::vFree(), sofa::component::MechanicalObject< DataTypes >::vOp(), and sofa::component::MechanicalObject< DataTypes >::vThreshold().

Type sofa::core::componentmodel::behavior::BaseMechanicalState::VecId::type

Definition at line 157 of file BaseMechanicalState.h.

Referenced by sofa::component::MechanicalObject< DataTypes >::addBaseVectorToState(), isNull(), sofa::component::MechanicalObject< DataTypes >::loadInBaseVector(), sofa::core::componentmodel::behavior::operator<<(), operator==(), sofa::component::MechanicalObject< DataTypes >::printDOF(), sofa::component::MechanicalObject< DataTypes >::printDOFWithElapsedTime(), sofa::component::MechanicalObject< DataTypes >::setC(), sofa::component::MechanicalObject< DataTypes >::setDx(), sofa::component::MechanicalObject< DataTypes >::setF(), sofa::component::MechanicalObject< DataTypes >::setV(), sofa::component::MechanicalObject< DataTypes >::setVfree(), sofa::component::MechanicalObject< DataTypes >::setX(), sofa::component::MechanicalObject< DataTypes >::setXfree(), sofa::component::MechanicalObject< DataTypes >::vAlloc(), sofa::component::MechanicalObject< DataTypes >::vAvail(), sofa::component::MechanicalObject< DataTypes >::vDot(), sofa::component::MechanicalObject< DataTypes >::vFree(), sofa::component::MechanicalObject< DataTypes >::vOp(), and sofa::component::MechanicalObject< DataTypes >::vThreshold().

---

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

• framework/sofa/core/componentmodel/behavior/BaseMechanicalState.h