MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
EmptyFrictionSpecies Class Reference

EmptyFrictionSpecies is used to create a force law without frictional forces. More...

#include <EmptyFrictionSpecies.h>

+ Inheritance diagram for EmptyFrictionSpecies:

Public Types

typedef EmptyFrictionInteraction InteractionType
 The correct Interaction type for this FrictionForceSpecies. More...
 

Public Member Functions

 EmptyFrictionSpecies ()
 The default constructor. More...
 
 EmptyFrictionSpecies (const EmptyFrictionSpecies &s UNUSED)
 The default copy constructor. More...
 
 ~EmptyFrictionSpecies ()
 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...
 
std::string getBaseName () const
 Used in Species::getName to obtain a unique name for each Species. More...
 
bool getUseAngularDOFs () const override
 Returns true if torques have to be calculated. More...
 
void mix (EmptyFrictionSpecies *S, EmptyFrictionSpecies *T)
 creates default values for mixed species More...
 
- Public Member Functions inherited from BaseForce
BaseSpeciesgetBaseSpecies () const
 
void setBaseSpecies (BaseSpecies *baseSpecies)
 

Detailed Description

EmptyFrictionSpecies is used to create a force law without frictional forces.

Definition at line 41 of file EmptyFrictionSpecies.h.

Member Typedef Documentation

Constructor & Destructor Documentation

EmptyFrictionSpecies::EmptyFrictionSpecies ( )

The default constructor.

Definition at line 28 of file EmptyFrictionSpecies.cc.

29 {
30 #ifdef DEBUG_CONSTRUCTOR
31  std::cout<<"EmptySpecies::EmptySpecies() finished"<<std::endl;
32 #endif
33 }
EmptyFrictionSpecies::EmptyFrictionSpecies ( const EmptyFrictionSpecies &s  UNUSED)

The default copy constructor.

Parameters
[in]thespecies that is copied

Definition at line 38 of file EmptyFrictionSpecies.cc.

39 {
40 #ifdef DEBUG_CONSTRUCTOR
41  std::cout<<"EmptySpecies::EmptySpecies(const EmptySpecies &p) finished"<<std::endl;
42 #endif
43 }
EmptyFrictionSpecies::~EmptyFrictionSpecies ( )

The default destructor.

Definition at line 45 of file EmptyFrictionSpecies.cc.

46 {
47 #ifdef DEBUG_DESTRUCTOR
48  std::cout<<"EmptySpecies::~EmptySpecies() finished"<<std::endl;
49 #endif
50 }

Member Function Documentation

std::string EmptyFrictionSpecies::getBaseName ( ) const

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")

Definition at line 69 of file EmptyFrictionSpecies.cc.

70 {
71  return "";
72 }
bool EmptyFrictionSpecies::getUseAngularDOFs ( ) const
overridevirtual

Returns true if torques have to be calculated.

Returns true for any FrictionForceSpecies except EmptyFrictionSpecies, because for spherical particles, torques are only caused by tangential forces. See SpeciesHandler::useAngularDOFs for more details

Returns
false

Implements BaseFrictionForce.

Definition at line 87 of file EmptyFrictionSpecies.cc.

88 {
89  return false;
90 }
void EmptyFrictionSpecies::mix ( EmptyFrictionSpecies * S  UNUSED,
EmptyFrictionSpecies * T  UNUSED 
)

creates default values for mixed species

Parameters
[in]S,Tthe two species whose properties are mixed to create the new species

Definition at line 77 of file EmptyFrictionSpecies.cc.

78 {
79 }
void EmptyFrictionSpecies::read ( std::istream &  is)

Reads the species properties from an input stream.

Parameters
[in]inputstream (typically the restart file)

Definition at line 62 of file EmptyFrictionSpecies.cc.

63 {
64 }
void EmptyFrictionSpecies::write ( std::ostream &  os) const

Writes the species properties to an output stream.

Parameters
[out]outputstream (typically the restart file)

Definition at line 55 of file EmptyFrictionSpecies.cc.

56 {
57 }

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