a spring force between a node and a certain point More...

Inheritance diagram for LbmLib::solver::ForceStructs::ForceType1:

Public Member Functions
	ForceType1 (unsigned int id1, double x, double y, double k, double l0)
	the constructor of this force More...

void	calculateForce (const std::map< unsigned int, std::shared_ptr< nodes::GeometryNode > > &nodes)
	calculates the force on the geometry nodes More...

void	writeForceStruct (std::ofstream *const stream) const
	writes the force struct to the ostream More...

unsigned int	getType () const
	Returns the force type. More...

unsigned int	getPartnerGeometryNode (void) const
	getPartnerGeometryNode More...

Public Member Functions inherited from LbmLib::solver::AbstractForceStruct
virtual	~AbstractForceStruct ()
	Destructor.

Detailed Description

a spring force between a node and a certain point

Definition at line 121 of file ForceStructs.hpp.

Constructor & Destructor Documentation

LbmLib::solver::ForceStructs::ForceType1::ForceType1	(	unsigned int	id1,
		double	x,
		double	y,
		double	k,
		double	l0
	)

inline

the constructor of this force

Parameters

id1	the id of the node where the force is applied
x	the x position of the anchor
y	the y position of the anchor
k	the spring constant
l0	the default distance

Definition at line 130 of file ForceStructs.hpp.

void LbmLib::solver::ForceStructs::ForceType1::calculateForce ( const std::map< unsigned int, std::shared_ptr< nodes::GeometryNode > > & nodes )

inlinevirtual

calculates the force on the geometry nodes

Parameters

nodes the nodes where the force is applied

Definition at line 142 of file ForceStructs.hpp.

unsigned int LbmLib::solver::ForceStructs::ForceType1::getPartnerGeometryNode ( void ) const

inlinevirtual

getPartnerGeometryNode

Returns: Shall return 0 if there is no partner node, or its nodeID otherwise.

Definition at line 162 of file ForceStructs.hpp.

unsigned int LbmLib::solver::ForceStructs::ForceType1::getType ( ) const

inlinevirtual

Returns the force type.

Definition at line 158 of file ForceStructs.hpp.

void LbmLib::solver::ForceStructs::ForceType1::writeForceStruct ( std::ofstream *const stream ) const

inlinevirtual

writes the force struct to the ostream

Parameters

stream the output stream

Definition at line 153 of file ForceStructs.hpp.

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

/home/tanakas/Documents/13_LBMCELL/lbmsolver/libs/LbmLib/include/solver/ForceStructs.hpp