Seismo-VLAB  1.3
An Open-Source Finite Element Software for Meso-Scale Simulations
HDRBYamamoto3DLink Class Reference

Class for creating a bidirectional 3D two-node link element using Yamamoto HDRB formulation. More...

#include <HDRBYamamoto3DLink.hpp>

Inheritance diagram for HDRBYamamoto3DLink:
Collaboration diagram for HDRBYamamoto3DLink:

Public Member Functions

 HDRBYamamoto3DLink (const std::vector< unsigned int > nodes, double de, double di, double hr, unsigned int dim)
 Creates a HDRBYamamoto3DLink in a finite element Mesh. More...
 
 ~HDRBYamamoto3DLink ()
 Destroys this HDRBYamamoto3DLink object. More...
 
void CommitState ()
 Save the material states in the element. More...
 
void ReverseState ()
 Reverse the material/section states to previous converged state in this element. More...
 
void InitialState ()
 Brings the material/section state to its initial state in this element. More...
 
void UpdateState ()
 Update the material states in the element. More...
 
void SetDomain (std::map< unsigned int, std::shared_ptr< Node > > &nodes)
 Sets the finite element dependance among objects. More...
 
void SetDamping (const std::shared_ptr< Damping > &damping)
 Sets the damping model. More...
 
std::vector< unsigned int > GetTotalDegreeOfFreedom () const
 Gets the list of total-degree of freedom of this Element. More...
 
Eigen::MatrixXd GetStrain () const
 Gets the material/section (generalised) strain. More...
 
Eigen::MatrixXd GetStress () const
 Gets the material/section (generalised) stress. More...
 
Eigen::MatrixXd GetStrainRate () const
 Gets the material/section (generalised) strain-rate. More...
 
Eigen::MatrixXd GetStrainAt (double x3, double x2) const
 Gets the material strain in section at coordinate (x3,x2). More...
 
Eigen::MatrixXd GetStressAt (double x3, double x2) const
 Gets the material stress in section at coordinate (x3,x2). More...
 
Eigen::VectorXd GetVTKResponse (std::string response) const
 Gets the element internal response in VTK format for Paraview display. More...
 
double ComputeEnergy ()
 Computes the element energy for a given deformation. More...
 
Eigen::MatrixXd ComputeMassMatrix ()
 Compute the lumped/consistent mass matrix of the element. More...
 
Eigen::MatrixXd ComputeStiffnessMatrix ()
 Compute the stiffness matrix of the element using gauss-integration. More...
 
Eigen::MatrixXd ComputeDampingMatrix ()
 Compute the damping matrix of the element using gauss-integration. More...
 
Eigen::MatrixXd ComputePMLMatrix ()
 Compute the PML history matrix using gauss-integration. More...
 
Eigen::VectorXd ComputeInternalForces ()
 Compute the internal (elastic) forces acting on the element. More...
 
Eigen::VectorXd ComputeInternalDynamicForces ()
 Compute the elastic, inertial, and viscous forces acting on the element. More...
 
Eigen::VectorXd ComputeSurfaceForces (const std::shared_ptr< Load > &surface, unsigned int face)
 Compute the surface forces acting on the element. More...
 
Eigen::VectorXd ComputeBodyForces (const std::shared_ptr< Load > &body, unsigned int k=0)
 Compute the body forces acting on the element. More...
 
Eigen::VectorXd ComputeDomainReductionForces (const std::shared_ptr< Load > &drm, unsigned int k)
 Compute the domain reduction forces acting on the element. More...
 
- Public Member Functions inherited from Element
 Element (std::string name, const std::vector< unsigned int > nodes, unsigned int ndofs, unsigned int VTKcell, unsigned int SVLcell)
 Creates an Element in a finite element Mesh. More...
 
virtual ~Element ()=0
 Destroys this Element object. More...
 
std::string GetName () const
 Gets the Element Name. More...
 
unsigned int GetVTKCellType () const
 Gets the Element VTK cell type. More...
 
unsigned int GetVTKGroupType () const
 Gets the Element VTK group type. More...
 
unsigned int GetNumberOfNodes () const
 Returns the number of nodes in element. More...
 
unsigned int GetNumberOfDegreeOfFreedom () const
 Returns total number of degree of freedom in the element. More...
 
const std::vector< unsigned int > & GetNodes () const
 Returns the Node Connectivity Indexes. More...
 
bool HasFixedNode (const std::vector< std::shared_ptr< Node > > &nodes) const
 Returns if the element has fixed nodes. More...
 

Private Member Functions

Eigen::VectorXd ComputeRelativeDeformation () const
 Update strain in the element: More...
 
