MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies > Class Template Reference

Contains contact force properties for contacts between particles with two different species. More...

#include <MixedSpecies.h>

Inheritance diagram for MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >:

Public Member Functions
	MixedSpecies ()
	The default constructor. More...
	MixedSpecies (const MixedSpecies &s)
	The default copy constructor. More...
	MixedSpecies (const Species< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies > &s)
	Creates a mixed species with the same force properties as a Species. More...
virtual	~MixedSpecies ()
	The default destructor. More...
MixedSpecies < NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies > *	copy () const
	Creates a deep copy of the MixedSpecies from which it is called. More...
void	read (std::istream &is)
	Reads the species properties from an input stream. More...
void	write (std::ostream &os) const
	Writes the MixedSpecies properties to an output stream. More...
std::string	getName () const
	Returns the name of the MixedSpecies as it is used in the restart file. More...
BaseInteraction *	getNewInteraction (BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp)
	When a contact between two particles is determined, an Interaction object is created, as the type of Interaction depends on the MixedSpecies type. More...
bool	getUseAngularDOFs () const
	Returns true if torques have to be calculated. More...
void	mixAll (BaseSpecies *const S, BaseSpecies *const T)
	sets the MixedSpecies properties by mixing the properties of two particle species More...
Mdouble	getInteractionDistance () const
	Returns the particle distance below which adhesive forces can occur (needed for contact detection) More...

Detailed Description

template<class NormalForceSpecies, class FrictionForceSpecies = EmptyFrictionSpecies, class AdhesiveForceSpecies = EmptyAdhesiveSpecies>
class MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >

Contains contact force properties for contacts between particles with two different species.

See Species for details.

Definition at line 40 of file MixedSpecies.h.

Constructor & Destructor Documentation

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::MixedSpecies

(

)

The default constructor.

Definition at line 92 of file MixedSpecies.h.

: BaseSpecies(), NormalForceSpecies(), FrictionForceSpecies(), AdhesiveForceSpecies()
{
#ifdef DEBUG_CONSTRUCTOR
    std::cout << "MixedSpecies::MixedSpecies() finished" << std::endl;
#endif
}

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::MixedSpecies

(

const MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies > &

s

)

The default copy constructor.

Definition at line 101 of file MixedSpecies.h.

: BaseSpecies(s), NormalForceSpecies(s), FrictionForceSpecies(s), AdhesiveForceSpecies(s)
{
#ifdef DEBUG_CONSTRUCTOR
    std::cout << "MixedSpecies::MixedSpecies(const MixedSpecies &p) finished" << std::endl;
#endif
}

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::MixedSpecies

(

const Species< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies > &

s

)

Creates a mixed species with the same force properties as a Species.

Definition at line 110 of file MixedSpecies.h.

: BaseSpecies(s), NormalForceSpecies(s), FrictionForceSpecies(s), AdhesiveForceSpecies(s)
{
#ifdef DEBUG_CONSTRUCTOR
    std::cout << "MixedSpecies::MixedSpecies(const MixedSpecies &p) finished" << std::endl;
#endif
}

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::~MixedSpecies ( )

virtual

The default destructor.

Definition at line 119 of file MixedSpecies.h.

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

Member Function Documentation

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies > * MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::copy

(

)

const

Creates a deep copy of the MixedSpecies from which it is called.

MixedSpecies copy method. It calls to copy constructor of this MixedSpecies, useful for polymorphism.

Definition at line 129 of file MixedSpecies.h.

{
    return new MixedSpecies(*this);
}

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

Mdouble MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::getInteractionDistance

(

)

const

Returns the particle distance below which adhesive forces can occur (needed for contact detection)

Definition at line 238 of file MixedSpecies.h.

{
    return AdhesiveForceSpecies::getInteractionDistance();
}

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

std::string MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::getName

(

)

const

Returns the name of the MixedSpecies as it is used in the restart file.

Returns the name of the MixedSpecies as it is used in the restart file. The name of the species is a concatenation of the names of the three force components, e.g.

MixedSpecies<LinearViscoelasticNormalSpecies,SlidingFrictionSpecies,ReversibleAdhesiveSpecies> species; std::cout << species.getName();

