HertzianBSHPViscoelasticNormalSpecies contains the parameters used to describe a Hertzian normal force (The Mindlin model). More...

#include <HertzianBSHPViscoelasticNormalSpecies.h>

Inheritance diagram for HertzianBSHPViscoelasticNormalSpecies:

Public Types
typedef HertzianBSHPViscoelasticInteraction	InteractionType
	The correct Interaction type for this FrictionForceSpecies. More...

Public Types inherited from HertzianViscoelasticNormalSpecies
typedef HertzianViscoelasticInteraction	InteractionType
	The correct Interaction type for this FrictionForceSpecies. More...

Public Member Functions
	HertzianBSHPViscoelasticNormalSpecies ()
	The default constructor. More...

	HertzianBSHPViscoelasticNormalSpecies (const HertzianBSHPViscoelasticNormalSpecies &p)
	The default copy constructor. More...

	~HertzianBSHPViscoelasticNormalSpecies ()
	The default destructor. More...

std::string	getBaseName () const override
	Used in Species::getName to obtain a unique name for each Species. More...

void	setEffectiveElasticModulusAndRestitutionCoefficient (Mdouble elasticModulus, Mdouble rest) override
	Allows the spring constant to be changed. More...

Public Member Functions inherited from HertzianViscoelasticNormalSpecies
	HertzianViscoelasticNormalSpecies ()
	The default constructor. More...

	HertzianViscoelasticNormalSpecies (const HertzianViscoelasticNormalSpecies &p)
	The default copy constructor. More...

	~HertzianViscoelasticNormalSpecies ()
	The default destructor. More...

void	read (std::istream &is)
	Reads the species properties from an input stream. More...

void	write (std::ostream &os) const
	Writes the species properties to an output stream. More...

Mdouble	getCollisionTime (Mdouble particleDiameter, Mdouble particleDensity, Mdouble relativeVelocity) const
	Used in Species::getName to obtain a unique name for each Species. More...

Public Member Functions inherited from BaseNormalForce
	BaseNormalForce ()

	BaseNormalForce (const BaseNormalForce &p)

bool	getConstantRestitution () const

void	setConstantRestitution (bool constantRestitution)

virtual void	actionsAfterTimeStep (BaseParticle *particle) const

Public Member Functions inherited from BaseForce
BaseSpecies *	getBaseSpecies () const

void	setBaseSpecies (BaseSpecies *baseSpecies)

Detailed Description

HertzianBSHPViscoelasticNormalSpecies contains the parameters used to describe a Hertzian normal force (The Mindlin model).

See HertzianViscoelasticNormalInteraction::computeForce for a description of the force law.

Member Typedef Documentation

◆ InteractionType

typedef HertzianBSHPViscoelasticInteraction HertzianBSHPViscoelasticNormalSpecies::InteractionType

The correct Interaction type for this FrictionForceSpecies.

Constructor & Destructor Documentation

◆ HertzianBSHPViscoelasticNormalSpecies() [1/2]

HertzianBSHPViscoelasticNormalSpecies::HertzianBSHPViscoelasticNormalSpecies ( )

The default constructor.

         : HertzianViscoelasticNormalSpecies()
 {
 #ifdef DEBUG_CONSTRUCTOR
     std::cout<<"HertzianBSHPViscoelasticNormalSpecies::HertzianBSHPViscoelasticNormalSpecies() finished"<<std::endl;
 #endif
 }

◆ HertzianBSHPViscoelasticNormalSpecies() [2/2]

HertzianBSHPViscoelasticNormalSpecies::HertzianBSHPViscoelasticNormalSpecies ( const HertzianBSHPViscoelasticNormalSpecies & p )

The default copy constructor.

Parameters

[in] the species that is copied

         : HertzianViscoelasticNormalSpecies(p)
 {
 #ifdef DEBUG_CONSTRUCTOR
     std::cout<<"HertzianBSHPViscoelasticNormalSpecies::HertzianBSHPViscoelasticNormalSpecies(const HertzianBSHPViscoelasticNormalSpecies &p) finished"<<std::endl;
 #endif
 }

◆ ~HertzianBSHPViscoelasticNormalSpecies()

HertzianBSHPViscoelasticNormalSpecies::~HertzianBSHPViscoelasticNormalSpecies ( )

The default destructor.

 {
 #ifdef DEBUG_DESTRUCTOR
     std::cout<<"HertzianBSHPViscoelasticNormalSpecies::~HertzianBSHPViscoelasticNormalSpecies() finished"<<std::endl;
 #endif
 }

Member Function Documentation

◆ getBaseName()

std::string HertzianBSHPViscoelasticNormalSpecies::getBaseName ( ) const

overridevirtual

Used in Species::getName to obtain a unique name for each Species.

Returns: a string containing the name of the species (minus the word "Species")

Reimplemented from HertzianViscoelasticNormalSpecies.

 {
     return "HertzianBSHPViscoelastic";
 }

◆ setEffectiveElasticModulusAndRestitutionCoefficient()

void HertzianBSHPViscoelasticNormalSpecies::setEffectiveElasticModulusAndRestitutionCoefficient	(	Mdouble	elasticModulus,
		Mdouble	rest
	)

override

Allows the spring constant to be changed.

 {
  
     logger(ERROR,
            "[HertzianBSHPViscoelasticNormalSpecies::setEffectiveElasticModulusAndRestitutionCoefficient] This function is not supported for the chosen contact model.");
 }

References ERROR, and logger.

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

Public Types

Public Member Functions