MOMENTUM_NAMESPACE::MaterialPair Class Reference

#include <MaterialPair.h>

Public Member Functions
double	getAdhesion () const
double	getAdhesiveOverlap () const
double	getDamping () const
double	getFriction () const
std::shared_ptr< Material >	getMaterial (int position) const
std::shared_ptr< Material >	getMaterial1 () const
std::shared_ptr< Material >	getMaterial2 () const
double	getRestitution () const
double	getRollingResistance () const
double	getTwistingResistance () const
double	getYoungsModulus () const
bool	operator== (const MaterialPair &other) const
void	setAdhesion (double adhesion)
void	setAdhesiveOverlap (double adhesiveOverlap)
void	setDamping (double damping)
void	setFriction (double friction)
void	setRestitution (double restitution)
void	setRollingResistance (double rollingResistance)
void	setTwistingResistance (double twistingResistance)
void	setYoungsModulus (double youngsModulus)

Detailed Description

A MaterialPair defines the contact behavior between two geometries with specified materials.

Member Function Documentation

getAdhesion()

double MOMENTUM_NAMESPACE::MaterialPair::getAdhesion

(

)

const

Get the adhesion force of the material, in Newton.

Returns

the adhesion force of the material.

Available in Momentum Granular

getAdhesiveOverlap()

double MOMENTUM_NAMESPACE::MaterialPair::getAdhesiveOverlap

(

)

const

Get the adhesive overlap of the material, in meters.

Returns

the adhesion overlap of the material.

Available in Momentum Granular

getDamping()

double MOMENTUM_NAMESPACE::MaterialPair::getDamping

(

)

const

Get the damping factor of the material, in seconds.

The value is the time the contact constraint has to fulfill its violation.

Returns

the damping factor of the material.

Available in Momentum Granular

getFriction()

double MOMENTUM_NAMESPACE::MaterialPair::getFriction

(

)

const

Get the coefficient of friction of the material.

Returns

the friction of the material.

getMaterial()

std::shared_ptr< Material > MOMENTUM_NAMESPACE::MaterialPair::getMaterial

(

int

position

)

const

Get one of the materials which the contact material describes contacts between.

Parameters

position

- 0 for first material, 1 for second

Returns

the material at the position, null if position is out of range

getMaterial1()

std::shared_ptr< Material > MOMENTUM_NAMESPACE::MaterialPair::getMaterial1

(

)

const

Get the first material which defines this contact material.

Returns

first material of this ContactMaterial

getMaterial2()

std::shared_ptr< Material > MOMENTUM_NAMESPACE::MaterialPair::getMaterial2

(

)

const

Get the second material which defines this contact material.

Returns

second material of this ContactMaterial

getRestitution()

double MOMENTUM_NAMESPACE::MaterialPair::getRestitution

(

)

const

Get the coefficient of restitution of the material.

Returns

the restitution of the material

getRollingResistance()

double MOMENTUM_NAMESPACE::MaterialPair::getRollingResistance

(

)

const

Get the rolling resistance coefficient of the material.

Returns

the rolling resistance coefficient of the material.

Available in Momentum Granular

getTwistingResistance()

double MOMENTUM_NAMESPACE::MaterialPair::getTwistingResistance

(

)

const

Get the twisting resistance coefficient of the material.

Returns

the twisting resistance coefficient of the material.

Available in Momentum Granular

getYoungsModulus()

double MOMENTUM_NAMESPACE::MaterialPair::getYoungsModulus

(

)

const

Get the Young's modulus, a measure of the stiffness, of the material, in Pascal.

Returns

the Young's modulus of the material

operator==()

bool MOMENTUM_NAMESPACE::MaterialPair::operator==

(

const MaterialPair &

other

)

const

setAdhesion()

void MOMENTUM_NAMESPACE::MaterialPair::setAdhesion

(

double

adhesion

)

Set the adhesion force of the material, in Newton.

Parameters

adhesion

- the adhesion force of the material.

Only available in simulation mode Available in Momentum Granular

setAdhesiveOverlap()

void MOMENTUM_NAMESPACE::MaterialPair::setAdhesiveOverlap

(

double

adhesiveOverlap

)

Set the adhesive overlap of the material, in meters.

Parameters

adhesionOverlap

- the adhesion overlap of the material.

Only available in simulation mode Available in Momentum Granular

setDamping()

void MOMENTUM_NAMESPACE::MaterialPair::setDamping

(

double

damping

)

Set the damping factor of the material, in seconds.

The value is the time the contact constraint has to fulfill its violation.

Parameters

damping

- the damping factor of the material.

Only available in simulation mode Available in Momentum Granular

setFriction()

void MOMENTUM_NAMESPACE::MaterialPair::setFriction

(

double

friction

)

Set the coefficient of friction of the material.

Parameters

friction

- the friction of the material.

Only available in simulation mode

setRestitution()

void MOMENTUM_NAMESPACE::MaterialPair::setRestitution

(

double

restitution

)

Set the coefficient of restitution of the material.

Parameters

restitution

- the restitution of the material.

Only available in simulation mode

setRollingResistance()

void MOMENTUM_NAMESPACE::MaterialPair::setRollingResistance

(

double

rollingResistance

)

Set the rolling resistance coefficient of the material.

Parameters

rollingResistance

- the rolling resistance coefficient of the material.

Only available in simulation mode Available in Momentum Granular

setTwistingResistance()

void MOMENTUM_NAMESPACE::MaterialPair::setTwistingResistance

(

double

twistingResistance

)

Set the twisting resistance coefficient of the material.

Parameters

twistingResistance

- the twisting resistance coefficient of the material.

Only available in simulation mode Available in Momentum Granular

setYoungsModulus()

void MOMENTUM_NAMESPACE::MaterialPair::setYoungsModulus

(

double

youngsModulus

)

Set the Young's modulus, a measure of the stiffness, of the material, in Pascal.

Parameters

youngsModulus

the Young's modulus of the material

Only available in simulation mode