 |
revision: v0.14
|
Go to the documentation of this file.
161 void write(std::ostream& os)
const override;
166 void read(std::istream& is)
override;
Mdouble getInteractionDistance() const
returns the largest separation distance at which adhesive short-range forces can occur.
Definition: BaseSpecies.h:146
Definition: BaseAdhesiveForce.h:31
SpeciesHandler * getHandler() const
Returns the pointer to the handler to which this species belongs.
Definition: BaseSpecies.cc:99
BaseFrictionForce * getFrictionForce() const
Definition: BaseSpecies.h:150
BaseAdhesiveForce * getAdhesiveForce() const
Definition: BaseSpecies.h:152
~BaseSpecies()
The default destructor.
Definition: BaseSpecies.cc:64
BaseAdhesiveForce * adhesiveForce_
A pointer to the adhesive force parameters \detail This pointer is used by the Interaction's to get a...
Definition: BaseSpecies.h:187
void setConstantRestitution(bool constantRestitution)
Definition: BaseNormalForce.cc:29
void setInteractionDistance(Mdouble interactionDistance)
Definition: BaseSpecies.cc:156
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
Mdouble interactionDistance_
Definition: BaseSpecies.h:201
BaseNormalForce * normalForce_
A pointer to the normal force parameters \detail This pointer is used by the Interaction's to get a p...
Definition: BaseSpecies.h:173
Definition: BaseNormalForce.h:31
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:55
void write(std::ostream &os) const override
Sets the boolean constantRestitution_.
Definition: BaseSpecies.cc:131
SpeciesHandler * handler_
A pointer to the handler to which this species belongs. It is initialized to nullptr and gets set whe...
Definition: BaseSpecies.h:195
Stores information about interactions between two interactable objects; often particles but could be ...
Definition: BaseInteraction.h:60
virtual void copyInto(BaseSpecies *s) const =0
double Mdouble
Definition: GeneralDefine.h:34
BaseSpecies is the class from which all other species are derived.
Definition: BaseSpecies.h:50
const std::vector< BaseSpecies * > & getMixedObjects() const
Returns a pointer to the vector of all mixed objects.
Definition: SpeciesHandler.cc:751
Container to store all ParticleSpecies.
Definition: SpeciesHandler.h:37
static Mdouble average(Mdouble a, Mdouble b)
Returns the harmonic mean of two variables.
Definition: BaseSpecies.cc:110
virtual BaseInteraction * getEmptyInteraction() const =0
void setHandler(SpeciesHandler *handler)
Sets the pointer to the handler to which this species belongs.
Definition: BaseSpecies.cc:91
BaseNormalForce * getNormalForce() const
Definition: BaseSpecies.h:148
virtual BaseSpecies * copy() const =0
Creates a deep copy of the object from which it is called.
static Mdouble averageInf(Mdouble a, Mdouble b)
Returns the harmonic mean of two variables, returning inf if either is inf.
Definition: BaseSpecies.cc:120
virtual void mixAll(BaseSpecies *S, BaseSpecies *T)=0
creates default values for mixed species
It is an abstract base class due to the purely virtual functions declared below. Even if the function...
Definition: BaseObject.h:51
bool getConstantRestitution() const
Definition: BaseNormalForce.h:45
T * getObject(const unsigned int id)
Gets a pointer to the Object at the specified index in the BaseHandler.
Definition: BaseHandler.h:613
void read(std::istream &is) override
Definition: BaseSpecies.cc:140
unsigned int getId() const
Returns the unique identifier of any particular object.
Definition: BaseObject.h:125
BaseSpecies()
The default constructor.
Definition: BaseSpecies.cc:38
Definition: BaseParticle.h:54
virtual BaseInteraction * getNewInteraction(BaseInteractable *P, BaseInteractable *I, unsigned timeStamp) const =0
returns new Interaction object.
Definition: BaseFrictionForce.h:31
void setMaxInteractionDistance(Mdouble interactionDistance=0)
Sets maxInteractionDistance_.
Definition: ParticleSpecies.cc:220
BaseFrictionForce * frictionForce_
A pointer to the friction force parameters \detail This pointer is used by the Interaction's to get a...
Definition: BaseSpecies.h:180
bool readOptionalVariable(std::istream &is, const std::string &name, T &variable)
Reads optional variables in the restart file.
Definition: Helpers.h:247
void setBaseSpecies(BaseSpecies *baseSpecies)
Definition: BaseForce.h:40
virtual bool getUseAngularDOFs() const =0
Returns true if torques (i.e. angular degrees of freedom) have to be calculated.
const Mdouble inf
Definition: GeneralDefine.h:44
virtual void deleteEmptyInteraction(BaseInteraction *interaction) const =0