micromechanical::contacts::ContactLawRegistry< T > Struct Template Reference

Contact law registry. More...

#include <contacts.hpp>

Public Types
typedef ContactLawBase< T > *	ContactLawFunction(const std::map< std::string, T > &)
	Contact law function type.

Static Public Member Functions
static ContactLawBase< T > *	create (ContactLawBase< T > *contact, const std::map< std::string, T > &props={})
	Create contact law.
static ContactLawBase< T > *	create (const ContactLawType type, const std::map< std::string, T > &props={})
	Create contact law.
static ContactLawBase< T > *	create (const std::string &path, const std::map< std::string, T > &props={})
	Create contact law from plugin.
static std::string	contact_law_name (const ContactLawType type)
	Get the name of a contact law enum value.
static ContactLawType	contact_law_type (const std::string &name)
	Get the contact law type from a string.

Detailed Description

template<typename T>
struct micromechanical::contacts::ContactLawRegistry< T >

Contact law registry.

Member Typedef Documentation

ContactLawFunction

template<typename T>

typedef ContactLawBase< T > * micromechanical::contacts::ContactLawRegistry< T >::ContactLawFunction(const std::map< std::string, T > &)

Contact law function type.

Member Function Documentation

contact_law_name()

template<typename T>

static std::string micromechanical::contacts::ContactLawRegistry< T >::contact_law_name ( const ContactLawType type )

inlinestatic

Get the name of a contact law enum value.

Parameters

type	contact law type

References micromechanical::contacts::Coulomb, micromechanical::contacts::Elastic, micromechanical::contacts::Exponential, micromechanical::contacts::Hyperbolic, micromechanical::contacts::Hypoplastic, micromechanical::contacts::MCC, micromechanical::contacts::OSIMSAND, micromechanical::contacts::SANISAND, and micromechanical::contacts::SIMSAND.

contact_law_type()

template<typename T>

static ContactLawType micromechanical::contacts::ContactLawRegistry< T >::contact_law_type ( const std::string & name )

inlinestatic

Get the contact law type from a string.

Parameters

name	contact law name

References micromechanical::contacts::Coulomb, micromechanical::contacts::Elastic, micromechanical::contacts::Exponential, micromechanical::contacts::Hyperbolic, micromechanical::contacts::Hypoplastic, micromechanical::contacts::MCC, micromechanical::contacts::OSIMSAND, micromechanical::contacts::SANISAND, and micromechanical::contacts::SIMSAND.

create() [1/3]

template<typename T>

static ContactLawBase< T > * micromechanical::contacts::ContactLawRegistry< T >::create ( const ContactLawType type, const std::map< std::string, T > & props = {} )

inlinestatic

Create contact law.

Parameters

type	contact law type
props	material properties

Returns

contact law

create() [2/3]

template<typename T>

static ContactLawBase< T > * micromechanical::contacts::ContactLawRegistry< T >::create ( const std::string & path, const std::map< std::string, T > & props = {} )

inlinestatic

Create contact law from plugin.

Parameters

path	path to the contact law plugin
props	material properties

Returns

contact law

create() [3/3]

template<typename T>

static ContactLawBase< T > * micromechanical::contacts::ContactLawRegistry< T >::create ( ContactLawBase< T > * contact, const std::map< std::string, T > & props = {} )

inlinestatic

Create contact law.

Parameters

contact	contact law
props	material properties

Returns

contact law

---

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

• include/micromechanical/contacts/contacts.hpp