MercuryDPM  Alpha
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SinterInteraction.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2014, 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 
31 class BaseInteractable;
36 class SinterInteraction : public virtual BaseInteraction
37 {
38 public:
54  virtual ~SinterInteraction();
58  //BaseInteraction* copy() const;
62  void computeNormalForce();
66  virtual void read(std::istream& is);
70  virtual void write(std::ostream& os) const;
74  virtual std::string getBaseName() const;
78  Mdouble getElasticEnergy() const;
82  const SinterNormalSpecies* getSpecies() const;
86  Mdouble getPlasticOverlap() const;
90  void setPlasticOverlap(const Mdouble plasticOverlap);
95 
96  unsigned getNumberOfFieldsVTK() const override;
97 
98  std::string getTypeVTK(unsigned i) const override;
99 
100  std::string getNameVTK(unsigned i) const override;
101 
102  std::vector<Mdouble> getFieldVTK(unsigned i) const override;
103 
104 private:
105 
106  //set in integrate, used in compute force
108 };
109 #endif
double Mdouble
virtual ~SinterInteraction()
Destructor.
std::vector< Mdouble > getFieldVTK(unsigned i) const override
Mdouble getElasticEnergy() const
Computes and returns the amount of elastic energy stored in the spring.
Mdouble getUnloadingStiffness() const
Stores information about interactions between two interactable objects; often particles but could be ...
virtual void read(std::istream &is)
Interaction read function, which accepts an std::istream as input.
SinterInteraction(BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp)
Constructor.
std::string getTypeVTK(unsigned i) const override
void computeNormalForce()
Creates a copy of an object of this class. (Deep copy)
std::string getNameVTK(unsigned i) const override
void setPlasticOverlap(const Mdouble plasticOverlap)
SinterNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan ...
unsigned getNumberOfFieldsVTK() const override
Mdouble getPlasticOverlap() const
SinterNormalSpecies SpeciesType
An alias for the corresponding species.
virtual std::string getBaseName() const
Returns the name of the interaction.
virtual void write(std::ostream &os) const
Interaction write function, which accepts an std::ostream as input.
Defines the basic properties that a interactable object can have.
Computes normal forces in case of a linear plastic visco-elastic interaction.
const SinterNormalSpecies * getSpecies() const