GranOO 3.0
A robust and versatile workbench to build 3D dynamic simulations based on the Discrete Element Method
Loading...
Searching...
No Matches
GranOO3::DEM::HertzSpring Class Reference

a bond model that represents an Hertzian contact (non linear contact) More...

#include <HertzSpring.hpp>

Inheritance diagram for GranOO3::DEM::HertzSpring:

Public Member Functions

 HertzSpring (Element &el1, Element &el2)
 constructor
 HertzSpring (Element &el1, Element &el2, double young_modulus, double poisson_ratio)
 constructor
virtual ~HertzSpring ()
 destructor
void init ()
 initialize the hertzspring
void process ()
 compute the reaction force (no torque)
virtual void update ()
virtual void compute_load ()
 trigger the computing of the reaction force and torque
virtual double get_linear_stiffness () const
 compute the linear stiffness of the bond
virtual double get_angular_stiffness () const
 similar as get_linear_stiffness() for rotation (zero for a Hertzian spring)
virtual double compute_critical_time_step () const
 compute the critical time of the bond
virtual std::string info () const
 Display some useful info in the terminal.
Public Member Functions inherited from GranOO3::DEM::Bond
 Bond (Element &el1, Element &el2, bool contact=false)
 Constructor.
virtual ~Bond ()=0
 Destructor.
virtual void draw ()
 OpenGL draw of the bond.
Element & get_item1 ()
const Element & get_item1 () const
Element & get_item2 ()
const Element & get_item2 () const
Element & item1 ()
Element & item2 ()
double get_normal_force_intensity () const
double get_tangential_force_intensity () const
Element & bonded_element (const Element &)
 get the bonded element
const Element & get_bonded_element (const Element &) const
 same as bonded_element(const Element&) (provided for convenience)
void apply_linear_damping_factor ()
 compute and apply the linear (translation) damping factor of the bond
void apply_angular_damping_factor ()
 similar as apply_linear_damping_factor() for rotation
void apply_load ()
 apply the computed reaction force and torque to the bonded Element (_element1 and _element2)
void disable (bool manage_slave=true)
 disable the bond
void disable_fast_mode (bool manage_slave=true)
 simply disable the bond by switching the _disabled attribute to true without doing the lot of things done by the disable() method
void enable (bool manage_slave=true)
 simply enable the bond by switching the _disabled attribute to false
bool is_disabled () const
 check if the bond is enable or not
void crack (bool manage_slave=true)
void uncrack (bool manage_slave=true)
bool is_cracked () const
void init_local_frame (bool update_initial_param=false)
 initialize the bond local frame
void update_local_frame ()
 update the bond local frame
void update_current_length ()
 update the current value of the bond length (see _current_length attribute)
void build_voronoi_bond ()
 build a voronoi bond from the current bond
virtual void stiffness_matrix (Eigen::MatrixXd &kMatrix)
 assemble a stiffness matrix
virtual void update_dof ()
 update the bond dof
const std::vector< unsigned int > & get_dof () const
 get the dof vector
const Geom::Point & initial_pos (const Element &) const
 get the initial position of the el element
Geom::Vector get_disp (const Element &) const
 get the displacement of the el element
Geom::Vector get_disp1 () const
 get the displacement of the first bonded element (_element1)
Geom::Vector get_disp2 () const
 similar as get_disp1()
void swap (Element &from, Element &to)
 swap the bond from the Element from to to
void add_slave (Bond &b)
 add a slave bond (useful for periodic simulation)
virtual std::ostream & export_to_povray (std::ostream &out) const
 exporting to povray format
Public Member Functions inherited from GranOO3::Physic::BodyInteraction
 BodyInteraction (Body &b1, Body &b2, bool contact_interaction)
 constructor
virtual ~BodyInteraction ()
 destructor
void apply_torque ()
 apply the current torque value
void clear_torque ()
 set the torques to zero
Geom::Vector & torque_on (const Body &b)
 get the torque value applied on b
const Geom::Vector & torque_on (const Body &b) const
 same as BodyInteraction::torque_on
void add_label_torque (const std::string &label, const Geom::Vector &t1, const Geom::Vector &t2)
 add a label for the torque
void swap (Body &from, Body &to)
 swap one body
