revision: v0.14
SinterInteraction.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 
26 #ifndef SINTERINTERACTION_H
27 #define SINTERINTERACTION_H
28 
30 
32 
33 class BaseInteractable;
34 
39 class SinterInteraction : public virtual BaseInteraction
40 {
41 public:
46 
50  SinterInteraction(BaseInteractable* P, BaseInteractable* I, unsigned timeStamp);
51 
56 
59 
63  ~SinterInteraction() override;
67  //BaseInteraction* copy() const;
71  void computeNormalForce();
72 
76  void read(std::istream& is) override;
77 
81  void write(std::ostream& os) const override;
82 
86  virtual std::string getBaseName() const;
87 
91  Mdouble getElasticEnergy() const override;
92 
96  const SinterNormalSpecies* getSpecies() const;
97 
101  Mdouble getPlasticOverlap() const;
102 
106  void setPlasticOverlap(Mdouble plasticOverlap);
107 
112 
113  unsigned getNumberOfFieldsVTK() const override;
114 
115  std::string getTypeVTK(unsigned i) const override;
116 
117  std::string getNameVTK(unsigned i) const override;
118 
119  std::vector<Mdouble> getFieldVTK(unsigned i) const override;
120 
121 private:
122 
123  //set in integrate, used in compute force
125 };
126 
127 #endif
BaseInteraction::getNormalRelativeVelocity
Mdouble getNormalRelativeVelocity() const
Returns a double which is the norm (length) of the relative velocity vector.
Definition: BaseInteraction.cc:536
SinterNormalSpecies::getTemperatureDependentSinterRate
std::function< double(double temperature)> getTemperatureDependentSinterRate() const
Definition: SinterNormalSpecies.cc:474
SinterInteraction::write
void write(std::ostream &os) const override
Interaction write function, which accepts an std::ostream as input.
Definition: SinterInteraction.cc:77
SinterInteraction
Computes normal forces in case of a linear plastic visco-elastic interaction.
Definition: SinterInteraction.h:40
mathsFunc::square
T square(const T val)
squares a number
Definition: ExtendedMath.h:106
SinterNormalSpecies::getSurfTension
Mdouble getSurfTension() const
Definition: SinterNormalSpecies.cc:449
BaseInteraction::getHandler
InteractionHandler * getHandler() const
Gets a point to the interaction handlers to which this interaction belongs.
Definition: BaseInteraction.cc:269
DPMBase::getTimeStep
Mdouble getTimeStep() const
Returns the simulation time step.
Definition: DPMBase.cc:1241
constants::pi
const Mdouble pi
Definition: ExtendedMath.h:45
BaseInteraction::getRelativeVelocity
const Vec3D & getRelativeVelocity() const
Returns a constant reference to a vector of relative velocity.
Definition: BaseInteraction.cc:525
SinterNormalSpecies::getSeparationDis
Mdouble getSeparationDis() const
Definition: SinterNormalSpecies.cc:459
SINTERTYPE::PARHAMI_MCKEEPING
@ PARHAMI_MCKEEPING
SinterNormalSpecies::getComplianceZero
Mdouble getComplianceZero() const
Definition: SinterNormalSpecies.cc:444
BaseInteraction::setRelativeVelocity
void setRelativeVelocity(Vec3D relativeVelocity)
set the relative velocity of the current of the interactions.
Definition: BaseInteraction.cc:601
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
BaseInteraction::setAbsoluteNormalForce
void setAbsoluteNormalForce(Mdouble absoluteNormalForce)
the absolute values of the norm (length) of the normal force
Definition: BaseInteraction.cc:622
BaseInteraction::setTorque
void setTorque(Vec3D torque)
set the total force (this is used by the normal force, tangential torques are added use addTorque)
Definition: BaseInteraction.cc:590
BaseInteraction::getBaseSpecies
const BaseSpecies * getBaseSpecies() const
Return a constant point to BaseSpecies of the interaction.
Definition: BaseInteraction.cc:634
SinterNormalSpecies::getSinterRate
Mdouble getSinterRate() const
Accesses sinterRate_.
Definition: SinterNormalSpecies.cc:439
BaseInteraction::getI
BaseInteractable * getI()
Returns a pointer to the second object involved in the interaction (often a wall or a particle).
Definition: BaseInteraction.h:280
BaseInteraction::read
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
Definition: BaseInteraction.cc:186
Vec3D::dot
static Mdouble dot(const Vec3D &a, const Vec3D &b)
Calculates the dot product of two Vec3D: .
Definition: Vector.cc:76
BaseInteraction::setNormalRelativeVelocity
void setNormalRelativeVelocity(Mdouble normalRelativeVelocit)
set the normal component of the relative velocity.
Definition: BaseInteraction.cc:612
SinterInteraction::read
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
Definition: SinterInteraction.cc:87
SinterInteraction::getFieldVTK
std::vector< Mdouble > getFieldVTK(unsigned i) const override
Definition: SinterInteraction.cc:350
BaseInteraction::setForce
void setForce(Vec3D force)
set total force (this is used by the normal force, tangential forces are added use addForce)
Definition: BaseInteraction.cc:579
BaseInteractable
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:55
Vec3D
Definition: Vector.h:50
SinterInteraction::getBaseName
virtual std::string getBaseName() const
Returns the name of the interaction.
Definition: SinterInteraction.cc:97
BaseInteraction::getContactPoint
const Vec3D & getContactPoint() const
Gets constant reference to contact point (vector).
Definition: BaseInteraction.h:234
BaseInteraction
Stores information about interactions between two interactable objects; often particles but could be ...
Definition: BaseInteraction.h:60
SinterInteraction::~SinterInteraction
~SinterInteraction() override
Destructor.
Definition: SinterInteraction.cc:66
SinterInteraction::getSpecies
const SinterNormalSpecies * getSpecies() const
Definition: SinterInteraction.cc:294
BaseInteraction::write
void write(std::ostream &os) const override
Interaction print function, which accepts an std::ostream as input.
Definition: BaseInteraction.cc:159
SinterNormalSpecies::getUnloadingStiffnessMax
Mdouble getUnloadingStiffnessMax() const
Returns the maximum unloading stiffness of the linear plastic-viscoelastic normal force.
Definition: SinterNormalSpecies.cc:191
SinterInteraction.h
SinterNormalSpecies::getCohesionStiffness
Mdouble getCohesionStiffness() const
Returns the cohesive stiffness of the linear plastic-viscoelastic normal force.
Definition: SinterNormalSpecies.cc:199
SinterNormalSpecies::getSinterType
SINTERTYPE getSinterType() const
Definition: SinterNormalSpecies.cc:464
double
SinterNormalSpecies::getPenetrationDepthMax
Mdouble getPenetrationDepthMax() const
Returns the maximum penetration depth of the linear plastic-viscoelastic normal force.
Definition: SinterNormalSpecies.cc:207
BaseInteraction::getOverlap
Mdouble getOverlap() const
Returns a Mdouble with the current overlap between the two interacting objects.
Definition: BaseInteraction.h:240
SinterInteraction::setPlasticOverlap
void setPlasticOverlap(Mdouble plasticOverlap)
Definition: SinterInteraction.cc:311
SinterNormalSpecies::getConstantC1
Mdouble getConstantC1() const
Definition: SinterNormalSpecies.cc:454
BaseInteraction::getNormal
const Vec3D & getNormal() const
Gets the normal vector between the two interacting objects.
Definition: BaseInteraction.h:226
SinterInteraction::plasticOverlap_
Mdouble plasticOverlap_
Definition: SinterInteraction.h:124
SinterNormalSpecies::getLoadingStiffness
Mdouble getLoadingStiffness() const
Returns the loading stiffness of the linear plastic-viscoelastic normal force.
Definition: SinterNormalSpecies.cc:183
BaseSpecies::getNormalForce
BaseNormalForce * getNormalForce() const
Definition: BaseSpecies.h:148
SinterNormalSpecies.h
DPMBase.h
BaseInteraction.h
SinterInteraction::SinterInteraction
SinterInteraction()
SinterInteraction::getTypeVTK
std::string getTypeVTK(unsigned i) const override
Definition: SinterInteraction.cc:337
ThermalParticle
Definition: ThermalParticle.h:36
constants::i
const std::complex< Mdouble > i
Definition: ExtendedMath.h:51
SinterInteraction::SpeciesType
SinterNormalSpecies SpeciesType
An alias for the corresponding species.
Definition: SinterInteraction.h:45
SinterInteraction::getUnloadingStiffness
Mdouble getUnloadingStiffness() const
Definition: SinterInteraction.cc:319
SinterInteraction::getNameVTK
std::string getNameVTK(unsigned i) const override
Definition: SinterInteraction.cc:342
BaseHandler::getDPMBase
DPMBase * getDPMBase()
Gets the problem that is solved using this handler.
Definition: BaseHandler.h:725
SinterInteraction::computeNormalForce
void computeNormalForce()
Creates a copy of an object of this class. (Deep copy)
Definition: SinterInteraction.cc:105
SinterInteraction::getNumberOfFieldsVTK
unsigned getNumberOfFieldsVTK() const override
Definition: SinterInteraction.cc:332
ThermalParticle.h
SinterNormalSpecies::getSinterAdhesion
Mdouble getSinterAdhesion() const
Accesses sinterAdhesion_.
Definition: SinterNormalSpecies.cc:423
SinterNormalSpecies::getDissipation
Mdouble getDissipation() const
Allows the normal dissipation to be accessed.
Definition: SinterNormalSpecies.cc:415
SinterNormalSpecies
SinterNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan ...
Definition: SinterNormalSpecies.h:47
SinterInteraction::getElasticEnergy
Mdouble getElasticEnergy() const override
Computes and returns the amount of elastic energy stored in the spring.
Definition: SinterInteraction.cc:282
SinterInteraction::getPlasticOverlap
Mdouble getPlasticOverlap() const
Definition: SinterInteraction.cc:303
BaseInteraction::getEffectiveRadius
Mdouble getEffectiveRadius() const
Returns a Mdouble to the effective radius of the interaction. (Not corrected for the overlap)
Definition: BaseInteraction.cc:745
InteractionHandler.h
BaseParticle.h
ThermalParticle::getTemperature
Mdouble getTemperature() const
Definition: ThermalParticle.h:101
DPMBase
The DPMBase header includes quite a few header files, defining all the handlers, which are essential....
Definition: DPMBase.h:76
BaseInteraction::getP
BaseInteractable * getP()
Returns a pointer to first object involved in the interaction (normally a particle).
Definition: BaseInteraction.h:269