Eigen::MatrixXd ComputeLocalAxes () const
 Compute local axes. More...
 
Eigen::MatrixXd ComputeRotationMatrix () const
 Compute rotation matrix. More...
 

Private Attributes

double n
 Yamamoto's model parameter. More...
 
double alpha
 Yamamoto's model parameter. More...
 
double Ar
 Rubber bearing area. More...
 
double Hr
 Rubber bearing height. More...
 
double Krb
 Rubber Bearing linear stiffness. More...
 
double cr
 coefficient of shear stress More...
 
double cs
 coefficient of shear stress More...
 
unsigned int Dimension
 HDRB link dimension in 3D. More...
 
unsigned int nMax
 Newton-Raphson maximum number of iterations. More...
 
Eigen::VectorXd Pn
 Displacement Trajectory Vector. More...
 
Eigen::VectorXd Qn
 Non-linear Displacement Trajectory Vector. More...
 
Eigen::VectorXd Fn
 Non-linear Restoring Force Vector. More...
 
Eigen::VectorXd Fc
 Non-linear Commited Restoring Force Vector. More...
 
Eigen::VectorXd Paux
 Trial Displacement Trajectory Vector. More...
 
Eigen::VectorXd Qaux
 Non-linear Displacement Trajectory Vector. More...
 
std::vector< std::shared_ptr< Node > > theNodes
 The Element's Nodes. More...
 

Detailed Description

Class for creating a bidirectional 3D two-node link element using Yamamoto HDRB formulation.

See also
Element.hpp Mesh.hpp

Constructor & Destructor Documentation

◆ HDRBYamamoto3DLink()

HDRBYamamoto3DLink::HDRBYamamoto3DLink ( const std::vector< unsigned int >  nodes,
double  de,
double  di,
double  hr,
unsigned int  dim 
)

Creates a HDRBYamamoto3DLink in a finite element Mesh.

Parameters
nodesThe Node connectivity array of this Element.
parametersVector that contains the Bouc-Wen model parameters.
variablesVector that contains auxiliary model parameters.
dimThe model dimension.
dirThe local direction where this Element is acting.
Note
More details can be found at HDRBYamamoto3DLink.
See also
HDRBYamamoto3DLink::theNodes, HDRBYamamoto3DLink::theDirection, HDRBYamamoto3DLink::theDimension.

◆ ~HDRBYamamoto3DLink()

HDRBYamamoto3DLink::~HDRBYamamoto3DLink ( )

Destroys this HDRBYamamoto3DLink object.

Member Function Documentation

◆ CommitState()

void HDRBYamamoto3DLink::CommitState ( )
virtual

Save the material states in the element.

Note
This function sets the trial states as converged ones in Material.

Implements Element.

◆ ComputeBodyForces()

Eigen::VectorXd HDRBYamamoto3DLink::ComputeBodyForces ( const std::shared_ptr< Load > &  body,
unsigned int  k = 0 
)
virtual

Compute the body forces acting on the element.

Parameters
bodyPointer to the Load object that contains this information.
kThe time step at which the body load is evaluated.
Returns
Vector with the Element surface force.
Note
The body force vector can be revisited in HDRBYamamoto3DLink.
See also
Assembler::ComputeExternalForceVector(), Integrator::ComputeEffectiveForce().

Implements Element.

◆ ComputeDampingMatrix()

Eigen::MatrixXd HDRBYamamoto3DLink::ComputeDampingMatrix ( )
virtual

Compute the damping matrix of the element using gauss-integration.

Returns
Matrix with the Element damping matrix.
Note
The damping matrix can be revisited in HDRBYamamoto3DLink.
See also
Assembler::ComputeDampingMatrix(), Integrator::ComputeEffectiveStiffness().

Implements Element.

◆ ComputeDomainReductionForces()

Eigen::VectorXd HDRBYamamoto3DLink::ComputeDomainReductionForces ( const std::shared_ptr< Load > &  drm,
unsigned int  k 
)
virtual

Compute the domain reduction forces acting on the element.

Parameters
drmPointer to the DRM Load object that contains this information.
kThe time step at which the body load is evaluated.
Returns
Vector with the Element domain reduction forces.
Note
The DRM force vector can be revisited in HDRBYamamoto3DLink.
See also
Assembler::ComputeExternalForceVector(), Integrator::ComputeEffectiveForce().

Implements Element.

◆ ComputeEnergy()

double HDRBYamamoto3DLink::ComputeEnergy ( )
virtual

Computes the element energy for a given deformation.

Returns
Scalar with the element deformation energy.