Public Member Functions inherited from GranOO3::Physic::NodeInteraction
 NodeInteraction (Node &de1, Node &de2, bool build_node_interaction)
virtual ~NodeInteraction ()
bool contact_interaction () const
void apply_force ()
void clear_force ()
Geom::Vector & force_on (const Node &)
const Geom::Vector & force_on (const Node &) const
void swap (Node &from, Node &to)
virtual std::ostream & write_ascii (std::ostream &out) const
void add_label_force (const std::string &label, const Geom::Vector &f1, const Geom::Vector &f2)
Public Member Functions inherited from GranOO3::Core::Base
virtual ~Base ()
size_t numID () const
size_t uID () const
void set_numID (size_t val)
void clear_numID ()
Physic::Material & get_mat () const
void set_mat (Physic::Material *)
Base & item ()
const Base & item () const
bool is_same (const Base &) const
template<class T>
T & cast_to ()
template<class T>
const T & cast_to () const
template<class T>
bool is () const
virtual bool is (size_t) const
virtual const std::string & get_ID () const
virtual Base & clone ()
template<class T>
T & clone_to ()
virtual std::istream & read_ascii (std::istream &in)
Signal< Base & > & deleted_signal ()
Public Member Functions inherited from GranOO3::Core::Null
 Null ()
virtual ~Null ()
Public Member Functions inherited from GranOO3::Core::Drawable
 Drawable ()
virtual ~Drawable ()
virtual void draw_edge ()
virtual void init_default_color ()
virtual std::ostream & get_info (std::ostream &os) const
virtual const Color & default_color () const
Color & get_color ()
const Color & get_color () const
virtual void set_color (const Color &)
virtual void set_alpha (float alpha)
void apply_color () const
void apply_edge_color () const
void apply_default_color ()
void apply_selected_color ()
void set_line_width (float)
float get_line_width () const
float & get_line_width ()
void apply_line_width () const
bool is_visible () const
void set_visible (bool)
void paint ()
void paint_edge ()
unsigned int get_item_glkey () const
Public Member Functions inherited from GranOO3::Core::Register< Base >
 Register ()
virtual ~Register ()
void erase_from_all_setof ()
bool belong_to_setof (const std::string &setOfId) const
std::list< SetOf< Base > * > & get_setof_list ()
unsigned long long int get_numeric_ID () const
Public Member Functions inherited from GranOO3::Core::Register< NodeInteraction >
 Register ()
virtual ~Register ()
void erase_from_all_setof ()
bool belong_to_setof (const std::string &setOfId) const
std::list< SetOf< NodeInteraction > * > & get_setof_list ()
unsigned long long int get_numeric_ID () const
Public Member Functions inherited from GranOO3::Core::Register< BodyInteraction >
 Register ()
virtual ~Register ()
void erase_from_all_setof ()
bool belong_to_setof (const std::string &setOfId) const
std::list< SetOf< BodyInteraction > * > & get_setof_list ()
unsigned long long int get_numeric_ID () const
Public Member Functions inherited from GranOO3::Core::PropClass< Bond >
 PropClass ()
virtual ~PropClass ()
T & new_object ()
T & get ()
bool prop_exist () const
void add_prop (Core::Prop< Bond > *)
void remove_prop (Core::Prop< Bond > *)
std::string info () const
Public Member Functions inherited from GranOO3::Core::Register< Bond >
 Register ()
virtual ~Register ()
void erase_from_all_setof ()
bool belong_to_setof (const std::string &setOfId) const
std::list< SetOf< Bond > * > & get_setof_list ()
unsigned long long int get_numeric_ID () const
Public Member Functions inherited from GranOO3::Core::Register< HertzSpring >
 Register ()
virtual ~Register ()
void erase_from_all_setof ()
bool belong_to_setof (const std::string &setOfId) const
std::list< SetOf< HertzSpring > * > & get_setof_list ()
unsigned long long int get_numeric_ID () const

Private Member Functions

 HertzSpring ()=delete
 HertzSpring (const HertzSpring &)=delete
HertzSpring & operator= (const HertzSpring &)=delete
template<class Archive>
void serialize (Archive &, const unsigned int)
 complete serializing of the bond in the *.gdd format

Private Attributes