will output "LinearViscoelasticSlidingFrictionReversibleAdhesiveMixedSpecies". The EmptyFrictionSpecies and the EmptyAdhesiveSpecies return empty strings, such that

MixedSpecies<LinearViscoelasticNormalSpecies> species; std::cout << species.getName();

will output "LinearViscoelasticMixedSpecies".

Returns

The name of the MixedSpecies.

Definition at line 188 of file MixedSpecies.h.

{
    return NormalForceSpecies::getBaseName()
        + FrictionForceSpecies::getBaseName()
        + AdhesiveForceSpecies::getBaseName() + "MixedSpecies";
}

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

BaseInteraction * MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::getNewInteraction	(	BaseInteractable *	P,
		BaseInteractable *	I,
		Mdouble	timeStamp
	)

When a contact between two particles is determined, an Interaction object is created, as the type of Interaction depends on the MixedSpecies type.

The input parameters of this function are directly passed into the constructor for the new interaction. See Interaction for details.

Parameters

[in]	P	first of the two objects that interact
[in]	I	second of the two objects that interact
[in]	timeStamp	current value of DPMBase::time_

Returns

pointer to the newly created Interaction.

Definition at line 204 of file MixedSpecies.h.

{
    return new Interaction<typename NormalForceSpecies::InteractionType, typename FrictionForceSpecies::InteractionType, typename AdhesiveForceSpecies::InteractionType > (P, I, timeStamp);
}

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

bool MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::getUseAngularDOFs

(

)

const

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

true iff torques have to be calculated

Definition at line 216 of file MixedSpecies.h.

{
    return FrictionForceSpecies::getUseAngularDOFs();
}

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

void MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::mixAll	(	BaseSpecies *const	S,
		BaseSpecies *const	T
	)

sets the MixedSpecies properties by mixing the properties of two particle species

Uses the harmonic mean for most properties. Calls the mix function for each of the force species from which MixedSpecies is derived.

Parameters

[in]	S	the first of two species whose properties are mixed to create the new species
[in]	T	the second of two species whose properties are mixed to create the new species

Definition at line 228 of file MixedSpecies.h.

{
    NormalForceSpecies::mix(dynamic_cast<NormalForceSpecies*> (S), dynamic_cast<NormalForceSpecies*> (T));
    FrictionForceSpecies::mix(dynamic_cast<FrictionForceSpecies*> (S), dynamic_cast<FrictionForceSpecies*> (T));
    AdhesiveForceSpecies::mix(dynamic_cast<AdhesiveForceSpecies*> (S), dynamic_cast<AdhesiveForceSpecies*> (T));
}

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

void MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::read

(

std::istream &

is

)

Reads the species properties from an input stream.

Called by SpeciesHandler::readObject

Parameters

[in]

is

input stream (typically the restart file)

Definition at line 159 of file MixedSpecies.h.

References BaseObject::setId(), and BaseObject::setIndex().

{
    //note: name is already read by SpeciesHandler::readObject
    std::string dummy;
    unsigned int id, index;
    is >> dummy >> id;
    is >> dummy >> index;
    BaseObject::setId(id);
    BaseObject::setIndex(index);
    NormalForceSpecies::read(is);
    FrictionForceSpecies::read(is);
    AdhesiveForceSpecies::read(is);
}

template<class NormalForceSpecies , class FrictionForceSpecies , class AdhesiveForceSpecies >

void MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::write

(

std::ostream &

os

)

const

Writes the MixedSpecies properties to an output stream.

It prints human readable MixedSpecies information to the output stream, typically to Files::restartFile::fstream_. The basic species information is written in ParticleSpecies::write; then the three force types write additional information to the stream.

Parameters

[out]

os

output stream (typically the restart file)

Definition at line 143 of file MixedSpecies.h.

References BaseObject::getId(), and BaseObject::getIndex().

{
    os << getName();
    os << " idA " << BaseObject::getId();
    os << " idB " << BaseObject::getIndex();
    NormalForceSpecies::write(os);
    FrictionForceSpecies::write(os);
    AdhesiveForceSpecies::write(os);
}

---

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

• Species/MixedSpecies.h