Implements Element.

◆ ComputeInternalDynamicForces()

Eigen::VectorXd HDRBYamamoto3DLink::ComputeInternalDynamicForces ( )
virtual

Compute the elastic, inertial, and viscous forces acting on the element.

Returns
Vector with the Element dynamic internal force.
Note
The internal force vector can be revisited in Element.
See also
Assembler::ComputeDynamicInternalForceVector().

Implements Element.

◆ ComputeInternalForces()

Eigen::VectorXd HDRBYamamoto3DLink::ComputeInternalForces ( )
virtual

Compute the internal (elastic) forces acting on the element.

Returns
Vector with the Element internal force.
Note
The internal force vector can be revisited in HDRBYamamoto3DLink.
See also
Assembler::ComputeInternalForceVector(), Integrator::ComputeEffectiveForce().

Implements Element.

◆ ComputeLocalAxes()

Eigen::MatrixXd HDRBYamamoto3DLink::ComputeLocalAxes ( ) const
private

Compute local axes.

Returns
Matrix with the local axis transformation.
Note
Axes transformation are according to HDRBYamamoto3DLink.

◆ ComputeMassMatrix()

Eigen::MatrixXd HDRBYamamoto3DLink::ComputeMassMatrix ( )
virtual

Compute the lumped/consistent mass matrix of the element.

Returns
Matrix with the Element mass matrix.
Note
The mass matrix can be revisited in HDRBYamamoto3DLink.
See also
Assembler::ComputeMassMatrix(), Integrator::ComputeEffectiveStiffness().

Implements Element.

◆ ComputePMLMatrix()

Eigen::MatrixXd HDRBYamamoto3DLink::ComputePMLMatrix ( )
virtual

Compute the PML history matrix using gauss-integration.

Returns
Matrix with the PML Element matrix.
Note
The PML matrix is none existent for this element.
See also
Assembler::ComputePMLHistoryMatrix(), Integrator::ComputeEffectiveStiffness().

Implements Element.

◆ ComputeRelativeDeformation()

Eigen::VectorXd HDRBYamamoto3DLink::ComputeRelativeDeformation ( ) const
private

Update strain in the element:

Returns
Vector with the total relative deformation.

◆ ComputeRotationMatrix()

Eigen::MatrixXd HDRBYamamoto3DLink::ComputeRotationMatrix ( ) const
private

Compute rotation matrix.

Returns
Matrix with the rotation.
Note
Axes transformation are according to HDRBYamamoto3DLink.

◆ ComputeStiffnessMatrix()

Eigen::MatrixXd HDRBYamamoto3DLink::ComputeStiffnessMatrix ( )
virtual

Compute the stiffness matrix of the element using gauss-integration.

Returns
Matrix with the Element stiffness matrix.
Note
The stiffness matrix can be revisited in HDRBYamamoto3DLink.
See also
Assembler::ComputeStiffnessMatrix(), Integrator::ComputeEffectiveStiffness().

Implements Element.

◆ ComputeSurfaceForces()

Eigen::VectorXd HDRBYamamoto3DLink::ComputeSurfaceForces ( const std::shared_ptr< Load > &  surface,
unsigned int  face 
)
virtual

Compute the surface forces acting on the element.

Parameters
surfacePointer to the Load object that contains this information.
kThe time step at which the surface load is evaluated.
Returns
Vector with the Element surface force.
Note
The surface force vector can be revisited in HDRBYamamoto3DLink.
See also
Assembler::ComputeExternalForceVector(), Integrator::ComputeEffectiveForce().

Implements Element.

◆ GetStrain()

Eigen::MatrixXd HDRBYamamoto3DLink::GetStrain ( ) const
virtual

Gets the material/section (generalised) strain.

Returns
Matrix with the strain at each integration point.
Note
The index (i,j) are the strain and Gauss-point respectively.

Implements Element.

◆ GetStrainAt()

Eigen::MatrixXd HDRBYamamoto3DLink::GetStrainAt ( double  x3,
double  x2 
) const
virtual

Gets the material strain in section at coordinate (x3,x2).

Parameters
x3Local coordinate along the x3-axis.
x2Local coordinate along the x2-axis.
Returns
Matrix with the strain at coordinate (x3,x2).
Note
The strains are interpolated at this coordinate.

Implements Element.

◆ GetStrainRate()

Eigen::MatrixXd HDRBYamamoto3DLink::GetStrainRate ( ) const
virtual

Gets the material/section (generalised) strain-rate.

Returns
Matrix with the strain-rate at each integration point.
Note
The index (i,j) are the strain-rate and Gauss-point respectively.