double _young_modulus
 the Young's modulus value of the bond in [Pa]
double _poisson_ratio
 the Poisson's ratio of the bond in [-]
Geom::Vector _direction
 the current normal direction of the Hertz spring
Geom::Vector _force
 the current normal force of the Hertz spring
double _equivalent_radius
 the equivalent radius of the Hertz spring
double _stiffness
 the equivalent stiffness of the Hertz spring
double _contact_radius
 the contact radius of the Hertz spring
double _contact_surface
 the contact surface of the Hertz spring

Friends

class boost::serialization::access

Additional Inherited Members

Public Types inherited from GranOO3::DEM::Bond
enum  FailureMode { NONE =0 , TENSION =1 , COMPRESSION =2 , SHEAR =3 }
enum  DrawMode { SOLID , LINE , NO }
Static Public Member Functions inherited from GranOO3::DEM::Bond
static double get_disabled_cumulative_surface ()
 get the total surface disabled surface
Static Public Member Functions inherited from GranOO3::Core::Base
static Base & get_by_numID (size_t)
static void clear_all_numID ()
static unsigned int get_sub_class_number ()
Static Public Member Functions inherited from GranOO3::Core::Drawable
static Drawable & get_drawable_item_by_glkey (int)
static void set_draw_precision (unsigned int p)
static void increase_draw_precision ()
static void decrease_draw_precision ()
static unsigned int get_draw_precision ()
Static Public Member Functions inherited from GranOO3::Physic::CriticalTimeStep
static const std::set< CriticalTimeStep * > & get_all ()
Static Public Attributes inherited from GranOO3::DEM::Bond
static double epsilon
 a very small value used as a threshold
static double draw_solid_factor
static DrawMode draw_mode = LINE
static Core::Signal< Bond & > disable_signal = Core::Signal<Bond&>()
 get the signal when a bond is disabled
Static Public Attributes inherited from GranOO3::Core::Null
static Null null = Null()
Protected Member Functions inherited from GranOO3::DEM::Bond
template<class Archive>
void save (Archive &, const unsigned int) const
template<class Archive>
void load (Archive &, const unsigned int)
 BOOST_SERIALIZATION_SPLIT_MEMBER ()
Protected Member Functions inherited from GranOO3::Core::Base
 Base ()
Protected Member Functions inherited from GranOO3::Physic::CriticalTimeStep
 CriticalTimeStep ()
 constructor
virtual ~CriticalTimeStep ()
 destructor
Static Protected Member Functions inherited from GranOO3::Core::Base
static unsigned int affect_class_rank_ID ()
Protected Attributes inherited from GranOO3::DEM::Bond
Element * _element1
 the first of the two bonded Element
Element * _element2
 the second of the two bonded Element
double _linear_damping_factor
 the linear damping factor of the bond
double _angular_damping_factor
 the angular damping factor of the bond
double _relaxed_length
 the relaxed length of the bond.
double _current_length
 the current length of the bond that correspond to the norm of the vector between the center of the bonded elements
double _max_relative_elongation
 a threshold corresponding to a maximal admissible relative elongation (the longitudinal strain)
double _surface
 this attribute stores the corresponding normal surface of the bond
Core::SetOfBase< Bond > _slave
 a container that list the slave bond
std::vector< unsigned int > _dofs
 a vector that stores the dof of the bond
Protected Attributes inherited from GranOO3::Physic::BodyInteraction
Body * _body1
 a pointer the first body
Body * _body2
 a pointer the second body
Geom::Vector _torque_on1
 the current value of the applied torque on the body 1
Geom::Vector _torque_on2
 the current value of the applied torque on the body 2
Protected Attributes inherited from GranOO3::Physic::NodeInteraction
const bool _contact_interaction
Node * _node1
Node * _node2
Geom::Vector _force_on1
Geom::Vector _force_on2
Protected Attributes inherited from GranOO3::Core::PropClass< Bond >
std::vector< Core::Prop< Bond > * > _prop

Detailed Description

a bond model that represents an Hertzian contact (non linear contact)

Constructor & Destructor Documentation

◆ HertzSpring() [1/4]

GranOO3::DEM::HertzSpring::HertzSpring ( Element & el1,
Element & el2 )

constructor

