BeamAdapter
Loading...
Searching...
No Matches
WireBeamInterpolation< DataTypes > Class Template Reference

#include <WireBeamInterpolation.h>

Inheritance diagram for WireBeamInterpolation< DataTypes >:
BaseBeamInterpolation< DataTypes >

Public Types

using Inherit = BaseBeamInterpolation<DataTypes>
typedef Inherit::VecCoord VecCoord
typedef Inherit::VecDeriv VecDeriv
typedef Inherit::Coord Coord
typedef Inherit::Deriv Deriv
typedef Inherit::Real Real
typedef Inherit::Transform Transform
typedef Inherit::SpatialVector SpatialVector
typedef Inherit::Vec2 Vec2
typedef Inherit::Vec3 Vec3
typedef Inherit::Quat Quat
using EdgeID = BaseMeshTopology::EdgeID
Public Types inherited from BaseBeamInterpolation< DataTypes >
using Inherit = sofa::core::behavior::SingleStateAccessor<DataTypes>
using Coord = typename DataTypes::Coord
using VecCoord = typename DataTypes::VecCoord
using Real = typename Coord::value_type
using Deriv = typename DataTypes::Deriv
using VecDeriv = typename DataTypes::VecDeriv
using Transform = sofa::type::Transform<Real>
using SpatialVector = sofa::type::SpatialVector<Real>
using Vec2 = sofa::type::Vec<2, Real>
using Vec3 = sofa::type::Vec<3, Real>
using Vec3NoInit = sofa::type::VecNoInit<3, Real>
using Quat = sofa::type::Quat<Real>
using VectorVec3 = type::vector <Vec3>
using PointID = BaseMeshTopology::PointID
using EdgeID = BaseMeshTopology::EdgeID
using VecEdgeID = type::vector<BaseMeshTopology::EdgeID>
using VecEdges = type::vector<BaseMeshTopology::Edge>
using StateDataTypes = sofa::defaulttype::StdVectorTypes< sofa::type::Vec<DataTypes::spatial_dimensions, Real>, sofa::type::Vec<DataTypes::spatial_dimensions, Real>, Real >
 DATA INPUT (that could change in real-time).

Public Member Functions

 SOFA_CLASS (SOFA_TEMPLATE(WireBeamInterpolation, DataTypes), SOFA_TEMPLATE(BaseBeamInterpolation, DataTypes))
 WireBeamInterpolation (WireRestShape< DataTypes > *_restShape=nullptr)
void init () override
void bwdInit () override
void reinit () override
void addBeam (const EdgeID eID, const Real length, const Real x0, const Real x1, const Transform &DOF0_H_Node0, const Transform &DOF1_H_Node1)
void getSamplingParameters (type::vector< Real > &xP_noticeable, type::vector< sofa::Size > &nbP_density) override
Real getRestTotalLength () override
 getLength / setLength => provides the rest length of each spline using
void getMechanicalSampling (Real &dx, const Real x_localcurv_abs) override
void getCollisionSampling (Real &dx, const Real x_localcurv_abs) override
 Collision information using.
void getNumberOfCollisionSegment (Real &dx, unsigned int &numLines) override
sofa::Size getTotalNumberOfPossibleBeams () const
virtual void getRestTransform (const EdgeID edgeInList, Transform &local0_H_local1_rest)
void getCurvAbsAtBeam (const EdgeID edgeInList_input, const Real baryCoord_input, Real &x_output) override
void getSplineRestTransform (const EdgeID edgeInList, Transform &local_H_local0_rest, Transform &local_H_local1_rest) override
const BeamSection & getBeamSection (sofa::Index beamId) override
 Returns the BeamSection.
void getInterpolationParameters (sofa::Index beamId, Real &_L, Real &_A, Real &_Iy, Real &_Iz, Real &_Asy, Real &_Asz, Real &_J) override
 Returns the BeamSection data depending on the beam position at the given beam, similar to @getBeamSection.
void getMechanicalParameters (sofa::Index, Real &youngModulus, Real &cPoisson, Real &massDensity) override
 Returns the Young modulus, Poisson's ratio and massDensity coefficient of the section at the given curvilinear abscissa.
bool getApproximateCurvAbs (const Vec3 &x_input, const VecCoord &x, Real &x_output)
void setPathToRestShape (const std::string &o)
void getRestTransformOnX (Transform &global_H_local, const Real x)
bool isControlled ()
void setControlled (bool value)
bool breaksInTwo (const Real x_min_out, Real &x_break, int &numBeamsNotUnderControlled)
Public Member Functions inherited from BaseBeamInterpolation< DataTypes >
 SOFA_CLASS (SOFA_TEMPLATE(BaseBeamInterpolation, DataTypes), SOFA_TEMPLATE(sofa::core::behavior::SingleStateAccessor, DataTypes))
