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 BaseAdhesiveForce
virtual void	setInteractionDistance ()
Public Member Functions inherited from BaseForce
BaseSpecies *	getBaseSpecies () const
void	setBaseSpecies (BaseSpecies *baseSpecies)

Detailed Description

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

Member Typedef Documentation

InteractionType

typedef EmptyAdhesiveInteraction EmptyAdhesiveSpecies::InteractionType

The correct Interaction type for this AdhesiveForceSpecies.

Constructor & Destructor Documentation

EmptyAdhesiveSpecies() [1/2]

EmptyAdhesiveSpecies::EmptyAdhesiveSpecies

(

)

The default constructor.

{
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"EmptyAdhesiveSpecies::EmptyAdhesiveSpecies() finished"<<std::endl;
#endif
}

EmptyAdhesiveSpecies() [2/2]

EmptyAdhesiveSpecies::EmptyAdhesiveSpecies

(

const EmptyAdhesiveSpecies &s

UNUSED

)

The default copy constructor.

Parameters

[in]

the

species that is copied

{
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"EmptyAdhesiveSpecies::EmptyAdhesiveSpecies(const EmptyAdhesiveSpecies &p) finished"<<std::endl;
#endif
}

~EmptyAdhesiveSpecies()

EmptyAdhesiveSpecies::~EmptyAdhesiveSpecies

(

)

The default destructor.

{
#ifdef DEBUG_DESTRUCTOR
    std::cout<<"EmptyAdhesiveSpecies::~EmptyAdhesiveSpecies() finished"<<std::endl;
#endif
}

Member Function Documentation

getBaseName()

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

{
    return "";
}

mix()

void EmptyAdhesiveSpecies::mix	(	EmptyAdhesiveSpecies * S	UNUSED,
		EmptyAdhesiveSpecies * T	UNUSED
	)

creates default values for mixed species

Parameters

[in]

S,T

the two species whose properties are mixed to create the new species

{
}

read()

void EmptyAdhesiveSpecies::read

(

std::istream &

is

)

Reads the species properties from an input stream.

Parameters

[in]

input

stream (typically the restart file)

{
}

write()

void EmptyAdhesiveSpecies::write

(

std::ostream &

os

)

const

Writes the species properties to an output stream.

Parameters

[out]

output

stream (typically the restart file)

{
}

---

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

• EmptyAdhesiveSpecies.h
• EmptyAdhesiveSpecies.cc