Parameters
[in]el1: the first bonded element
[in]el2: the second bonded element

Build a new hertzspring between the Element el1 and el2. Mechanical attributes are set to zero.

◆ HertzSpring() [2/4]

GranOO3::DEM::HertzSpring::HertzSpring ( Element & el1,
Element & el2,
double young_modulus,
double poisson_ratio )

constructor

Parameters
[in]el1: the first bonded element
[in]el2: the second bonded element
[in]young_modulus: the Young's modulus of the hertzspring in [Pa]
[in]poisson_ratio: the Poisson's ratio value of the beam

Build a new hertzspring between the Element el1 and el2 with the required mechanical attributes.

◆ ~HertzSpring()

GranOO3::DEM::HertzSpring::~HertzSpring ( )
virtual

destructor

Destroy a hertzspring instance.

◆ HertzSpring() [3/4]

GranOO3::DEM::HertzSpring::HertzSpring ( )
privatedelete

◆ HertzSpring() [4/4]

GranOO3::DEM::HertzSpring::HertzSpring ( const HertzSpring & )
privatedelete

Member Function Documentation

◆ compute_critical_time_step()

double GranOO3::DEM::HertzSpring::compute_critical_time_step ( ) const
virtual

compute the critical time of the bond

Returns
the maximal time step

Note that this method computes on-the-fly the critical time step.

Implements GranOO3::Physic::CriticalTimeStep.

◆ compute_load()

void GranOO3::DEM::HertzSpring::compute_load ( )
virtual

trigger the computing of the reaction force and torque

Reimplemented from GranOO3::DEM::Bond.

◆ get_angular_stiffness()

double GranOO3::DEM::HertzSpring::get_angular_stiffness ( ) const
virtual

similar as get_linear_stiffness() for rotation (zero for a Hertzian spring)

Reimplemented from GranOO3::DEM::Bond.

◆ get_linear_stiffness()

double GranOO3::DEM::HertzSpring::get_linear_stiffness ( ) const
virtual

compute the linear stiffness of the bond

Returns
the linear stiffness

Reimplemented from GranOO3::DEM::Bond.

◆ info()

std::string GranOO3::DEM::HertzSpring::info ( ) const
virtual

Display some useful info in the terminal.

Reimplemented from GranOO3::DEM::Bond.

◆ init()

void GranOO3::DEM::HertzSpring::init ( )

initialize the hertzspring

This method is used to compute the _equivalent_radius of the hertzian contact

◆ operator=()

HertzSpring & GranOO3::DEM::HertzSpring::operator= ( const HertzSpring & )
privatedelete

◆ process()

void GranOO3::DEM::HertzSpring::process ( )

compute the reaction force (no torque)

This method is used to update the force action on the tow bonded element

◆ serialize()

template<class Archive>
void GranOO3::DEM::HertzSpring::serialize ( Archive & ar,
const unsigned int version )
private

complete serializing of the bond in the *.gdd format

See also
the Domain classes to get additional info about I/O

◆ update()

void GranOO3::DEM::HertzSpring::update ( )
virtual

◆ boost::serialization::access

friend class boost::serialization::access
friend

Member Data Documentation

◆ _contact_radius

double GranOO3::DEM::HertzSpring::_contact_radius
private

the contact radius of the Hertz spring

◆ _contact_surface

double GranOO3::DEM::HertzSpring::_contact_surface
private

the contact surface of the Hertz spring

◆ _direction

Geom::Vector GranOO3::DEM::HertzSpring::_direction
private

the current normal direction of the Hertz spring

◆ _equivalent_radius

double GranOO3::DEM::HertzSpring::_equivalent_radius
private

the equivalent radius of the Hertz spring

◆ _force

Geom::Vector GranOO3::DEM::HertzSpring::_force
private

the current normal force of the Hertz spring

◆ _poisson_ratio

double GranOO3::DEM::HertzSpring::_poisson_ratio
private

the Poisson's ratio of the bond in [-]

◆ _stiffness

double GranOO3::DEM::HertzSpring::_stiffness
private

the equivalent stiffness of the Hertz spring

◆ _young_modulus

double GranOO3::DEM::HertzSpring::_young_modulus
private

the Young's modulus value of the bond in [Pa]


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