Kratos::FrictionLawsFactory Class Reference

The base class for the bottom and surface friction laws. More...

#include <friction_laws_factory.h>

Collaboration diagram for Kratos::FrictionLawsFactory:

Public Types
Type Definitions
typedef Node	NodeType
typedef Geometry< NodeType >	GeometryType

Public Member Functions
Pointer Definition
	KRATOS_CLASS_POINTER_DEFINITION (FrictionLawsFactory)
Life Cycle
	FrictionLawsFactory ()
	Default constructor. More...
	~FrictionLawsFactory ()
	Destructor. More...
Operations
FrictionLaw::Pointer	CreateBottomFrictionLaw (const GeometryType &rGeometry, const Properties &rProperty, const ProcessInfo &rProcessInfo)
	Create a bottom friction law. More...
FrictionLaw::Pointer	CreateSurfaceFrictionLaw (const GeometryType &rGeometry, const Properties &rProperty, const ProcessInfo &rProcessInfo)
	Create a surface friction law. More...
Input and output
std::string	Info () const
	Turn back information as a string. More...
void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...
void	PrintData (std::ostream &rOStream) const
	Print object's data. More...

Detailed Description

The base class for the bottom and surface friction laws.

This class does nothing, define derived friction laws in order to make use of it

Author

Miguel Maso Sotomayor

Member Typedef Documentation

GeometryType

typedef Geometry<NodeType> Kratos::FrictionLawsFactory::GeometryType

NodeType

typedef Node Kratos::FrictionLawsFactory::NodeType

Constructor & Destructor Documentation

FrictionLawsFactory()

Kratos::FrictionLawsFactory::FrictionLawsFactory ( )

inline

Default constructor.

~FrictionLawsFactory()

Kratos::FrictionLawsFactory::~FrictionLawsFactory ( )

inline

Destructor.

Member Function Documentation

CreateBottomFrictionLaw()

FrictionLaw::Pointer Kratos::FrictionLawsFactory::CreateBottomFrictionLaw	(	const GeometryType &	rGeometry,
		const Properties &	rProperty,
		const ProcessInfo &	rProcessInfo
	)

Create a bottom friction law.

CreateSurfaceFrictionLaw()

FrictionLaw::Pointer Kratos::FrictionLawsFactory::CreateSurfaceFrictionLaw	(	const GeometryType &	rGeometry,
		const Properties &	rProperty,
		const ProcessInfo &	rProcessInfo
	)

Create a surface friction law.

Info()

std::string Kratos::FrictionLawsFactory::Info ( ) const

inline

Turn back information as a string.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::FrictionLawsFactory::KRATOS_CLASS_POINTER_DEFINITION

(

FrictionLawsFactory

)

PrintData()

void Kratos::FrictionLawsFactory::PrintData ( std::ostream &  rOStream ) const

inline

Print object's data.

PrintInfo()

void Kratos::FrictionLawsFactory::PrintInfo ( std::ostream &  rOStream ) const

inline

Print information about this object.

---

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

• /home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/custom_friction_laws/friction_laws_factory.h
• /home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/custom_friction_laws/friction_laws_factory.cpp