void init () override
virtual void clear ()
virtual void addBeam (const EdgeID eID, const Real length, const Real x0, const Real x1, const Real angle)
sofa::Size getNumBeams () const
void getAbsCurvXFromBeam (const sofa::Index beam, Real &x_curv)
void getAbsCurvXFromBeam (const sofa::Index beam, Real &x_curv_start, Real &x_curv_end)
Real getLength (const EdgeID edgeInList)
void setLength (const EdgeID edgeInList, Real &length)
void addCollisionOnBeam (const sofa::Index beam)
 Set collision information.
void clearCollisionOnBeam ()
virtual void getNumberOfCollisionSegment (Real &dx, sofa::Size &numLines)=0
virtual void getBeamAtCurvAbs (const Real x_input, sofa::Index &edgeInList_output, Real &baryCoord_output, unsigned int start=0)
int computeTransform (const EdgeID edgeInList, Transform &global_H_local0, Transform &global_H_local1, const VecCoord &x)
int computeTransform (const EdgeID edgeInList, const PointID node0Idx, const PointID node1Idx, Transform &global_H_local0, Transform &global_H_local1, const VecCoord &x)
void getDOFtoLocalTransform (const EdgeID edgeInList, Transform &DOF0_H_local0, Transform &DOF1_H_local1)
void getDOFtoLocalTransformInGlobalFrame (const EdgeID edgeInList, Transform &DOF0Global_H_local0, Transform &DOF1Global_H_local1, const VecCoord &x)
void setTransformBetweenDofAndNode (const sofa::Index beam, const Transform &DOF_H_Node, unsigned int zeroORone)
void getTangent (Vec3 &t, const Real baryCoord, const Transform &global_H_local0, const Transform &global_H_local1, const Real L)
 getTangent : Computation of a Tangent for the beam (it is given by the derivative of the spline formulation)
int getNodeIndices (const EdgeID edgeInList, unsigned int &node0Idx, unsigned int &node1Idx)
void getSplinePoints (const EdgeID edgeInList, const VecCoord &x, Vec3 &P0, Vec3 &P1, Vec3 &P2, Vec3 &P3)
unsigned int getStateSize () const
void computeActualLength (Real &length, const Vec3 &P0, const Vec3 &P1, const Vec3 &P2, const Vec3 &P3)
void computeStrechAndTwist (const EdgeID edgeInList, const VecCoord &x, Vec3 &ResultNodeO, Vec3 &ResultNode1)
void updateBezierPoints (const VecCoord &x, sofa::core::VecCoordId &vId_Out)
 vId_Out provides the id of the multiVecId which stores the position of the Bezier Points
void updateBezierPoints (const VecCoord &x, sofa::Index index, VectorVec3 &v)
void interpolatePointUsingSpline (const EdgeID edgeInList, const Real baryCoord, const Vec3 &localPos, const VecCoord &x, Vec3 &posResult)
 spline base interpolation of points and transformation
void interpolatePointUsingSpline (const EdgeID edgeInList, const Real baryCoord, const Vec3 &localPos, const VecCoord &x, Vec3 &posResult, bool recompute, const sofa::core::ConstVecCoordId &vecXId)
void InterpolateTransformUsingSpline (const EdgeID edgeInList, const Real baryCoord, const Vec3 &localPos, const VecCoord &x, Transform &global_H_localInterpol)
void InterpolateTransformUsingSpline (Transform &global_H_localResult, const Real baryCoord, const Transform &global_H_local0, const Transform &global_H_local1, const Real L)
void InterpolateTransformAndVelUsingSpline (const EdgeID edgeInList, const Real baryCoord, const Vec3 &localPos, const VecCoord &x, const VecDeriv &v, Transform &global_H_localInterpol, Deriv &v_interpol)
Real ComputeTotalBendingRotationAngle (const Real dx_computation, const Transform &global_H_local0, const Transform &global_H_local1, const Real L, const Real baryCoordMin, const Real baryCoordMax)
 compute the total bending Rotation Angle while going through the Spline (to estimate the curvature)
void MapForceOnNodeUsingSpline (const EdgeID edgeInList, const Real baryCoord, const Vec3 &localPos, const VecCoord &x, const Vec3 &finput, SpatialVector &FNode0output, SpatialVector &FNode1output)
 3DOF mapping
void MapForceOnNodeUsingSpline (const EdgeID edgeInList, const Real baryCoord, const Vec3 &localPos, const VecCoord &x, const SpatialVector &f6DofInput, SpatialVector &FNode0output, SpatialVector &FNode1output)
 6DoF mapping

Static Public Member Functions

template<class T>
static bool canCreate (T *obj, sofa::core::objectmodel::BaseContext *context, sofa::core::objectmodel::BaseObjectDescription *arg)
template<class T>
static T::SPtr create (T *tObj, core::objectmodel::BaseContext *context, core::objectmodel::BaseObjectDescription *arg)
Static Public Member Functions inherited from BaseBeamInterpolation< DataTypes >
static void getControlPointsFromFrame (const Transform &global_H_local0, const Transform &global_H_local1, const Real L, Vec3 &P0, Vec3 &P1, Vec3 &P2, Vec3 &P3)
static void RotateFrameForAlignX (const Quat &input, Vec3 &x, Quat &output)
 Method to rotate a Frame define by a Quat.
