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
BaseSpecies *	getBaseSpecies () const
void	setBaseSpecies (BaseSpecies *baseSpecies)

Detailed Description

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

Member Typedef Documentation

InteractionType

typedef EmptyFrictionInteraction EmptyFrictionSpecies::InteractionType

The correct Interaction type for this FrictionForceSpecies.

Constructor & Destructor Documentation

EmptyFrictionSpecies() [1/2]

EmptyFrictionSpecies::EmptyFrictionSpecies

(

)

The default constructor.

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

EmptyFrictionSpecies() [2/2]

EmptyFrictionSpecies::EmptyFrictionSpecies

(

const EmptyFrictionSpecies &s

UNUSED

)

The default copy constructor.

Parameters

[in]

the

species that is copied

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

~EmptyFrictionSpecies()

EmptyFrictionSpecies::~EmptyFrictionSpecies

(

)

The default destructor.

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

Member Function Documentation

getBaseName()

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

{
    return "";
}

getUseAngularDOFs()

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.

Reimplemented in Species< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >, Species< LinearViscoelasticNormalSpecies >, and MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >.

{
    return false;
}

mix()

void EmptyFrictionSpecies::mix	(	EmptyFrictionSpecies * S	UNUSED,
		EmptyFrictionSpecies * 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 EmptyFrictionSpecies::read

(

std::istream &

is

)

Reads the species properties from an input stream.

Parameters

[in]

input

stream (typically the restart file)

{
}

write()

void EmptyFrictionSpecies::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:

• EmptyFrictionSpecies.h
• EmptyFrictionSpecies.cc