Implements Element.

◆ GetStress()

Eigen::MatrixXd HDRBYamamoto3DLink::GetStress ( ) const
virtual

Gets the material/section (generalised) stress.

Returns
Matrix with the stress at each integration point.
Note
The index (i,j) are the stress and Gauss-point respectively.

Implements Element.

◆ GetStressAt()

Eigen::MatrixXd HDRBYamamoto3DLink::GetStressAt ( double  x3,
double  x2 
) const
virtual

Gets the material stress in section at coordinate (x3,x2).

Parameters
x3Local coordinate along the x3-axis.
x2Local coordinate along the x2-axis.
Returns
Matrix with the stresses at coordinate (x3,x2).
Note
The stresses are interpolated at this coordinate.

Implements Element.

◆ GetTotalDegreeOfFreedom()

std::vector<unsigned int> HDRBYamamoto3DLink::GetTotalDegreeOfFreedom ( ) const
virtual

Gets the list of total-degree of freedom of this Element.

Returns
Vector with the list of degree-of-freedom of this Element.

Implements Element.

◆ GetVTKResponse()

Eigen::VectorXd HDRBYamamoto3DLink::GetVTKResponse ( std::string  response) const
virtual

Gets the element internal response in VTK format for Paraview display.

Parameters
responseThe response to be display in Paraview.
Returns
Vector with the response at the Element center.
Note
The current responses are: "Strain", "Stress".

Implements Element.

◆ InitialState()

void HDRBYamamoto3DLink::InitialState ( )
virtual

Brings the material/section state to its initial state in this element.

Note
This function returns the meterial states to the beginning.

Implements Element.

◆ ReverseState()

void HDRBYamamoto3DLink::ReverseState ( )
virtual

Reverse the material/section states to previous converged state in this element.

Note
This function returns the trial states to previous converged states at the Material level.

Implements Element.

◆ SetDamping()

void HDRBYamamoto3DLink::SetDamping ( const std::shared_ptr< Damping > &  damping)
virtual

Sets the damping model.

Parameters
dampingPointer to the damping model.
Note
Several Element objects can share the same damping model.

Implements Element.

◆ SetDomain()

void HDRBYamamoto3DLink::SetDomain ( std::map< unsigned int, std::shared_ptr< Node > > &  nodes)
virtual

Sets the finite element dependance among objects.

Parameters
nodesThe Node list of the Mesh object.
Note
This function sets the relation between Node and Element objects.
See also
lin2DQuad4::theNodes.

Implements Element.

◆ UpdateState()

void HDRBYamamoto3DLink::UpdateState ( )
virtual

Update the material states in the element.

Note
This function update the trial states at the Material level.

Implements Element.

Member Data Documentation

◆ alpha

double HDRBYamamoto3DLink::alpha
private

Yamamoto's model parameter.

◆ Ar

double HDRBYamamoto3DLink::Ar
private

Rubber bearing area.

◆ cr

double HDRBYamamoto3DLink::cr
private

coefficient of shear stress

◆ cs

double HDRBYamamoto3DLink::cs
private

coefficient of shear stress

◆ Dimension

unsigned int HDRBYamamoto3DLink::Dimension
private

HDRB link dimension in 3D.

◆ Fc

Eigen::VectorXd HDRBYamamoto3DLink::Fc
private

Non-linear Commited Restoring Force Vector.

◆ Fn

Eigen::VectorXd HDRBYamamoto3DLink::Fn
private

Non-linear Restoring Force Vector.

◆ Hr

double HDRBYamamoto3DLink::Hr
private

Rubber bearing height.

◆ Krb

double HDRBYamamoto3DLink::Krb
private

Rubber Bearing linear stiffness.

◆ n

double HDRBYamamoto3DLink::n
private

Yamamoto's model parameter.

◆ nMax

unsigned int HDRBYamamoto3DLink::nMax
private

Newton-Raphson maximum number of iterations.

◆ Paux

Eigen::VectorXd HDRBYamamoto3DLink::Paux
private

Trial Displacement Trajectory Vector.

◆ Pn

Eigen::VectorXd HDRBYamamoto3DLink::Pn
private

Displacement Trajectory Vector.

◆ Qaux

Eigen::VectorXd HDRBYamamoto3DLink::Qaux
private

Non-linear Displacement Trajectory Vector.

◆ Qn

Eigen::VectorXd HDRBYamamoto3DLink::Qn
private

Non-linear Displacement Trajectory Vector.

◆ theNodes

std::vector<std::shared_ptr<Node> > HDRBYamamoto3DLink::theNodes
private

The Element's Nodes.