static void RotateFrameForAlignNormalizedX (const Quat &input, const Vec3 &x, Quat &output)
 Method to rotate a Frame define by a Quat.

Public Attributes

SingleLink< WireBeamInterpolation< DataTypes >, WireRestShape< DataTypes >, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINK > m_restShape
Public Attributes inherited from BaseBeamInterpolation< DataTypes >
MechanicalObject< StateDataTypes >::SPtr m_StateNodes
Data< VecEdgeID > d_edgeList
Data< type::vector< SReal > > d_lengthList
Data< type::vector< Transform > > d_DOF0TransformNode0
Data< type::vector< Transform > > d_DOF1TransformNode1
Data< type::vector< Vec2 > > d_curvAbsList
 Vector of 2 Real. absciss curv of first and second point defining the beam.
Data< sofa::type::vector< EdgeID > > d_beamCollision
Data< bool > d_dofsAndBeamsAligned
Data< sofa::Index > d_wireTipIndex
 index of the beam extremity that is considered as the tip of the wire
SingleLink< BaseBeamInterpolation< DataTypes >, BaseMeshTopology, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINK > l_topology
 link to the (edge) topology

Protected Attributes

bool m_isControlled { false }

Detailed Description

template<class DataTypes>
class beamadapter::WireBeamInterpolation< DataTypes >

WireAdaptiveBeam Interpolation provides the implementation of a 1D parameteric beam model.

Compute Finite Element elastic force and mass based on Adaptive 6D beam elements.

  • Adaptive beam interpolation
  • Adaptive Force and Mass computation
  • Adaptive Mapping

TODO(dmarchal 2017-05-17) Please specify who/when this will be done TODO : put in a separate class what is specific to wire shape !

Member Function Documentation

◆ breaksInTwo()

template<class DataTypes>
bool breaksInTwo ( const Real x_min_out,
Real & x_break,
int & numBeamsNotUnderControlled )
inline

Deprecated Methods ////////////////////////////////////////// For coils: a part of the coil instrument can be brokenIn2 (by default the point of release is the end of the straight length)

◆ getBeamSection()

template<class DataTypes>
const BeamSection & getBeamSection ( sofa::Index beamId)
overridevirtual

Returns the BeamSection.

See also
m_beamSection corresponding to the given beam

Implements BaseBeamInterpolation< DataTypes >.

◆ getCollisionSampling()

template<class DataTypes>
void getCollisionSampling ( Real & dx,
const Real x_localcurv_abs )
inlineoverridevirtual

Collision information using.

See also
d_beamCollision

Implements BaseBeamInterpolation< DataTypes >.

◆ getCurvAbsAtBeam()

template<class DataTypes>
void getCurvAbsAtBeam ( const EdgeID edgeInList_input,
const Real baryCoord_input,
Real & x_output )
overridevirtual

TODO(dmarchal 2017-05-17): Please tell who and when it will be done.

Implements BaseBeamInterpolation< DataTypes >.

◆ getInterpolationParameters()

template<class DataTypes>
void getInterpolationParameters ( sofa::Index beamId,
Real & _L,
Real & _A,
Real & _Iy,
Real & _Iz,
Real & _Asy,
Real & _Asz,
Real & J )
overridevirtual

Returns the BeamSection data depending on the beam position at the given beam, similar to @getBeamSection.

Implements BaseBeamInterpolation< DataTypes >.

◆ getMechanicalParameters()

template<class DataTypes>
void getMechanicalParameters ( sofa::Index beamId,
Real & youngModulus,
Real & cPoisson,
Real & massDensity )
overridevirtual

Returns the Young modulus, Poisson's ratio and massDensity coefficient of the section at the given curvilinear abscissa.

Implements BaseBeamInterpolation< DataTypes >.

◆ getMechanicalSampling()

template<class DataTypes>
void getMechanicalSampling ( Real & dx,
const Real x_localcurv_abs )
inlineoverridevirtual

◆ getRestTotalLength()

template<class DataTypes>
Real getRestTotalLength ( )
inlineoverridevirtual

getLength / setLength => provides the rest length of each spline using

See also
d_lengthList

Implements BaseBeamInterpolation< DataTypes >.

◆ getSamplingParameters()

template<class DataTypes>
void getSamplingParameters ( type::vector< Real > & xP_noticeable,
type::vector< sofa::Size > & nbP_density )
inlineoverridevirtual

◆ getSplineRestTransform()

template<class DataTypes>
void getSplineRestTransform ( const EdgeID edgeInList,
Transform & local_H_local0_rest,
Transform & local_H_local1_rest )
overridevirtual

the beam is straight: local is in the middle of local0 and local1 the transformation between local0 and local1 is provided by the length of the beam

Implements BaseBeamInterpolation< DataTypes >.