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

EmptyAdhesiveSpecies is used to create a force law without a short-range adhesive force. More...

#include <EmptyAdhesiveSpecies.h>

+ Inheritance diagram for EmptyAdhesiveSpecies:

Public Types

typedef EmptyAdhesiveInteraction InteractionType
 The correct Interaction type for this AdhesiveForceSpecies. More...
 

Public Member Functions

 EmptyAdhesiveSpecies ()
 The default constructor. More...
 
 EmptyAdhesiveSpecies (const EmptyAdhesiveSpecies &s UNUSED)
 The default copy constructor. More...
 
 ~EmptyAdhesiveSpecies ()
 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...
 
void mix (EmptyAdhesiveSpecies *S, EmptyAdhesiveSpecies *T)
 creates default values for mixed species More...
 
- Public Member Functions inherited from BaseForce
BaseSpeciesgetBaseSpecies () const
 
void setBaseSpecies (BaseSpecies *baseSpecies)
 

Detailed Description

EmptyAdhesiveSpecies is used to create a force law without a short-range adhesive force.

Definition at line 37 of file EmptyAdhesiveSpecies.h.

Member Typedef Documentation

Constructor & Destructor Documentation

EmptyAdhesiveSpecies::EmptyAdhesiveSpecies ( )

The default constructor.

Definition at line 29 of file EmptyAdhesiveSpecies.cc.

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

The default copy constructor.

Parameters
[in]thespecies that is copied

Definition at line 39 of file EmptyAdhesiveSpecies.cc.

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

The default destructor.

Definition at line 46 of file EmptyAdhesiveSpecies.cc.

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

Member Function Documentation

std::string EmptyAdhesiveSpecies::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 70 of file EmptyAdhesiveSpecies.cc.

71 {
72  return "";
73 }
void EmptyAdhesiveSpecies::mix ( EmptyAdhesiveSpecies * S  UNUSED,
EmptyAdhesiveSpecies * 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 78 of file EmptyAdhesiveSpecies.cc.

79 {
80 }
void EmptyAdhesiveSpecies::read ( std::istream &  is)

Reads the species properties from an input stream.

Parameters
[in]inputstream (typically the restart file)

Definition at line 63 of file EmptyAdhesiveSpecies.cc.

64 {
65 }
void EmptyAdhesiveSpecies::write ( std::ostream &  os) const

Writes the species properties to an output stream.

Parameters
[out]outputstream (typically the restart file)

Definition at line 56 of file EmptyAdhesiveSpecies.cc.

57 {
58 }

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